diff --git a/generated/google/apis/accesscontextmanager_v1.rb b/generated/google/apis/accesscontextmanager_v1.rb index acba8e267..d83f52d56 100644 --- a/generated/google/apis/accesscontextmanager_v1.rb +++ b/generated/google/apis/accesscontextmanager_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/access-context-manager/docs/reference/rest/ module AccesscontextmanagerV1 VERSION = 'V1' - REVISION = '20200229' + REVISION = '20200405' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/accesscontextmanager_v1/classes.rb b/generated/google/apis/accesscontextmanager_v1/classes.rb index 822da5a8b..984a11ee9 100644 --- a/generated/google/apis/accesscontextmanager_v1/classes.rb +++ b/generated/google/apis/accesscontextmanager_v1/classes.rb @@ -33,11 +33,6 @@ module Google # @return [Google::Apis::AccesscontextmanagerV1::BasicLevel] attr_accessor :basic - # Output only. Time the `AccessLevel` was created in UTC. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language # to represent the necessary conditions for the level to apply to a request. # See CEL spec at: https://github.com/google/cel-spec @@ -63,11 +58,6 @@ module Google # @return [String] attr_accessor :title - # Output only. Time the `AccessLevel` was updated in UTC. - # Corresponds to the JSON property `updateTime` - # @return [String] - attr_accessor :update_time - def initialize(**args) update!(**args) end @@ -75,12 +65,10 @@ module Google # Update properties of this object def update!(**args) @basic = args[:basic] if args.key?(:basic) - @create_time = args[:create_time] if args.key?(:create_time) @custom = args[:custom] if args.key?(:custom) @description = args[:description] if args.key?(:description) @name = args[:name] if args.key?(:name) @title = args[:title] if args.key?(:title) - @update_time = args[:update_time] if args.key?(:update_time) end end @@ -92,11 +80,6 @@ module Google class AccessPolicy include Google::Apis::Core::Hashable - # Output only. Time the `AccessPolicy` was created in UTC. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - # Output only. An opaque identifier for the current version of the # `AccessPolicy`. This will always be a strongly validated etag, meaning that # two Access Polices will be identical if and only if their etags are @@ -123,23 +106,16 @@ module Google # @return [String] attr_accessor :title - # Output only. Time the `AccessPolicy` was updated in UTC. - # 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) @etag = args[:etag] if args.key?(:etag) @name = args[:name] if args.key?(:name) @parent = args[:parent] if args.key?(:parent) @title = args[:title] if args.key?(:title) - @update_time = args[:update_time] if args.key?(:update_time) end end @@ -821,11 +797,6 @@ module Google class ServicePerimeter include Google::Apis::Core::Hashable - # Output only. Time the `ServicePerimeter` was created in UTC. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - # Description of the `ServicePerimeter` and its use. Does not affect # behavior. # Corresponds to the JSON property `description` @@ -866,11 +837,6 @@ module Google # @return [String] attr_accessor :title - # Output only. Time the `ServicePerimeter` was updated in UTC. - # Corresponds to the JSON property `updateTime` - # @return [String] - attr_accessor :update_time - # Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly # exists for all Service Perimeters, and that spec is identical to the # status for those Service Perimeters. When this flag is set, it inhibits the @@ -892,14 +858,12 @@ module Google # Update properties of this object def update!(**args) - @create_time = args[:create_time] if args.key?(:create_time) @description = args[:description] if args.key?(:description) @name = args[:name] if args.key?(:name) @perimeter_type = args[:perimeter_type] if args.key?(:perimeter_type) @spec = args[:spec] if args.key?(:spec) @status = args[:status] if args.key?(:status) @title = args[:title] if args.key?(:title) - @update_time = args[:update_time] if args.key?(:update_time) @use_explicit_dry_run_spec = args[:use_explicit_dry_run_spec] if args.key?(:use_explicit_dry_run_spec) end end diff --git a/generated/google/apis/accesscontextmanager_v1/representations.rb b/generated/google/apis/accesscontextmanager_v1/representations.rb index 64a42bb63..b42ac38c8 100644 --- a/generated/google/apis/accesscontextmanager_v1/representations.rb +++ b/generated/google/apis/accesscontextmanager_v1/representations.rb @@ -177,25 +177,21 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :basic, as: 'basic', class: Google::Apis::AccesscontextmanagerV1::BasicLevel, decorator: Google::Apis::AccesscontextmanagerV1::BasicLevel::Representation - property :create_time, as: 'createTime' property :custom, as: 'custom', class: Google::Apis::AccesscontextmanagerV1::CustomLevel, decorator: Google::Apis::AccesscontextmanagerV1::CustomLevel::Representation property :description, as: 'description' property :name, as: 'name' property :title, as: 'title' - property :update_time, as: 'updateTime' end end class AccessPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation - property :create_time, as: 'createTime' property :etag, as: 'etag' property :name, as: 'name' property :parent, as: 'parent' property :title, as: 'title' - property :update_time, as: 'updateTime' end end @@ -373,7 +369,6 @@ module Google class ServicePerimeter # @private class Representation < Google::Apis::Core::JsonRepresentation - property :create_time, as: 'createTime' property :description, as: 'description' property :name, as: 'name' property :perimeter_type, as: 'perimeterType' @@ -382,7 +377,6 @@ module Google property :status, as: 'status', class: Google::Apis::AccesscontextmanagerV1::ServicePerimeterConfig, decorator: Google::Apis::AccesscontextmanagerV1::ServicePerimeterConfig::Representation property :title, as: 'title' - property :update_time, as: 'updateTime' property :use_explicit_dry_run_spec, as: 'useExplicitDryRunSpec' end end diff --git a/generated/google/apis/accesscontextmanager_v1beta.rb b/generated/google/apis/accesscontextmanager_v1beta.rb index d030dc76e..21b9d6b23 100644 --- a/generated/google/apis/accesscontextmanager_v1beta.rb +++ b/generated/google/apis/accesscontextmanager_v1beta.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/access-context-manager/docs/reference/rest/ module AccesscontextmanagerV1beta VERSION = 'V1beta' - REVISION = '20200229' + REVISION = '20200405' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/accesscontextmanager_v1beta/classes.rb b/generated/google/apis/accesscontextmanager_v1beta/classes.rb index 9e96ac294..30cc67195 100644 --- a/generated/google/apis/accesscontextmanager_v1beta/classes.rb +++ b/generated/google/apis/accesscontextmanager_v1beta/classes.rb @@ -33,11 +33,6 @@ module Google # @return [Google::Apis::AccesscontextmanagerV1beta::BasicLevel] attr_accessor :basic - # Output only. Time the `AccessLevel` was created in UTC. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language # to represent the necessary conditions for the level to apply to a request. # See CEL spec at: https://github.com/google/cel-spec @@ -63,11 +58,6 @@ module Google # @return [String] attr_accessor :title - # Output only. Time the `AccessLevel` was updated in UTC. - # Corresponds to the JSON property `updateTime` - # @return [String] - attr_accessor :update_time - def initialize(**args) update!(**args) end @@ -75,12 +65,10 @@ module Google # Update properties of this object def update!(**args) @basic = args[:basic] if args.key?(:basic) - @create_time = args[:create_time] if args.key?(:create_time) @custom = args[:custom] if args.key?(:custom) @description = args[:description] if args.key?(:description) @name = args[:name] if args.key?(:name) @title = args[:title] if args.key?(:title) - @update_time = args[:update_time] if args.key?(:update_time) end end @@ -92,11 +80,6 @@ module Google class AccessPolicy include Google::Apis::Core::Hashable - # Output only. Time the `AccessPolicy` was created in UTC. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - # Output only. Resource name of the `AccessPolicy`. Format: # `accessPolicies/`policy_id`` # Corresponds to the JSON property `name` @@ -115,22 +98,15 @@ module Google # @return [String] attr_accessor :title - # Output only. Time the `AccessPolicy` was updated in UTC. - # 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) @name = args[:name] if args.key?(:name) @parent = args[:parent] if args.key?(:parent) @title = args[:title] if args.key?(:title) - @update_time = args[:update_time] if args.key?(:update_time) end end @@ -603,11 +579,6 @@ module Google class ServicePerimeter include Google::Apis::Core::Hashable - # Output only. Time the `ServicePerimeter` was created in UTC. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - # Description of the `ServicePerimeter` and its use. Does not affect # behavior. # Corresponds to the JSON property `description` @@ -642,24 +613,17 @@ module Google # @return [String] attr_accessor :title - # Output only. Time the `ServicePerimeter` was updated in UTC. - # 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) @description = args[:description] if args.key?(:description) @name = args[:name] if args.key?(:name) @perimeter_type = args[:perimeter_type] if args.key?(:perimeter_type) @status = args[:status] if args.key?(:status) @title = args[:title] if args.key?(:title) - @update_time = args[:update_time] if args.key?(:update_time) end end diff --git a/generated/google/apis/accesscontextmanager_v1beta/representations.rb b/generated/google/apis/accesscontextmanager_v1beta/representations.rb index 983acf814..0d34aff33 100644 --- a/generated/google/apis/accesscontextmanager_v1beta/representations.rb +++ b/generated/google/apis/accesscontextmanager_v1beta/representations.rb @@ -123,24 +123,20 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :basic, as: 'basic', class: Google::Apis::AccesscontextmanagerV1beta::BasicLevel, decorator: Google::Apis::AccesscontextmanagerV1beta::BasicLevel::Representation - property :create_time, as: 'createTime' property :custom, as: 'custom', class: Google::Apis::AccesscontextmanagerV1beta::CustomLevel, decorator: Google::Apis::AccesscontextmanagerV1beta::CustomLevel::Representation property :description, as: 'description' property :name, as: 'name' property :title, as: 'title' - property :update_time, as: 'updateTime' end end class AccessPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation - property :create_time, as: 'createTime' property :name, as: 'name' property :parent, as: 'parent' property :title, as: 'title' - property :update_time, as: 'updateTime' end end @@ -248,14 +244,12 @@ module Google class ServicePerimeter # @private class Representation < Google::Apis::Core::JsonRepresentation - property :create_time, as: 'createTime' property :description, as: 'description' property :name, as: 'name' property :perimeter_type, as: 'perimeterType' property :status, as: 'status', class: Google::Apis::AccesscontextmanagerV1beta::ServicePerimeterConfig, decorator: Google::Apis::AccesscontextmanagerV1beta::ServicePerimeterConfig::Representation property :title, as: 'title' - property :update_time, as: 'updateTime' end end diff --git a/generated/google/apis/adexchangebuyer2_v2beta1.rb b/generated/google/apis/adexchangebuyer2_v2beta1.rb index 5f3403a90..ee532e8fa 100644 --- a/generated/google/apis/adexchangebuyer2_v2beta1.rb +++ b/generated/google/apis/adexchangebuyer2_v2beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://developers.google.com/authorized-buyers/apis/reference/rest/ module Adexchangebuyer2V2beta1 VERSION = 'V2beta1' - REVISION = '20200215' + REVISION = '20200402' # Manage your Ad Exchange buyer account configuration AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer' diff --git a/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb b/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb index 014d2533f..d8a1eef18 100644 --- a/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +++ b/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb @@ -1634,9 +1634,15 @@ module Google # @return [String] attr_accessor :environment - # The list of formats on which to filter; may be empty. The filters - # represented by multiple formats are ORed together (i.e., if non-empty, - # results must match any one of the formats). + # Creative format bidded on or allowed to bid on, can be empty. + # Corresponds to the JSON property `format` + # @return [String] + attr_accessor :format + + # Creative formats bidded on or allowed to bid on, can be empty. Although + # this field is a list, it can only be populated with a single item. A + # HTTP 400 bad request error will be returned in the response if you specify + # multiple items. # Corresponds to the JSON property `formats` # @return [Array] attr_accessor :formats @@ -1713,6 +1719,7 @@ module Google @creative_id = args[:creative_id] if args.key?(:creative_id) @deal_id = args[:deal_id] if args.key?(:deal_id) @environment = args[:environment] if args.key?(:environment) + @format = args[:format] if args.key?(:format) @formats = args[:formats] if args.key?(:formats) @name = args[:name] if args.key?(:name) @platforms = args[:platforms] if args.key?(:platforms) diff --git a/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb b/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb index 532748fd5..14678206d 100644 --- a/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb +++ b/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb @@ -1067,6 +1067,7 @@ module Google property :creative_id, as: 'creativeId' property :deal_id, :numeric_string => true, as: 'dealId' property :environment, as: 'environment' + property :format, as: 'format' collection :formats, as: 'formats' property :name, as: 'name' collection :platforms, as: 'platforms' diff --git a/generated/google/apis/admin_directory_v1.rb b/generated/google/apis/admin_directory_v1.rb index e6c79cf0f..5fe3ae4b6 100644 --- a/generated/google/apis/admin_directory_v1.rb +++ b/generated/google/apis/admin_directory_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/admin-sdk/directory/ module AdminDirectoryV1 VERSION = 'DirectoryV1' - REVISION = '20191003' + REVISION = '20200204' # View and manage customer related information AUTH_ADMIN_DIRECTORY_CUSTOMER = 'https://www.googleapis.com/auth/admin.directory.customer' diff --git a/generated/google/apis/admin_directory_v1/classes.rb b/generated/google/apis/admin_directory_v1/classes.rb index 2dde80257..8ce20523e 100644 --- a/generated/google/apis/admin_directory_v1/classes.rb +++ b/generated/google/apis/admin_directory_v1/classes.rb @@ -96,73 +96,6 @@ module Google end end - # JSON template for App Access Collections Resource object in Directory API. - class AppAccessCollections - include Google::Apis::Core::Hashable - - # List of blocked api access buckets. - # Corresponds to the JSON property `blockedApiAccessBuckets` - # @return [Array] - attr_accessor :blocked_api_access_buckets - - # Boolean to indicate whether to enforce app access settings on Android Drive or - # not. - # Corresponds to the JSON property `enforceSettingsForAndroidDrive` - # @return [Boolean] - attr_accessor :enforce_settings_for_android_drive - alias_method :enforce_settings_for_android_drive?, :enforce_settings_for_android_drive - - # Error message provided by the Admin that will be shown to the user when an app - # is blocked. - # Corresponds to the JSON property `errorMessage` - # @return [String] - attr_accessor :error_message - - # ETag of the resource. - # Corresponds to the JSON property `etag` - # @return [String] - attr_accessor :etag - - # Identifies the resource as an app access collection. Value: admin#directory# - # appaccesscollection - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Unique ID of app access collection. (Readonly) - # Corresponds to the JSON property `resourceId` - # @return [Fixnum] - attr_accessor :resource_id - - # Resource name given by the customer while creating/updating. Should be unique - # under given customer. - # Corresponds to the JSON property `resourceName` - # @return [String] - attr_accessor :resource_name - - # Boolean that indicates whether to trust domain owned apps. - # Corresponds to the JSON property `trustDomainOwnedApps` - # @return [Boolean] - attr_accessor :trust_domain_owned_apps - alias_method :trust_domain_owned_apps?, :trust_domain_owned_apps - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @blocked_api_access_buckets = args[:blocked_api_access_buckets] if args.key?(:blocked_api_access_buckets) - @enforce_settings_for_android_drive = args[:enforce_settings_for_android_drive] if args.key?(:enforce_settings_for_android_drive) - @error_message = args[:error_message] if args.key?(:error_message) - @etag = args[:etag] if args.key?(:etag) - @kind = args[:kind] if args.key?(:kind) - @resource_id = args[:resource_id] if args.key?(:resource_id) - @resource_name = args[:resource_name] if args.key?(:resource_name) - @trust_domain_owned_apps = args[:trust_domain_owned_apps] if args.key?(:trust_domain_owned_apps) - end - end - # The template that returns individual ASP (Access Code) data. class Asp include Google::Apis::Core::Hashable @@ -3060,86 +2993,6 @@ module Google end end - # JSON template for Trusted App Ids Resource object in Directory API. - class TrustedAppId - include Google::Apis::Core::Hashable - - # Android package name. - # Corresponds to the JSON property `androidPackageName` - # @return [String] - attr_accessor :android_package_name - - # SHA1 signature of the app certificate. - # Corresponds to the JSON property `certificateHashSHA1` - # @return [String] - attr_accessor :certificate_hash_sha1 - - # SHA256 signature of the app certificate. - # Corresponds to the JSON property `certificateHashSHA256` - # @return [String] - attr_accessor :certificate_hash_sha256 - - # - # Corresponds to the JSON property `etag` - # @return [String] - attr_accessor :etag - - # Identifies the resource as a trusted AppId. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @android_package_name = args[:android_package_name] if args.key?(:android_package_name) - @certificate_hash_sha1 = args[:certificate_hash_sha1] if args.key?(:certificate_hash_sha1) - @certificate_hash_sha256 = args[:certificate_hash_sha256] if args.key?(:certificate_hash_sha256) - @etag = args[:etag] if args.key?(:etag) - @kind = args[:kind] if args.key?(:kind) - end - end - - # JSON template for Trusted Apps response object of a user in Directory API. - class TrustedApps - include Google::Apis::Core::Hashable - - # ETag of the resource. - # Corresponds to the JSON property `etag` - # @return [String] - attr_accessor :etag - - # Identifies the resource as trusted apps response. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # Trusted Apps list. - # Corresponds to the JSON property `trustedApps` - # @return [Array] - attr_accessor :trusted_apps - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @etag = args[:etag] if args.key?(:etag) - @kind = args[:kind] if args.key?(:kind) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @trusted_apps = args[:trusted_apps] if args.key?(:trusted_apps) - end - end - # JSON template for User object in Directory API. class User include Google::Apis::Core::Hashable diff --git a/generated/google/apis/admin_directory_v1/representations.rb b/generated/google/apis/admin_directory_v1/representations.rb index b53daf3ab..7493fce61 100644 --- a/generated/google/apis/admin_directory_v1/representations.rb +++ b/generated/google/apis/admin_directory_v1/representations.rb @@ -34,12 +34,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class AppAccessCollections - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class Asp class Representation < Google::Apis::Core::JsonRepresentation; end @@ -388,18 +382,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class TrustedAppId - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TrustedApps - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class User class Representation < Google::Apis::Core::JsonRepresentation; end @@ -558,20 +540,6 @@ module Google end end - class AppAccessCollections - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :blocked_api_access_buckets, as: 'blockedApiAccessBuckets' - property :enforce_settings_for_android_drive, as: 'enforceSettingsForAndroidDrive' - property :error_message, as: 'errorMessage' - property :etag, as: 'etag' - property :kind, as: 'kind' - property :resource_id, :numeric_string => true, as: 'resourceId' - property :resource_name, as: 'resourceName' - property :trust_domain_owned_apps, as: 'trustDomainOwnedApps' - end - end - class Asp # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1309,28 +1277,6 @@ module Google end end - class TrustedAppId - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :android_package_name, as: 'androidPackageName' - property :certificate_hash_sha1, as: 'certificateHashSHA1' - property :certificate_hash_sha256, as: 'certificateHashSHA256' - property :etag, as: 'etag' - property :kind, as: 'kind' - end - end - - class TrustedApps - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :etag, as: 'etag' - property :kind, as: 'kind' - property :next_page_token, as: 'nextPageToken' - collection :trusted_apps, as: 'trustedApps', class: Google::Apis::AdminDirectoryV1::TrustedAppId, decorator: Google::Apis::AdminDirectoryV1::TrustedAppId::Representation - - end - end - class User # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/admin_directory_v1/service.rb b/generated/google/apis/admin_directory_v1/service.rb index f32dcb6a7..8818fb6ed 100644 --- a/generated/google/apis/admin_directory_v1/service.rb +++ b/generated/google/apis/admin_directory_v1/service.rb @@ -2047,66 +2047,6 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves resolved app access settings of the logged in user. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AdminDirectoryV1::AppAccessCollections] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AdminDirectoryV1::AppAccessCollections] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_resolved_app_access_setting_settings(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'resolvedappaccesssettings', options) - command.response_representation = Google::Apis::AdminDirectoryV1::AppAccessCollections::Representation - command.response_class = Google::Apis::AdminDirectoryV1::AppAccessCollections - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves the list of apps trusted by the admin of the logged in user. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AdminDirectoryV1::TrustedApps] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AdminDirectoryV1::TrustedApps] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_resolved_app_access_setting_trusted_apps(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'trustedapps', options) - command.response_representation = Google::Apis::AdminDirectoryV1::TrustedApps::Representation - command.response_class = Google::Apis::AdminDirectoryV1::TrustedApps - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - # Deletes a building. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, diff --git a/generated/google/apis/adsense_v1_4.rb b/generated/google/apis/adsense_v1_4.rb index 33d82150f..0aa906d51 100644 --- a/generated/google/apis/adsense_v1_4.rb +++ b/generated/google/apis/adsense_v1_4.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/adsense/management/ module AdsenseV1_4 VERSION = 'V1_4' - REVISION = '20180807' + REVISION = '20200311' # View and manage your AdSense data AUTH_ADSENSE = 'https://www.googleapis.com/auth/adsense' diff --git a/generated/google/apis/adsensehost_v4_1.rb b/generated/google/apis/adsensehost_v4_1.rb index 0b9e00a24..ae5aa9cab 100644 --- a/generated/google/apis/adsensehost_v4_1.rb +++ b/generated/google/apis/adsensehost_v4_1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/adsense/host/ module AdsensehostV4_1 VERSION = 'V4_1' - REVISION = '20180807' + REVISION = '20200311' # View and manage your AdSense host data and associated accounts AUTH_ADSENSEHOST = 'https://www.googleapis.com/auth/adsensehost' diff --git a/generated/google/apis/adsensehost_v4_1/service.rb b/generated/google/apis/adsensehost_v4_1/service.rb index d9959054b..65cace997 100644 --- a/generated/google/apis/adsensehost_v4_1/service.rb +++ b/generated/google/apis/adsensehost_v4_1/service.rb @@ -626,6 +626,9 @@ module Google # Products to associate with the user. # @param [String] website_url # The URL of the user's hosted website. + # @param [String] callback_url + # The URL to redirect the user to once association is completed. It receives a + # token parameter that can then be used to retrieve the associated account. # @param [String] user_locale # The preferred locale of the user. # @param [String] website_locale @@ -649,10 +652,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def start_association_session(product_code, website_url, user_locale: nil, website_locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def start_association_session(product_code, website_url, callback_url: nil, user_locale: nil, website_locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'associationsessions/start', options) command.response_representation = Google::Apis::AdsensehostV4_1::AssociationSession::Representation command.response_class = Google::Apis::AdsensehostV4_1::AssociationSession + command.query['callbackUrl'] = callback_url unless callback_url.nil? command.query['productCode'] = product_code unless product_code.nil? command.query['userLocale'] = user_locale unless user_locale.nil? command.query['websiteLocale'] = website_locale unless website_locale.nil? diff --git a/generated/google/apis/alertcenter_v1beta1.rb b/generated/google/apis/alertcenter_v1beta1.rb index f7382b0a5..ea6e12118 100644 --- a/generated/google/apis/alertcenter_v1beta1.rb +++ b/generated/google/apis/alertcenter_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/admin-sdk/alertcenter/ module AlertcenterV1beta1 VERSION = 'V1beta1' - REVISION = '20200307' + REVISION = '20200404' # See and delete your domain's G Suite alerts, and send alert feedback AUTH_APPS_ALERTS = 'https://www.googleapis.com/auth/apps.alerts' diff --git a/generated/google/apis/alertcenter_v1beta1/classes.rb b/generated/google/apis/alertcenter_v1beta1/classes.rb index 4f56f2699..b3de02ba8 100644 --- a/generated/google/apis/alertcenter_v1beta1/classes.rb +++ b/generated/google/apis/alertcenter_v1beta1/classes.rb @@ -81,7 +81,7 @@ module Google # @return [String] attr_accessor :query - # List of alert ids superseded by this alert. It is used to indicate that + # List of alert IDs superseded by this alert. It is used to indicate that # this alert is essentially extension of superseded alerts and we found the # relationship after creating these alerts. # Corresponds to the JSON property `supersededAlerts` diff --git a/generated/google/apis/androiddeviceprovisioning_v1.rb b/generated/google/apis/androiddeviceprovisioning_v1.rb index 0e8ffaea1..6367110c9 100644 --- a/generated/google/apis/androiddeviceprovisioning_v1.rb +++ b/generated/google/apis/androiddeviceprovisioning_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/zero-touch/ module AndroiddeviceprovisioningV1 VERSION = 'V1' - REVISION = '20200215' + REVISION = '20200311' end end end diff --git a/generated/google/apis/androiddeviceprovisioning_v1/classes.rb b/generated/google/apis/androiddeviceprovisioning_v1/classes.rb index 79dd1031e..f0224e17a 100644 --- a/generated/google/apis/androiddeviceprovisioning_v1/classes.rb +++ b/generated/google/apis/androiddeviceprovisioning_v1/classes.rb @@ -1113,7 +1113,7 @@ module Google # @return [Google::Apis::AndroiddeviceprovisioningV1::PartnerUnclaim] attr_accessor :unclaim - # Identifies metdata updates to one device. + # Identifies metadata updates to one device. # Corresponds to the JSON property `updateMetadata` # @return [Google::Apis::AndroiddeviceprovisioningV1::UpdateMetadataArguments] attr_accessor :update_metadata @@ -1397,7 +1397,7 @@ module Google end end - # Identifies metdata updates to one device. + # Identifies metadata updates to one device. class UpdateMetadataArguments include Google::Apis::Core::Hashable diff --git a/generated/google/apis/androidenterprise_v1.rb b/generated/google/apis/androidenterprise_v1.rb index 6f4926d39..d73742c4e 100644 --- a/generated/google/apis/androidenterprise_v1.rb +++ b/generated/google/apis/androidenterprise_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/android/work/play/emm-api module AndroidenterpriseV1 VERSION = 'V1' - REVISION = '20200129' + REVISION = '20200315' # Manage corporate Android devices AUTH_ANDROIDENTERPRISE = 'https://www.googleapis.com/auth/androidenterprise' diff --git a/generated/google/apis/androidenterprise_v1/classes.rb b/generated/google/apis/androidenterprise_v1/classes.rb index 46394c4b8..cc73ddc81 100644 --- a/generated/google/apis/androidenterprise_v1/classes.rb +++ b/generated/google/apis/androidenterprise_v1/classes.rb @@ -244,7 +244,7 @@ module Google class AppRestrictionsSchema include Google::Apis::Core::Hashable - # + # Deprecated. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2649,7 +2649,7 @@ module Google # @return [String] attr_accessor :completion_token - # + # Deprecated. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind diff --git a/generated/google/apis/androidmanagement_v1.rb b/generated/google/apis/androidmanagement_v1.rb index 2f3b6e1e0..afdd118d3 100644 --- a/generated/google/apis/androidmanagement_v1.rb +++ b/generated/google/apis/androidmanagement_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/android/management module AndroidmanagementV1 VERSION = 'V1' - REVISION = '20200221' + REVISION = '20200330' # Manage Android devices and apps for your customers AUTH_ANDROIDMANAGEMENT = 'https://www.googleapis.com/auth/androidmanagement' diff --git a/generated/google/apis/androidmanagement_v1/service.rb b/generated/google/apis/androidmanagement_v1/service.rb index 92e5d6bca..783c6b92d 100644 --- a/generated/google/apis/androidmanagement_v1/service.rb +++ b/generated/google/apis/androidmanagement_v1/service.rb @@ -197,8 +197,8 @@ module Google # @param [Array, String] wipe_data_flags # Optional flags that control the device wiping behavior. # @param [String] wipe_reason_message - # Optional short message displayed to the user before wiping the work profile on - # personal devices. This has no effect on company owned devices. The maximum + # Optional. A short message displayed to the user before wiping the work profile + # on personal devices. This has no effect on company owned devices. The maximum # message length is 200 characters. # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/androidpublisher_v2.rb b/generated/google/apis/androidpublisher_v2.rb index 223fb2de2..d859d44e6 100644 --- a/generated/google/apis/androidpublisher_v2.rb +++ b/generated/google/apis/androidpublisher_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/android-publisher module AndroidpublisherV2 VERSION = 'V2' - REVISION = '20200115' + REVISION = '20200331' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' diff --git a/generated/google/apis/androidpublisher_v2/classes.rb b/generated/google/apis/androidpublisher_v2/classes.rb index b6ae1e621..e2a86b46e 100644 --- a/generated/google/apis/androidpublisher_v2/classes.rb +++ b/generated/google/apis/androidpublisher_v2/classes.rb @@ -777,8 +777,8 @@ module Google # Grace period of the subscription, specified in ISO 8601 format. It will allow # developers to give their subscribers a grace period when the payment for the - # new recurrence period is declined. Acceptable values = "P3D" (three days) and " - # P7D" (seven days) + # new recurrence period is declined. Acceptable values = "P3D" (three days), " + # P7D" (seven days), "P14D" (fourteen days), and "P30D" (thirty days) # Corresponds to the JSON property `gracePeriod` # @return [String] attr_accessor :grace_period diff --git a/generated/google/apis/androidpublisher_v3.rb b/generated/google/apis/androidpublisher_v3.rb index ad1cccf14..6e9b015d1 100644 --- a/generated/google/apis/androidpublisher_v3.rb +++ b/generated/google/apis/androidpublisher_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/android-publisher module AndroidpublisherV3 VERSION = 'V3' - REVISION = '20200223' + REVISION = '20200331' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' diff --git a/generated/google/apis/androidpublisher_v3/classes.rb b/generated/google/apis/androidpublisher_v3/classes.rb index 413e8bde2..ef6587271 100644 --- a/generated/google/apis/androidpublisher_v3/classes.rb +++ b/generated/google/apis/androidpublisher_v3/classes.rb @@ -820,8 +820,8 @@ module Google # Grace period of the subscription, specified in ISO 8601 format. It will allow # developers to give their subscribers a grace period when the payment for the - # new recurrence period is declined. Acceptable values = "P3D" (three days) and " - # P7D" (seven days) + # new recurrence period is declined. Acceptable values = "P3D" (three days), " + # P7D" (seven days), "P14D" (fourteen days), and "P30D" (thirty days) # Corresponds to the JSON property `gracePeriod` # @return [String] attr_accessor :grace_period diff --git a/generated/google/apis/appengine_v1.rb b/generated/google/apis/appengine_v1.rb index 353583d25..21cd7590f 100644 --- a/generated/google/apis/appengine_v1.rb +++ b/generated/google/apis/appengine_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1 VERSION = 'V1' - REVISION = '20200215' + REVISION = '20200329' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1alpha.rb b/generated/google/apis/appengine_v1alpha.rb index 7248b26c3..ea424d588 100644 --- a/generated/google/apis/appengine_v1alpha.rb +++ b/generated/google/apis/appengine_v1alpha.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1alpha VERSION = 'V1alpha' - REVISION = '20200215' + REVISION = '20200329' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1beta.rb b/generated/google/apis/appengine_v1beta.rb index be9e65310..9b43bca51 100644 --- a/generated/google/apis/appengine_v1beta.rb +++ b/generated/google/apis/appengine_v1beta.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1beta VERSION = 'V1beta' - REVISION = '20200215' + REVISION = '20200329' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/bigquery_v2.rb b/generated/google/apis/bigquery_v2.rb index 832cf9a4f..a1d640425 100644 --- a/generated/google/apis/bigquery_v2.rb +++ b/generated/google/apis/bigquery_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryV2 VERSION = 'V2' - REVISION = '20191211' + REVISION = '20200324' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigquery_v2/classes.rb b/generated/google/apis/bigquery_v2/classes.rb index a54f39431..d1d93a145 100644 --- a/generated/google/apis/bigquery_v2/classes.rb +++ b/generated/google/apis/bigquery_v2/classes.rb @@ -1541,6 +1541,12 @@ module Google # @return [Google::Apis::BigqueryV2::MultiClassClassificationMetrics] attr_accessor :multi_class_classification_metrics + # Evaluation metrics used by weighted-ALS models specified by + # feedback_type=implicit. + # Corresponds to the JSON property `rankingMetrics` + # @return [Google::Apis::BigqueryV2::RankingMetrics] + attr_accessor :ranking_metrics + # Evaluation metrics for regression and explicit feedback type matrix # factorization models. # Corresponds to the JSON property `regressionMetrics` @@ -1556,6 +1562,7 @@ module Google @binary_classification_metrics = args[:binary_classification_metrics] if args.key?(:binary_classification_metrics) @clustering_metrics = args[:clustering_metrics] if args.key?(:clustering_metrics) @multi_class_classification_metrics = args[:multi_class_classification_metrics] if args.key?(:multi_class_classification_metrics) + @ranking_metrics = args[:ranking_metrics] if args.key?(:ranking_metrics) @regression_metrics = args[:regression_metrics] if args.key?(:regression_metrics) end end @@ -2355,14 +2362,16 @@ module Google # [Optional] The compression type to use for exported files. Possible values # include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE - # and SNAPPY are only supported for Avro. + # and SNAPPY are only supported for Avro. Not applicable when extracting models. # Corresponds to the JSON property `compression` # @return [String] attr_accessor :compression # [Optional] The exported file format. Possible values include CSV, - # NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested - # or repeated fields cannot be exported as CSV. + # NEWLINE_DELIMITED_JSON or AVRO for tables and ML_TF_SAVED_MODEL or + # ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables + # with nested or repeated fields cannot be exported as CSV. The default value + # for models is ML_TF_SAVED_MODEL. # Corresponds to the JSON property `destinationFormat` # @return [String] attr_accessor :destination_format @@ -2381,11 +2390,13 @@ module Google attr_accessor :destination_uris # [Optional] Delimiter to use between fields in the exported data. Default is ',' + # . Not applicable when extracting models. # Corresponds to the JSON property `fieldDelimiter` # @return [String] attr_accessor :field_delimiter # [Optional] Whether to print out a header row in the results. Default is true. + # Not applicable when extracting models. # Corresponds to the JSON property `printHeader` # @return [Boolean] attr_accessor :print_header @@ -2404,7 +2415,7 @@ module Google # [Optional] If destinationFormat is set to "AVRO", this flag indicates whether # to enable extracting applicable column types (such as TIMESTAMP) to their # corresponding AVRO logical types (timestamp-micros), instead of only using - # their raw types (avro-long). + # their raw types (avro-long). Not applicable when extracting models. # Corresponds to the JSON property `useAvroLogicalTypes` # @return [Boolean] attr_accessor :use_avro_logical_types @@ -2715,6 +2726,11 @@ module Google # @return [Google::Apis::BigqueryV2::Clustering] attr_accessor :clustering + # Connection properties. + # Corresponds to the JSON property `connectionProperties` + # @return [Array] + attr_accessor :connection_properties + # [Optional] Specifies whether the job is allowed to create new tables. The # following values are supported: CREATE_IF_NEEDED: If the table does not exist, # BigQuery creates the table. CREATE_NEVER: The table must already exist. If it @@ -2872,6 +2888,7 @@ module Google def update!(**args) @allow_large_results = args[:allow_large_results] if args.key?(:allow_large_results) @clustering = args[:clustering] if args.key?(:clustering) + @connection_properties = args[:connection_properties] if args.key?(:connection_properties) @create_disposition = args[:create_disposition] if args.key?(:create_disposition) @default_dataset = args[:default_dataset] if args.key?(:default_dataset) @destination_encryption_configuration = args[:destination_encryption_configuration] if args.key?(:destination_encryption_configuration) @@ -3160,6 +3177,12 @@ module Google # @return [String] attr_accessor :reservation_id + # [Output-only] [Preview] Statistics for row-level security. Present only for + # query and extract jobs. + # Corresponds to the JSON property `rowLevelSecurityStatistics` + # @return [Google::Apis::BigqueryV2::RowLevelSecurityStatistics] + attr_accessor :row_level_security_statistics + # [Output-only] Statistics for a child job of a script. # Corresponds to the JSON property `scriptStatistics` # @return [Google::Apis::BigqueryV2::ScriptStatistics] @@ -3200,6 +3223,7 @@ module Google @quota_deferments = args[:quota_deferments] if args.key?(:quota_deferments) @reservation_usage = args[:reservation_usage] if args.key?(:reservation_usage) @reservation_id = args[:reservation_id] if args.key?(:reservation_id) + @row_level_security_statistics = args[:row_level_security_statistics] if args.key?(:row_level_security_statistics) @script_statistics = args[:script_statistics] if args.key?(:script_statistics) @start_time = args[:start_time] if args.key?(:start_time) @total_bytes_processed = args[:total_bytes_processed] if args.key?(:total_bytes_processed) @@ -3247,6 +3271,12 @@ module Google attr_accessor :cache_hit alias_method :cache_hit?, :cache_hit + # [Output-only] [Preview] The number of row access policies affected by a DDL + # statement. Present only for DROP ALL ROW ACCESS POLICIES queries. + # Corresponds to the JSON property `ddlAffectedRowAccessPolicyCount` + # @return [Fixnum] + attr_accessor :ddl_affected_row_access_policy_count + # The DDL operation performed, possibly dependent on the pre-existence of the # DDL target. Possible values (new values might be added in the future): "CREATE" # : The query created the DDL target. "SKIP": No-op. Example cases: the query is @@ -3264,7 +3294,14 @@ module Google # @return [Google::Apis::BigqueryV2::RoutineReference] attr_accessor :ddl_target_routine - # The DDL target table. Present only for CREATE/DROP TABLE/VIEW queries. + # [Output-only] [Preview] The DDL target row access policy. Present only for + # CREATE/DROP ROW ACCESS POLICY queries. + # Corresponds to the JSON property `ddlTargetRowAccessPolicy` + # @return [Google::Apis::BigqueryV2::RowAccessPolicyReference] + attr_accessor :ddl_target_row_access_policy + + # [Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW + # and DROP ALL ROW ACCESS POLICIES queries. # Corresponds to the JSON property `ddlTargetTable` # @return [Google::Apis::BigqueryV2::TableReference] attr_accessor :ddl_target_table @@ -3392,8 +3429,10 @@ module Google def update!(**args) @billing_tier = args[:billing_tier] if args.key?(:billing_tier) @cache_hit = args[:cache_hit] if args.key?(:cache_hit) + @ddl_affected_row_access_policy_count = args[:ddl_affected_row_access_policy_count] if args.key?(:ddl_affected_row_access_policy_count) @ddl_operation_performed = args[:ddl_operation_performed] if args.key?(:ddl_operation_performed) @ddl_target_routine = args[:ddl_target_routine] if args.key?(:ddl_target_routine) + @ddl_target_row_access_policy = args[:ddl_target_row_access_policy] if args.key?(:ddl_target_row_access_policy) @ddl_target_table = args[:ddl_target_table] if args.key?(:ddl_target_table) @estimated_bytes_processed = args[:estimated_bytes_processed] if args.key?(:estimated_bytes_processed) @model_training = args[:model_training] if args.key?(:model_training) @@ -4145,6 +4184,11 @@ module Google class QueryRequest include Google::Apis::Core::Hashable + # Connection properties. + # Corresponds to the JSON property `connectionProperties` + # @return [Array] + attr_accessor :connection_properties + # [Optional] Specifies the default datasetId and projectId to assume for any # unqualified table names in the query. If not set, all table names in the query # string must be qualified in the format 'datasetId.tableId'. @@ -4239,6 +4283,7 @@ module Google # Update properties of this object def update!(**args) + @connection_properties = args[:connection_properties] if args.key?(:connection_properties) @default_dataset = args[:default_dataset] if args.key?(:default_dataset) @dry_run = args[:dry_run] if args.key?(:dry_run) @kind = args[:kind] if args.key?(:kind) @@ -4451,6 +4496,51 @@ module Google end end + # Evaluation metrics used by weighted-ALS models specified by + # feedback_type=implicit. + class RankingMetrics + include Google::Apis::Core::Hashable + + # Determines the goodness of a ranking by computing the percentile rank + # from the predicted confidence and dividing it by the original rank. + # Corresponds to the JSON property `averageRank` + # @return [Float] + attr_accessor :average_rank + + # Calculates a precision per user for all the items by ranking them and + # then averages all the precisions across all the users. + # Corresponds to the JSON property `meanAveragePrecision` + # @return [Float] + attr_accessor :mean_average_precision + + # Similar to the mean squared error computed in regression and explicit + # recommendation models except instead of computing the rating directly, + # the output from evaluate is computed against a preference which is 1 or 0 + # depending on if the rating exists or not. + # Corresponds to the JSON property `meanSquaredError` + # @return [Float] + attr_accessor :mean_squared_error + + # A metric to determine the goodness of a ranking calculated from the + # predicted confidence by comparing it to an ideal rank measured by the + # original ratings. + # Corresponds to the JSON property `normalizedDiscountedCumulativeGain` + # @return [Float] + attr_accessor :normalized_discounted_cumulative_gain + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @average_rank = args[:average_rank] if args.key?(:average_rank) + @mean_average_precision = args[:mean_average_precision] if args.key?(:mean_average_precision) + @mean_squared_error = args[:mean_squared_error] if args.key?(:mean_squared_error) + @normalized_discounted_cumulative_gain = args[:normalized_discounted_cumulative_gain] if args.key?(:normalized_discounted_cumulative_gain) + end + end + # Evaluation metrics for regression and explicit feedback type matrix # factorization models. class RegressionMetrics @@ -4656,6 +4746,66 @@ module Google end end + # + class RowAccessPolicyReference + include Google::Apis::Core::Hashable + + # [Required] The ID of the dataset containing this row access policy. + # Corresponds to the JSON property `datasetId` + # @return [String] + attr_accessor :dataset_id + + # [Required] The ID of the row access policy. The ID must contain only letters ( + # a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 + # characters. + # Corresponds to the JSON property `policyId` + # @return [String] + attr_accessor :policy_id + + # [Required] The ID of the project containing this row access policy. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + # [Required] The ID of the table containing this row access policy. + # Corresponds to the JSON property `tableId` + # @return [String] + attr_accessor :table_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dataset_id = args[:dataset_id] if args.key?(:dataset_id) + @policy_id = args[:policy_id] if args.key?(:policy_id) + @project_id = args[:project_id] if args.key?(:project_id) + @table_id = args[:table_id] if args.key?(:table_id) + end + end + + # + class RowLevelSecurityStatistics + include Google::Apis::Core::Hashable + + # [Output-only] [Preview] Whether any accessed data was protected by row access + # policies. + # Corresponds to the JSON property `rowLevelSecurityApplied` + # @return [Boolean] + attr_accessor :row_level_security_applied + alias_method :row_level_security_applied?, :row_level_security_applied + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @row_level_security_applied = args[:row_level_security_applied] if args.key?(:row_level_security_applied) + end + end + # class ScriptStackFrame include Google::Apis::Core::Hashable @@ -5652,6 +5802,11 @@ module Google class TrainingOptions include Google::Apis::Core::Hashable + # Batch size for dnn models. + # Corresponds to the JSON property `batchSize` + # @return [Fixnum] + attr_accessor :batch_size + # The column to split data with. This column won't be used as a # feature. # 1. When data_split_method is CUSTOM, the corresponding column should @@ -5685,6 +5840,11 @@ module Google # @return [String] attr_accessor :distance_type + # Dropout probability for dnn models. + # Corresponds to the JSON property `dropout` + # @return [Float] + attr_accessor :dropout + # Whether to stop early when the loss doesn't improve significantly # any more (compared to min_relative_progress). Used only for iterative # training algorithms. @@ -5693,6 +5853,17 @@ module Google attr_accessor :early_stop alias_method :early_stop?, :early_stop + # Feedback type that specifies which algorithm to run for matrix + # factorization. + # Corresponds to the JSON property `feedbackType` + # @return [String] + attr_accessor :feedback_type + + # Hidden units for dnn models. + # Corresponds to the JSON property `hiddenUnits` + # @return [Array] + attr_accessor :hidden_units + # Specifies the initial learning rate for the line search learn rate # strategy. # Corresponds to the JSON property `initialLearnRate` @@ -5704,6 +5875,11 @@ module Google # @return [Array] attr_accessor :input_label_columns + # Item column specified for matrix factorization models. + # Corresponds to the JSON property `itemColumn` + # @return [String] + attr_accessor :item_column + # The column used to provide the initial centroids for kmeans algorithm # when kmeans_initialization_method is CUSTOM. # Corresponds to the JSON property `kmeansInitializationColumn` @@ -5752,6 +5928,11 @@ module Google # @return [Fixnum] attr_accessor :max_iterations + # Maximum depth of a tree for boosted tree models. + # Corresponds to the JSON property `maxTreeDepth` + # @return [Fixnum] + attr_accessor :max_tree_depth + # When early_stop is true, stops training when accuracy improvement is # less than 'min_relative_progress'. Used only for iterative training # algorithms. @@ -5759,6 +5940,11 @@ module Google # @return [Float] attr_accessor :min_relative_progress + # Minimum split loss for boosted tree models. + # Corresponds to the JSON property `minSplitLoss` + # @return [Float] + attr_accessor :min_split_loss + # [Beta] Google Cloud Storage URI from which the model was imported. Only # applicable for imported models. # Corresponds to the JSON property `modelUri` @@ -5770,11 +5956,33 @@ module Google # @return [Fixnum] attr_accessor :num_clusters + # Num factors specified for matrix factorization models. + # Corresponds to the JSON property `numFactors` + # @return [Fixnum] + attr_accessor :num_factors + # Optimization strategy for training linear regression models. # Corresponds to the JSON property `optimizationStrategy` # @return [String] attr_accessor :optimization_strategy + # Subsample fraction of the training data to grow tree to prevent + # overfitting for boosted tree models. + # Corresponds to the JSON property `subsample` + # @return [Float] + attr_accessor :subsample + + # User column specified for matrix factorization models. + # Corresponds to the JSON property `userColumn` + # @return [String] + attr_accessor :user_column + + # Hyperparameter for matrix factoration when implicit feedback type is + # specified. + # Corresponds to the JSON property `walsAlpha` + # @return [Float] + attr_accessor :wals_alpha + # Whether to train a model from the last checkpoint. # Corresponds to the JSON property `warmStart` # @return [Boolean] @@ -5787,13 +5995,18 @@ module Google # Update properties of this object def update!(**args) + @batch_size = args[:batch_size] if args.key?(:batch_size) @data_split_column = args[:data_split_column] if args.key?(:data_split_column) @data_split_eval_fraction = args[:data_split_eval_fraction] if args.key?(:data_split_eval_fraction) @data_split_method = args[:data_split_method] if args.key?(:data_split_method) @distance_type = args[:distance_type] if args.key?(:distance_type) + @dropout = args[:dropout] if args.key?(:dropout) @early_stop = args[:early_stop] if args.key?(:early_stop) + @feedback_type = args[:feedback_type] if args.key?(:feedback_type) + @hidden_units = args[:hidden_units] if args.key?(:hidden_units) @initial_learn_rate = args[:initial_learn_rate] if args.key?(:initial_learn_rate) @input_label_columns = args[:input_label_columns] if args.key?(:input_label_columns) + @item_column = args[:item_column] if args.key?(:item_column) @kmeans_initialization_column = args[:kmeans_initialization_column] if args.key?(:kmeans_initialization_column) @kmeans_initialization_method = args[:kmeans_initialization_method] if args.key?(:kmeans_initialization_method) @l1_regularization = args[:l1_regularization] if args.key?(:l1_regularization) @@ -5803,10 +6016,16 @@ module Google @learn_rate_strategy = args[:learn_rate_strategy] if args.key?(:learn_rate_strategy) @loss_type = args[:loss_type] if args.key?(:loss_type) @max_iterations = args[:max_iterations] if args.key?(:max_iterations) + @max_tree_depth = args[:max_tree_depth] if args.key?(:max_tree_depth) @min_relative_progress = args[:min_relative_progress] if args.key?(:min_relative_progress) + @min_split_loss = args[:min_split_loss] if args.key?(:min_split_loss) @model_uri = args[:model_uri] if args.key?(:model_uri) @num_clusters = args[:num_clusters] if args.key?(:num_clusters) + @num_factors = args[:num_factors] if args.key?(:num_factors) @optimization_strategy = args[:optimization_strategy] if args.key?(:optimization_strategy) + @subsample = args[:subsample] if args.key?(:subsample) + @user_column = args[:user_column] if args.key?(:user_column) + @wals_alpha = args[:wals_alpha] if args.key?(:wals_alpha) @warm_start = args[:warm_start] if args.key?(:warm_start) end end diff --git a/generated/google/apis/bigquery_v2/representations.rb b/generated/google/apis/bigquery_v2/representations.rb index 7c1ad6bb0..92aa43df7 100644 --- a/generated/google/apis/bigquery_v2/representations.rb +++ b/generated/google/apis/bigquery_v2/representations.rb @@ -514,6 +514,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class RankingMetrics + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class RegressionMetrics class Representation < Google::Apis::Core::JsonRepresentation; end @@ -538,6 +544,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class RowAccessPolicyReference + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RowLevelSecurityStatistics + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ScriptStackFrame class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1076,6 +1094,8 @@ module Google property :multi_class_classification_metrics, as: 'multiClassClassificationMetrics', class: Google::Apis::BigqueryV2::MultiClassClassificationMetrics, decorator: Google::Apis::BigqueryV2::MultiClassClassificationMetrics::Representation + property :ranking_metrics, as: 'rankingMetrics', class: Google::Apis::BigqueryV2::RankingMetrics, decorator: Google::Apis::BigqueryV2::RankingMetrics::Representation + property :regression_metrics, as: 'regressionMetrics', class: Google::Apis::BigqueryV2::RegressionMetrics, decorator: Google::Apis::BigqueryV2::RegressionMetrics::Representation end @@ -1331,6 +1351,7 @@ module Google property :allow_large_results, as: 'allowLargeResults' property :clustering, as: 'clustering', class: Google::Apis::BigqueryV2::Clustering, decorator: Google::Apis::BigqueryV2::Clustering::Representation + collection :connection_properties, as: 'connectionProperties' property :create_disposition, as: 'createDisposition' property :default_dataset, as: 'defaultDataset', class: Google::Apis::BigqueryV2::DatasetReference, decorator: Google::Apis::BigqueryV2::DatasetReference::Representation @@ -1436,6 +1457,8 @@ module Google collection :reservation_usage, as: 'reservationUsage', class: Google::Apis::BigqueryV2::JobStatistics::ReservationUsage, decorator: Google::Apis::BigqueryV2::JobStatistics::ReservationUsage::Representation property :reservation_id, as: 'reservation_id' + property :row_level_security_statistics, as: 'rowLevelSecurityStatistics', class: Google::Apis::BigqueryV2::RowLevelSecurityStatistics, decorator: Google::Apis::BigqueryV2::RowLevelSecurityStatistics::Representation + property :script_statistics, as: 'scriptStatistics', class: Google::Apis::BigqueryV2::ScriptStatistics, decorator: Google::Apis::BigqueryV2::ScriptStatistics::Representation property :start_time, :numeric_string => true, as: 'startTime' @@ -1457,9 +1480,12 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :billing_tier, as: 'billingTier' property :cache_hit, as: 'cacheHit' + property :ddl_affected_row_access_policy_count, :numeric_string => true, as: 'ddlAffectedRowAccessPolicyCount' property :ddl_operation_performed, as: 'ddlOperationPerformed' property :ddl_target_routine, as: 'ddlTargetRoutine', class: Google::Apis::BigqueryV2::RoutineReference, decorator: Google::Apis::BigqueryV2::RoutineReference::Representation + property :ddl_target_row_access_policy, as: 'ddlTargetRowAccessPolicy', class: Google::Apis::BigqueryV2::RowAccessPolicyReference, decorator: Google::Apis::BigqueryV2::RowAccessPolicyReference::Representation + property :ddl_target_table, as: 'ddlTargetTable', class: Google::Apis::BigqueryV2::TableReference, decorator: Google::Apis::BigqueryV2::TableReference::Representation property :estimated_bytes_processed, :numeric_string => true, as: 'estimatedBytesProcessed' @@ -1704,6 +1730,7 @@ module Google class QueryRequest # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :connection_properties, as: 'connectionProperties' property :default_dataset, as: 'defaultDataset', class: Google::Apis::BigqueryV2::DatasetReference, decorator: Google::Apis::BigqueryV2::DatasetReference::Representation property :dry_run, as: 'dryRun' @@ -1771,6 +1798,16 @@ module Google end end + class RankingMetrics + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :average_rank, as: 'averageRank' + property :mean_average_precision, as: 'meanAveragePrecision' + property :mean_squared_error, as: 'meanSquaredError' + property :normalized_discounted_cumulative_gain, as: 'normalizedDiscountedCumulativeGain' + end + end + class RegressionMetrics # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1820,6 +1857,23 @@ module Google end end + class RowAccessPolicyReference + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dataset_id, as: 'datasetId' + property :policy_id, as: 'policyId' + property :project_id, as: 'projectId' + property :table_id, as: 'tableId' + end + end + + class RowLevelSecurityStatistics + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :row_level_security_applied, as: 'rowLevelSecurityApplied' + end + end + class ScriptStackFrame # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2090,13 +2144,18 @@ module Google class TrainingOptions # @private class Representation < Google::Apis::Core::JsonRepresentation + property :batch_size, :numeric_string => true, as: 'batchSize' property :data_split_column, as: 'dataSplitColumn' property :data_split_eval_fraction, as: 'dataSplitEvalFraction' property :data_split_method, as: 'dataSplitMethod' property :distance_type, as: 'distanceType' + property :dropout, as: 'dropout' property :early_stop, as: 'earlyStop' + property :feedback_type, as: 'feedbackType' + collection :hidden_units, as: 'hiddenUnits' property :initial_learn_rate, as: 'initialLearnRate' collection :input_label_columns, as: 'inputLabelColumns' + property :item_column, as: 'itemColumn' property :kmeans_initialization_column, as: 'kmeansInitializationColumn' property :kmeans_initialization_method, as: 'kmeansInitializationMethod' property :l1_regularization, as: 'l1Regularization' @@ -2106,10 +2165,16 @@ module Google property :learn_rate_strategy, as: 'learnRateStrategy' property :loss_type, as: 'lossType' property :max_iterations, :numeric_string => true, as: 'maxIterations' + property :max_tree_depth, :numeric_string => true, as: 'maxTreeDepth' property :min_relative_progress, as: 'minRelativeProgress' + property :min_split_loss, as: 'minSplitLoss' property :model_uri, as: 'modelUri' property :num_clusters, :numeric_string => true, as: 'numClusters' + property :num_factors, :numeric_string => true, as: 'numFactors' property :optimization_strategy, as: 'optimizationStrategy' + property :subsample, as: 'subsample' + property :user_column, as: 'userColumn' + property :wals_alpha, as: 'walsAlpha' property :warm_start, as: 'warmStart' end end diff --git a/generated/google/apis/bigquerydatatransfer_v1.rb b/generated/google/apis/bigquerydatatransfer_v1.rb index 190ee1168..ea76380b4 100644 --- a/generated/google/apis/bigquerydatatransfer_v1.rb +++ b/generated/google/apis/bigquerydatatransfer_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigquerydatatransferV1 VERSION = 'V1' - REVISION = '20200226' + REVISION = '20200313' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigqueryreservation_v1.rb b/generated/google/apis/bigqueryreservation_v1.rb index f2278640b..207236cde 100644 --- a/generated/google/apis/bigqueryreservation_v1.rb +++ b/generated/google/apis/bigqueryreservation_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryreservationV1 VERSION = 'V1' - REVISION = '20200220' + REVISION = '20200403' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigqueryreservation_v1/classes.rb b/generated/google/apis/bigqueryreservation_v1/classes.rb index d716126e0..8619a2abd 100644 --- a/generated/google/apis/bigqueryreservation_v1/classes.rb +++ b/generated/google/apis/bigqueryreservation_v1/classes.rb @@ -22,6 +22,171 @@ module Google module Apis module BigqueryreservationV1 + # A Assignment allows a project to submit jobs + # of a certain type using slots from the specified reservation. + class Assignment + include Google::Apis::Core::Hashable + + # The resource which will use the reservation. E.g. + # projects/myproject, folders/123, organizations/456. + # Corresponds to the JSON property `assignee` + # @return [String] + attr_accessor :assignee + + # Which type of jobs will use the reservation. + # Corresponds to the JSON property `jobType` + # @return [String] + attr_accessor :job_type + + # Output only. Name of the resource. E.g.: + # projects/myproject/locations/US/reservations/team1-prod/assignments/123. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. State of the assignment. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @assignee = args[:assignee] if args.key?(:assignee) + @job_type = args[:job_type] if args.key?(:job_type) + @name = args[:name] if args.key?(:name) + @state = args[:state] if args.key?(:state) + end + end + + # Represents a BI Reservation. + class BiReservation + include Google::Apis::Core::Hashable + + # The resource name of the singleton BI reservation. + # Reservation names have the form + # `projects/`project_id`/locations/`location_id`/bireservation`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Size of a reservation, in bytes. + # Corresponds to the JSON property `size` + # @return [Fixnum] + attr_accessor :size + + # Output only. The last update timestamp of a reservation. + # 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) + @name = args[:name] if args.key?(:name) + @size = args[:size] if args.key?(:size) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # Capacity commitment is a way to purchase compute capacity for BigQuery jobs + # (in the form of slots) with some committed period of usage. Monthly and + # annual commitments renew by default. Only flex commitments can be removed. In + # order to remove monthly or annual commitments, their plan needs to be changed + # to flex first. + # A capacity commitment resource exists as a child resource of the admin + # project. + class CapacityCommitment + include Google::Apis::Core::Hashable + + # Output only. The end of the current commitment period. It is applicable only + # for ACTIVE + # capacity commitments. + # Corresponds to the JSON property `commitmentEndTime` + # @return [String] + attr_accessor :commitment_end_time + + # 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 `failureStatus` + # @return [Google::Apis::BigqueryreservationV1::Status] + attr_accessor :failure_status + + # Output only. The resource name of the capacity commitment, e.g., + # projects/myproject/locations/US/capacityCommitments/123 + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Capacity commitment commitment plan. + # Corresponds to the JSON property `plan` + # @return [String] + attr_accessor :plan + + # The plan this capacity commitment is converted to after commitment_end_time + # passes. Once the plan is changed, committed period is extended according to + # commitment plan. Only applicable for ANNUAL commitments. + # Corresponds to the JSON property `renewalPlan` + # @return [String] + attr_accessor :renewal_plan + + # Number of slots in this commitment. + # Corresponds to the JSON property `slotCount` + # @return [Fixnum] + attr_accessor :slot_count + + # Output only. State of the commitment. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @commitment_end_time = args[:commitment_end_time] if args.key?(:commitment_end_time) + @failure_status = args[:failure_status] if args.key?(:failure_status) + @name = args[:name] if args.key?(:name) + @plan = args[:plan] if args.key?(:plan) + @renewal_plan = args[:renewal_plan] if args.key?(:renewal_plan) + @slot_count = args[:slot_count] if args.key?(:slot_count) + @state = args[:state] if args.key?(:state) + end + end + + # The metadata for operation returned from + # ReservationService.CreateSlotPool. + class CreateSlotPoolMetadata + include Google::Apis::Core::Hashable + + # Resource name of the slot pool that is being created. E.g., + # projects/myproject/locations/us-central1/reservations/foo/slotPools/123 + # Corresponds to the JSON property `slotPool` + # @return [String] + attr_accessor :slot_pool + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @slot_pool = args[:slot_pool] if args.key?(:slot_pool) + 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: @@ -41,6 +206,58 @@ module Google end end + # The response for ReservationService.ListAssignments. + class ListAssignmentsResponse + include Google::Apis::Core::Hashable + + # List of assignments visible to the user. + # Corresponds to the JSON property `assignments` + # @return [Array] + attr_accessor :assignments + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # 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) + @assignments = args[:assignments] if args.key?(:assignments) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # The response for ReservationService.ListCapacityCommitments. + class ListCapacityCommitmentsResponse + include Google::Apis::Core::Hashable + + # List of capacity commitments visible to the user. + # Corresponds to the JSON property `capacityCommitments` + # @return [Array] + attr_accessor :capacity_commitments + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # 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) + @capacity_commitments = args[:capacity_commitments] if args.key?(:capacity_commitments) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + # The response message for Operations.ListOperations. class ListOperationsResponse include Google::Apis::Core::Hashable @@ -66,6 +283,78 @@ module Google end end + # The response for ReservationService.ListReservations. + class ListReservationsResponse + include Google::Apis::Core::Hashable + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # List of reservations visible to the user. + # Corresponds to the JSON property `reservations` + # @return [Array] + attr_accessor :reservations + + 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) + @reservations = args[:reservations] if args.key?(:reservations) + end + end + + # The request for ReservationService.MergeCapacityCommitments. + class MergeCapacityCommitmentsRequest + include Google::Apis::Core::Hashable + + # Ids of capacity commitments to merge. + # These capacity commitments must exist under admin project and location + # specified in the parent. + # Corresponds to the JSON property `capacityCommitmentIds` + # @return [Array] + attr_accessor :capacity_commitment_ids + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @capacity_commitment_ids = args[:capacity_commitment_ids] if args.key?(:capacity_commitment_ids) + end + end + + # The request for + # ReservationService.MoveAssignment. + # Note: "bigquery.reservationAssignments.create" permission is required on the + # destination_id. Note: "bigquery.reservationAssignments.create" and + # "bigquery.reservationAssignments.delete" permission is required on the + # related assignee. + class MoveAssignmentRequest + include Google::Apis::Core::Hashable + + # The new reservation ID, e.g.: + # projects/myotherproject/locations/US/reservations/team2-prod + # Corresponds to the JSON property `destinationId` + # @return [String] + attr_accessor :destination_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @destination_id = args[:destination_id] if args.key?(:destination_id) + end + end + # This resource represents a long-running operation that is the result of a # network API call. class Operation @@ -130,6 +419,130 @@ module Google end end + # A reservation is a mechanism used to guarantee slots to users. + class Reservation + include Google::Apis::Core::Hashable + + # If false, any query using this reservation will use idle slots from other + # reservations within the same admin project. If true, a query using this + # reservation will execute with the slot capacity specified above at most. + # Corresponds to the JSON property `ignoreIdleSlots` + # @return [Boolean] + attr_accessor :ignore_idle_slots + alias_method :ignore_idle_slots?, :ignore_idle_slots + + # The resource name of the reservation, e.g., + # "projects/*/locations/*/reservations/team1-prod". + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Minimum slots available to this reservation. A slot is a unit of + # computational power in BigQuery, and serves as the unit of parallelism. + # Queries using this reservation might use more slots during runtime if + # ignore_idle_slots is set to false. + # If the new reservation's slot capacity exceed the parent's slot capacity or + # if total slot capacity of the new reservation and its siblings exceeds the + # parent's slot capacity, the request will fail with + # `google.rpc.Code.RESOURCE_EXHAUSTED`. + # Corresponds to the JSON property `slotCapacity` + # @return [Fixnum] + attr_accessor :slot_capacity + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ignore_idle_slots = args[:ignore_idle_slots] if args.key?(:ignore_idle_slots) + @name = args[:name] if args.key?(:name) + @slot_capacity = args[:slot_capacity] if args.key?(:slot_capacity) + end + end + + # The response for ReservationService.SearchAssignments. + class SearchAssignmentsResponse + include Google::Apis::Core::Hashable + + # List of assignments visible to the user. + # Corresponds to the JSON property `assignments` + # @return [Array] + attr_accessor :assignments + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # 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) + @assignments = args[:assignments] if args.key?(:assignments) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # The request for ReservationService.SplitCapacityCommitment. + class SplitCapacityCommitmentRequest + include Google::Apis::Core::Hashable + + # Number of slots in the capacity commitment after the split. + # Corresponds to the JSON property `slotCount` + # @return [Fixnum] + attr_accessor :slot_count + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @slot_count = args[:slot_count] if args.key?(:slot_count) + end + end + + # The response for ReservationService.SplitCapacityCommitment. + class SplitCapacityCommitmentResponse + include Google::Apis::Core::Hashable + + # Capacity commitment is a way to purchase compute capacity for BigQuery jobs + # (in the form of slots) with some committed period of usage. Monthly and + # annual commitments renew by default. Only flex commitments can be removed. In + # order to remove monthly or annual commitments, their plan needs to be changed + # to flex first. + # A capacity commitment resource exists as a child resource of the admin + # project. + # Corresponds to the JSON property `first` + # @return [Google::Apis::BigqueryreservationV1::CapacityCommitment] + attr_accessor :first + + # Capacity commitment is a way to purchase compute capacity for BigQuery jobs + # (in the form of slots) with some committed period of usage. Monthly and + # annual commitments renew by default. Only flex commitments can be removed. In + # order to remove monthly or annual commitments, their plan needs to be changed + # to flex first. + # A capacity commitment resource exists as a child resource of the admin + # project. + # Corresponds to the JSON property `second` + # @return [Google::Apis::BigqueryreservationV1::CapacityCommitment] + attr_accessor :second + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @first = args[:first] if args.key?(:first) + @second = args[:second] if args.key?(:second) + 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 diff --git a/generated/google/apis/bigqueryreservation_v1/representations.rb b/generated/google/apis/bigqueryreservation_v1/representations.rb index 580b47abe..bf5984f64 100644 --- a/generated/google/apis/bigqueryreservation_v1/representations.rb +++ b/generated/google/apis/bigqueryreservation_v1/representations.rb @@ -22,36 +22,172 @@ module Google module Apis module BigqueryreservationV1 + class Assignment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BiReservation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CapacityCommitment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreateSlotPoolMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Empty class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class ListAssignmentsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListCapacityCommitmentsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ListOperationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class ListReservationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MergeCapacityCommitmentsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MoveAssignmentRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Operation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class Reservation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SearchAssignmentsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SplitCapacityCommitmentRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SplitCapacityCommitmentResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Status class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class Assignment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :assignee, as: 'assignee' + property :job_type, as: 'jobType' + property :name, as: 'name' + property :state, as: 'state' + end + end + + class BiReservation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :size, :numeric_string => true, as: 'size' + property :update_time, as: 'updateTime' + end + end + + class CapacityCommitment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :commitment_end_time, as: 'commitmentEndTime' + property :failure_status, as: 'failureStatus', class: Google::Apis::BigqueryreservationV1::Status, decorator: Google::Apis::BigqueryreservationV1::Status::Representation + + property :name, as: 'name' + property :plan, as: 'plan' + property :renewal_plan, as: 'renewalPlan' + property :slot_count, :numeric_string => true, as: 'slotCount' + property :state, as: 'state' + end + end + + class CreateSlotPoolMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :slot_pool, as: 'slotPool' + end + end + class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end + class ListAssignmentsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :assignments, as: 'assignments', class: Google::Apis::BigqueryreservationV1::Assignment, decorator: Google::Apis::BigqueryreservationV1::Assignment::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListCapacityCommitmentsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :capacity_commitments, as: 'capacityCommitments', class: Google::Apis::BigqueryreservationV1::CapacityCommitment, decorator: Google::Apis::BigqueryreservationV1::CapacityCommitment::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + class ListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -61,6 +197,29 @@ module Google end end + class ListReservationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :reservations, as: 'reservations', class: Google::Apis::BigqueryreservationV1::Reservation, decorator: Google::Apis::BigqueryreservationV1::Reservation::Representation + + end + end + + class MergeCapacityCommitmentsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :capacity_commitment_ids, as: 'capacityCommitmentIds' + end + end + + class MoveAssignmentRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :destination_id, as: 'destinationId' + end + end + class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -73,6 +232,41 @@ module Google end end + class Reservation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ignore_idle_slots, as: 'ignoreIdleSlots' + property :name, as: 'name' + property :slot_capacity, :numeric_string => true, as: 'slotCapacity' + end + end + + class SearchAssignmentsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :assignments, as: 'assignments', class: Google::Apis::BigqueryreservationV1::Assignment, decorator: Google::Apis::BigqueryreservationV1::Assignment::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class SplitCapacityCommitmentRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :slot_count, :numeric_string => true, as: 'slotCount' + end + end + + class SplitCapacityCommitmentResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :first, as: 'first', class: Google::Apis::BigqueryreservationV1::CapacityCommitment, decorator: Google::Apis::BigqueryreservationV1::CapacityCommitment::Representation + + property :second, as: 'second', class: Google::Apis::BigqueryreservationV1::CapacityCommitment, decorator: Google::Apis::BigqueryreservationV1::CapacityCommitment::Representation + + end + end + class Status # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/bigqueryreservation_v1/service.rb b/generated/google/apis/bigqueryreservation_v1/service.rb index 9782a5ea4..d141cfcbd 100644 --- a/generated/google/apis/bigqueryreservation_v1/service.rb +++ b/generated/google/apis/bigqueryreservation_v1/service.rb @@ -126,6 +126,751 @@ module Google command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end + + # Retrieves a BI reservation. + # @param [String] name + # Required. Name of the requested reservation, for example: + # `projects/`project_id`/locations/`location_id`/bireservation` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::BiReservation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::BiReservation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_bi_reservation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::BigqueryreservationV1::BiReservation::Representation + command.response_class = Google::Apis::BigqueryreservationV1::BiReservation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Looks up assignments for a specified resource for a particular region. + # If the request is about a project: + # 1) Assignments created on the project will be returned if they exist. + # 2) Otherwise assignments created on the closest ancestor will be + # returned. 3) Assignments for different JobTypes will all be returned. + # Same logic applies if the request is about a folder. + # If the request is about an organization, then assignments created on the + # organization will be returned (organization doesn't have ancestors). + # Comparing to ListAssignments, there are some behavior + # differences: + # 1) permission on the assignee will be verified in this API. + # 2) Hierarchy lookup (project->folder->organization) happens in this API. + # 3) Parent here is projects/*/locations/*, instead of + # projects/*/locations/*reservations/*. + # Note "-" cannot be used for projects + # nor locations. + # @param [String] parent + # Required. The resource name of the admin project(containing project and + # location), + # e.g.: + # "projects/myproject/locations/US". + # @param [Fixnum] page_size + # The maximum number of items to return. + # @param [String] page_token + # The next_page_token value returned from a previous List request, if any. + # @param [String] query + # Please specify resource name as assignee in the query. + # e.g., "assignee=projects/myproject" + # "assignee=folders/123" + # "assignee=organizations/456" + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::SearchAssignmentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::SearchAssignmentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_location_assignments(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}:searchAssignments', options) + command.response_representation = Google::Apis::BigqueryreservationV1::SearchAssignmentsResponse::Representation + command.response_class = Google::Apis::BigqueryreservationV1::SearchAssignmentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['query'] = query unless query.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a BI reservation. + # Only fields specified in the field_mask are updated. + # Singleton BI reservation always exists with default size 0. + # In order to reserve BI capacity it needs to be updated to an amount + # greater than 0. In order to release BI capacity reservation size + # must be set to 0. + # @param [String] name + # The resource name of the singleton BI reservation. + # Reservation names have the form + # `projects/`project_id`/locations/`location_id`/bireservation`. + # @param [Google::Apis::BigqueryreservationV1::BiReservation] bi_reservation_object + # @param [String] update_mask + # A list of fields to be updated in this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::BiReservation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::BiReservation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_project_location_bi_reservation(name, bi_reservation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+name}', options) + command.request_representation = Google::Apis::BigqueryreservationV1::BiReservation::Representation + command.request_object = bi_reservation_object + command.response_representation = Google::Apis::BigqueryreservationV1::BiReservation::Representation + command.response_class = Google::Apis::BigqueryreservationV1::BiReservation + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new capacity commitment resource. + # @param [String] parent + # Required. Resource name of the parent reservation. E.g., + # projects/myproject/locations/US + # @param [Google::Apis::BigqueryreservationV1::CapacityCommitment] capacity_commitment_object + # @param [Boolean] enforce_single_admin_project_per_org + # If true, fail the request if another project in the organization has a + # capacity commitment. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::CapacityCommitment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::CapacityCommitment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_capacity_commitment(parent, capacity_commitment_object = nil, enforce_single_admin_project_per_org: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/capacityCommitments', options) + command.request_representation = Google::Apis::BigqueryreservationV1::CapacityCommitment::Representation + command.request_object = capacity_commitment_object + command.response_representation = Google::Apis::BigqueryreservationV1::CapacityCommitment::Representation + command.response_class = Google::Apis::BigqueryreservationV1::CapacityCommitment + command.params['parent'] = parent unless parent.nil? + command.query['enforceSingleAdminProjectPerOrg'] = enforce_single_admin_project_per_org unless enforce_single_admin_project_per_org.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a capacity commitment. Attempting to delete capacity commitment + # before its commitment_end_time will fail with the error code + # `google.rpc.Code.FAILED_PRECONDITION`. + # @param [String] name + # Required. Resource name of the capacity commitment to delete. E.g., + # projects/myproject/locations/US/capacityCommitments/123 + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_capacity_commitment(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::BigqueryreservationV1::Empty::Representation + command.response_class = Google::Apis::BigqueryreservationV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns information about the capacity commitment. + # @param [String] name + # Required. Resource name of the capacity commitment to retrieve. E.g., + # projects/myproject/locations/US/capacityCommitments/123 + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::CapacityCommitment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::CapacityCommitment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_capacity_commitment(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::BigqueryreservationV1::CapacityCommitment::Representation + command.response_class = Google::Apis::BigqueryreservationV1::CapacityCommitment + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all the capacity commitments for the admin project. + # @param [String] parent + # Required. Resource name of the parent reservation. E.g., + # projects/myproject/locations/US + # @param [Fixnum] page_size + # The maximum number of items to return. + # @param [String] page_token + # The next_page_token value returned from a previous List request, if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::ListCapacityCommitmentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::ListCapacityCommitmentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_capacity_commitments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/capacityCommitments', options) + command.response_representation = Google::Apis::BigqueryreservationV1::ListCapacityCommitmentsResponse::Representation + command.response_class = Google::Apis::BigqueryreservationV1::ListCapacityCommitmentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Merges capacity commitments of the same plan into one. Resulting capacity + # commitment has the longer commitment_end_time out of the two. Attempting to + # merge capacity commitments of different plan will fail with the error code + # `google.rpc.Code.FAILED_PRECONDITION`. + # @param [String] parent + # Parent resource that identifies admin project and location e.g., + # projects/myproject/locations/us + # @param [Google::Apis::BigqueryreservationV1::MergeCapacityCommitmentsRequest] merge_capacity_commitments_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::CapacityCommitment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::CapacityCommitment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def merge_capacity_commitments(parent, merge_capacity_commitments_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/capacityCommitments:merge', options) + command.request_representation = Google::Apis::BigqueryreservationV1::MergeCapacityCommitmentsRequest::Representation + command.request_object = merge_capacity_commitments_request_object + command.response_representation = Google::Apis::BigqueryreservationV1::CapacityCommitment::Representation + command.response_class = Google::Apis::BigqueryreservationV1::CapacityCommitment + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing capacity commitment. + # Only plan and renewal_plan fields can be updated. + # Plan can only be changed to a plan of a longer commitment period. + # Attempting to change to a plan with shorter commitment period will fail + # with the error code `google.rpc.Code.FAILED_PRECONDITION`. + # @param [String] name + # Output only. The resource name of the capacity commitment, e.g., + # projects/myproject/locations/US/capacityCommitments/123 + # @param [Google::Apis::BigqueryreservationV1::CapacityCommitment] capacity_commitment_object + # @param [String] update_mask + # Standard field mask for the set of fields to be updated. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::CapacityCommitment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::CapacityCommitment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_capacity_commitment(name, capacity_commitment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+name}', options) + command.request_representation = Google::Apis::BigqueryreservationV1::CapacityCommitment::Representation + command.request_object = capacity_commitment_object + command.response_representation = Google::Apis::BigqueryreservationV1::CapacityCommitment::Representation + command.response_class = Google::Apis::BigqueryreservationV1::CapacityCommitment + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Splits capacity commitment to two commitments of the same plan and + # commitment_end_time. A common use case to do that is to perform a downgrade + # e.g., in order to downgrade from 10000 slots to 8000, one might split 10000 + # capacity commitment to 2000 and 8000, change the plan of the first one to + # flex and then delete it. + # @param [String] name + # Required. The resource name e.g.,: + # projects/myproject/locations/US/capacityCommitments/123 + # @param [Google::Apis::BigqueryreservationV1::SplitCapacityCommitmentRequest] split_capacity_commitment_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::SplitCapacityCommitmentResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::SplitCapacityCommitmentResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def split_capacity_commitment(name, split_capacity_commitment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:split', options) + command.request_representation = Google::Apis::BigqueryreservationV1::SplitCapacityCommitmentRequest::Representation + command.request_object = split_capacity_commitment_request_object + command.response_representation = Google::Apis::BigqueryreservationV1::SplitCapacityCommitmentResponse::Representation + command.response_class = Google::Apis::BigqueryreservationV1::SplitCapacityCommitmentResponse + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new reservation resource. + # @param [String] parent + # Required. Project, location. E.g., + # projects/myproject/locations/US + # @param [Google::Apis::BigqueryreservationV1::Reservation] reservation_object + # @param [String] reservation_id + # The reservation ID. This field must only contain lower case alphanumeric + # characters or dash. Max length is 64 characters. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::Reservation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::Reservation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_reservation(parent, reservation_object = nil, reservation_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/reservations', options) + command.request_representation = Google::Apis::BigqueryreservationV1::Reservation::Representation + command.request_object = reservation_object + command.response_representation = Google::Apis::BigqueryreservationV1::Reservation::Representation + command.response_class = Google::Apis::BigqueryreservationV1::Reservation + command.params['parent'] = parent unless parent.nil? + command.query['reservationId'] = reservation_id unless reservation_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a reservation. + # Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has + # assignments. + # @param [String] name + # Required. Resource name of the reservation to retrieve. E.g., + # projects/myproject/locations/US/reservations/team1-prod + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_reservation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::BigqueryreservationV1::Empty::Representation + command.response_class = Google::Apis::BigqueryreservationV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns information about the reservation. + # @param [String] name + # Required. Resource name of the reservation to retrieve. E.g., + # projects/myproject/locations/US/reservations/team1-prod + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::Reservation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::Reservation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_reservation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::BigqueryreservationV1::Reservation::Representation + command.response_class = Google::Apis::BigqueryreservationV1::Reservation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all the reservations for the project in the specified location. + # @param [String] parent + # Required. The parent resource name containing project and location, e.g.: + # "projects/myproject/locations/US" + # @param [Fixnum] page_size + # The maximum number of items to return. + # @param [String] page_token + # The next_page_token value returned from a previous List request, if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::ListReservationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::ListReservationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_reservations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/reservations', options) + command.response_representation = Google::Apis::BigqueryreservationV1::ListReservationsResponse::Representation + command.response_class = Google::Apis::BigqueryreservationV1::ListReservationsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing reservation resource. + # @param [String] name + # The resource name of the reservation, e.g., + # "projects/*/locations/*/reservations/team1-prod". + # @param [Google::Apis::BigqueryreservationV1::Reservation] reservation_object + # @param [String] update_mask + # Standard field mask for the set of fields to be updated. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::Reservation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::Reservation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_reservation(name, reservation_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+name}', options) + command.request_representation = Google::Apis::BigqueryreservationV1::Reservation::Representation + command.request_object = reservation_object + command.response_representation = Google::Apis::BigqueryreservationV1::Reservation::Representation + command.response_class = Google::Apis::BigqueryreservationV1::Reservation + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates an object which allows the given project to submit jobs + # of a certain type using slots from the specified reservation. Currently a + # resource (project, folder, organization) can only have one assignment per + # `job_type, location`, and that reservation will be used for all jobs of the + # matching type. Within the organization, different assignments can be + # created on projects, folders or organization level. During query execution, + # the assignment is looked up at the project, folder and organization levels + # in that order. The first assignment found is applied to the query. When + # creating assignments, it does not matter if other assignments exist at + # higher levels. E.g: organizationA contains project1, project2. Assignments + # for organizationA, project1 and project2 could all be created, mapping to + # the same or different reservations. + # Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have + # 'bigquery.admin' permissions on the project using the reservation + # and the project that owns this reservation. + # Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment + # does not match location of the reservation. + # @param [String] parent + # Required. The parent resource name of the assignment + # E.g.: projects/myproject/locations/US/reservations/team1-prod + # @param [Google::Apis::BigqueryreservationV1::Assignment] assignment_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::Assignment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::Assignment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_reservation_assignment(parent, assignment_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/assignments', options) + command.request_representation = Google::Apis::BigqueryreservationV1::Assignment::Representation + command.request_object = assignment_object + command.response_representation = Google::Apis::BigqueryreservationV1::Assignment::Representation + command.response_class = Google::Apis::BigqueryreservationV1::Assignment + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a assignment. No expansion will happen. + # E.g: + # organizationA contains project1 and project2. Reservation res1 exists. + # CreateAssignment was invoked previously and following assignments were + # created explicitly: + # + # + # Then deletion of won't affect . After + # deletion of , queries from project1 will still use + # res1, while queries from project2 will use on-demand mode. + # @param [String] name + # Required. Name of the resource, e.g.: + # projects/myproject/locations/US/reservations/team1-prod/assignments/123 + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_reservation_assignment(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::BigqueryreservationV1::Empty::Representation + command.response_class = Google::Apis::BigqueryreservationV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists assignments. + # Only explicitly created assignments will be returned. E.g: + # organizationA contains project1 and project2. Reservation res1 exists. + # CreateAssignment was invoked previously and following assignments were + # created explicitly: + # + # + # Then this API will just return the above two assignments for reservation + # res1, and no expansion/merge will happen. Wildcard "-" can be used for + # reservations in the request. In that case all assignments belongs to the + # specified project and location will be listed. Note + # "-" cannot be used for projects nor locations. + # @param [String] parent + # Required. The parent resource name e.g.: + # projects/myproject/locations/US/reservations/team1-prod + # Or: + # projects/myproject/locations/US/reservations/- + # @param [Fixnum] page_size + # The maximum number of items to return. + # @param [String] page_token + # The next_page_token value returned from a previous List request, if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::ListAssignmentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::ListAssignmentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_reservation_assignments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/assignments', options) + command.response_representation = Google::Apis::BigqueryreservationV1::ListAssignmentsResponse::Representation + command.response_class = Google::Apis::BigqueryreservationV1::ListAssignmentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Moves a assignment under a new reservation. Customers can do this by + # deleting the existing assignment followed by creating another assignment + # under the new reservation, but this method provides a transactional way to + # do so, to make sure the assignee always has an associated reservation. + # Without the method customers might see some queries run on-demand which + # might be unexpected. + # @param [String] name + # Required. The resource name of the assignment, + # e.g.: + # projects/myproject/locations/US/reservations/team1-prod/assignments/123 + # @param [Google::Apis::BigqueryreservationV1::MoveAssignmentRequest] move_assignment_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigqueryreservationV1::Assignment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigqueryreservationV1::Assignment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def move_assignment(name, move_assignment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:move', options) + command.request_representation = Google::Apis::BigqueryreservationV1::MoveAssignmentRequest::Representation + command.request_object = move_assignment_request_object + command.response_representation = Google::Apis::BigqueryreservationV1::Assignment::Representation + command.response_class = Google::Apis::BigqueryreservationV1::Assignment + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end protected diff --git a/generated/google/apis/bigqueryreservation_v1beta1.rb b/generated/google/apis/bigqueryreservation_v1beta1.rb index ebed897bc..b5f6a3711 100644 --- a/generated/google/apis/bigqueryreservation_v1beta1.rb +++ b/generated/google/apis/bigqueryreservation_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryreservationV1beta1 VERSION = 'V1beta1' - REVISION = '20200229' + REVISION = '20200403' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigqueryreservation_v1beta1/classes.rb b/generated/google/apis/bigqueryreservation_v1beta1/classes.rb index ce7b67cb1..082e8d067 100644 --- a/generated/google/apis/bigqueryreservation_v1beta1/classes.rb +++ b/generated/google/apis/bigqueryreservation_v1beta1/classes.rb @@ -62,6 +62,40 @@ module Google end end + # Auto scaling settings and current situation. + # System will create a dedicated FLEX capacity commitment to hold the slots + # for auto-scale. Users won't be able to manage it,to avoid conflicts. + # Scale-up will happen, if there are always pending tasks for the past 10 + # minutes. + # Scale-down will happen, if the system knows that scale-up won't be + # triggered again. + # Note this is an alpha feature. + class Autoscale + include Google::Apis::Core::Hashable + + # Output only. The slot capacity added to this reservation when autoscale + # happens. Will + # be between [0, max_slots]. + # Corresponds to the JSON property `currentSlots` + # @return [Fixnum] + attr_accessor :current_slots + + # Number of slots to be scaled when needed. + # Corresponds to the JSON property `maxSlots` + # @return [Fixnum] + attr_accessor :max_slots + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @current_slots = args[:current_slots] if args.key?(:current_slots) + @max_slots = args[:max_slots] if args.key?(:max_slots) + end + end + # Represents a BI Reservation. class BiReservation include Google::Apis::Core::Hashable @@ -135,7 +169,7 @@ module Google # The plan this capacity commitment is converted to after commitment_end_time # passes. Once the plan is changed, committed period is extended according to - # commitment plan. Only applicable for MONTHLY and ANNUAL commitments. + # commitment plan. Only applicable for ANNUAL commitments. # Corresponds to the JSON property `renewalPlan` # @return [String] attr_accessor :renewal_plan @@ -166,6 +200,27 @@ module Google end end + # The metadata for operation returned from + # ReservationService.CreateSlotPool. + class CreateSlotPoolMetadata + include Google::Apis::Core::Hashable + + # Resource name of the slot pool that is being created. E.g., + # projects/myproject/locations/us-central1/reservations/foo/slotPools/123 + # Corresponds to the JSON property `slotPool` + # @return [String] + attr_accessor :slot_pool + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @slot_pool = args[:slot_pool] if args.key?(:slot_pool) + 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: @@ -313,6 +368,18 @@ module Google class Reservation include Google::Apis::Core::Hashable + # Auto scaling settings and current situation. + # System will create a dedicated FLEX capacity commitment to hold the slots + # for auto-scale. Users won't be able to manage it,to avoid conflicts. + # Scale-up will happen, if there are always pending tasks for the past 10 + # minutes. + # Scale-down will happen, if the system knows that scale-up won't be + # triggered again. + # Note this is an alpha feature. + # Corresponds to the JSON property `autoscale` + # @return [Google::Apis::BigqueryreservationV1beta1::Autoscale] + attr_accessor :autoscale + # If false, any query using this reservation will use idle slots from other # reservations within the same admin project. If true, a query using this # reservation will execute with the slot capacity specified above at most. @@ -345,6 +412,7 @@ module Google # Update properties of this object def update!(**args) + @autoscale = args[:autoscale] if args.key?(:autoscale) @ignore_idle_slots = args[:ignore_idle_slots] if args.key?(:ignore_idle_slots) @name = args[:name] if args.key?(:name) @slot_capacity = args[:slot_capacity] if args.key?(:slot_capacity) @@ -471,25 +539,6 @@ module Google @message = args[:message] if args.key?(:message) end end - - # The request for ReservationService.UpgradeCapacityCommitmentPlan. - class UpgradeCapacityCommitmentPlanRequest - include Google::Apis::Core::Hashable - - # New capacity commitment plan. - # Corresponds to the JSON property `plan` - # @return [String] - attr_accessor :plan - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @plan = args[:plan] if args.key?(:plan) - end - end end end end diff --git a/generated/google/apis/bigqueryreservation_v1beta1/representations.rb b/generated/google/apis/bigqueryreservation_v1beta1/representations.rb index fcc65cf96..052d14045 100644 --- a/generated/google/apis/bigqueryreservation_v1beta1/representations.rb +++ b/generated/google/apis/bigqueryreservation_v1beta1/representations.rb @@ -28,6 +28,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Autoscale + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class BiReservation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -40,6 +46,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class CreateSlotPoolMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Empty class Representation < Google::Apis::Core::JsonRepresentation; end @@ -106,12 +118,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class UpgradeCapacityCommitmentPlanRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class Assignment # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -122,6 +128,14 @@ module Google end end + class Autoscale + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :current_slots, :numeric_string => true, as: 'currentSlots' + property :max_slots, :numeric_string => true, as: 'maxSlots' + end + end + class BiReservation # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -145,6 +159,13 @@ module Google end end + class CreateSlotPoolMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :slot_pool, as: 'slotPool' + end + end + class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -195,6 +216,8 @@ module Google class Reservation # @private class Representation < Google::Apis::Core::JsonRepresentation + property :autoscale, as: 'autoscale', class: Google::Apis::BigqueryreservationV1beta1::Autoscale, decorator: Google::Apis::BigqueryreservationV1beta1::Autoscale::Representation + property :ignore_idle_slots, as: 'ignoreIdleSlots' property :name, as: 'name' property :slot_capacity, :numeric_string => true, as: 'slotCapacity' @@ -235,13 +258,6 @@ module Google property :message, as: 'message' end end - - class UpgradeCapacityCommitmentPlanRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :plan, as: 'plan' - end - end end end end diff --git a/generated/google/apis/bigqueryreservation_v1beta1/service.rb b/generated/google/apis/bigqueryreservation_v1beta1/service.rb index bfb199696..1ca466c43 100644 --- a/generated/google/apis/bigqueryreservation_v1beta1/service.rb +++ b/generated/google/apis/bigqueryreservation_v1beta1/service.rb @@ -358,7 +358,10 @@ module Google end # Updates an existing capacity commitment. - # Only renewal_plan field can be updated. + # Only plan and renewal_plan fields can be updated. + # Plan can only be changed to a plan of a longer commitment period. + # Attempting to change to a plan with shorter commitment period will fail + # with the error code `google.rpc.Code.FAILED_PRECONDITION`. # @param [String] name # Output only. The resource name of the capacity commitment, e.g., # projects/myproject/locations/US/capacityCommitments/123 @@ -433,44 +436,6 @@ module Google execute_or_queue_command(command, &block) end - # Replaces an existing commitment with a new commitment of a different plan. - # Plan can only be changed to a plan of a longer commitment period. New - # commitment start is set to a current time. Attempting to change to a plan - # with shorter commitment period will fail with the error code - # `google.rpc.Code.FAILED_PRECONDITION`. - # @param [String] capacity_commitment - # Required. The resource name e.g.,: - # projects/myproject/locations/US/capacityCommitments/123 - # @param [Google::Apis::BigqueryreservationV1beta1::UpgradeCapacityCommitmentPlanRequest] upgrade_capacity_commitment_plan_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::BigqueryreservationV1beta1::CapacityCommitment] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def upgrade_capacity_commitment_plan(capacity_commitment, upgrade_capacity_commitment_plan_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/{+capacityCommitment}:upgradeCapacityCommitmentPlan', options) - command.request_representation = Google::Apis::BigqueryreservationV1beta1::UpgradeCapacityCommitmentPlanRequest::Representation - command.request_object = upgrade_capacity_commitment_plan_request_object - command.response_representation = Google::Apis::BigqueryreservationV1beta1::CapacityCommitment::Representation - command.response_class = Google::Apis::BigqueryreservationV1beta1::CapacityCommitment - command.params['capacityCommitment'] = capacity_commitment unless capacity_commitment.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - # Creates a new reservation resource. # @param [String] parent # Required. Project, location. E.g., diff --git a/generated/google/apis/bigtableadmin_v1.rb b/generated/google/apis/bigtableadmin_v1.rb index 42efe04ea..1602319c7 100644 --- a/generated/google/apis/bigtableadmin_v1.rb +++ b/generated/google/apis/bigtableadmin_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigtable/ module BigtableadminV1 VERSION = 'V1' - REVISION = '20191022' + REVISION = '20200211' end end end diff --git a/generated/google/apis/bigtableadmin_v1/classes.rb b/generated/google/apis/bigtableadmin_v1/classes.rb index a601614c0..c6b7ff615 100644 --- a/generated/google/apis/bigtableadmin_v1/classes.rb +++ b/generated/google/apis/bigtableadmin_v1/classes.rb @@ -39,19 +39,20 @@ module Google # The location where this cluster's nodes and storage reside. For best # performance, clients should be located as close as possible to this # cluster. Currently only zones are supported, so values should be of the - # form `projects//locations/`. + # form `projects/`project`/locations/`zone``. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # (`OutputOnly`) + # Required. (`OutputOnly`) # The unique name of the cluster. Values are of the form - # `projects//instances//clusters/a-z*`. + # `projects/`project`/instances/`instance`/clusters/a-z*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The number of nodes allocated to this cluster. More nodes enable higher + # Required. The number of nodes allocated to this cluster. More nodes enable + # higher # throughput and more consistent performance. # Corresponds to the JSON property `serveNodes` # @return [Fixnum] @@ -131,16 +132,17 @@ module Google # @return [Google::Apis::BigtableadminV1::Cluster] attr_accessor :cluster - # The ID to be used when referring to the new cluster within its instance, + # Required. The ID to be used when referring to the new cluster within its + # instance, # e.g., just `mycluster` rather than # `projects/myproject/instances/myinstance/clusters/mycluster`. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id - # The unique name of the instance in which to create the new cluster. + # Required. The unique name of the instance in which to create the new cluster. # Values are of the form - # `projects//instances/`. + # `projects/`project`/instances/`instance``. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -192,7 +194,7 @@ module Google class CreateInstanceRequest include Google::Apis::Core::Hashable - # The clusters to be created within the instance, mapped by desired + # Required. The clusters to be created within the instance, mapped by desired # cluster ID, e.g., just `mycluster` rather than # `projects/myproject/instances/myinstance/clusters/mycluster`. # Fields marked `OutputOnly` must be left blank. @@ -209,15 +211,16 @@ module Google # @return [Google::Apis::BigtableadminV1::Instance] attr_accessor :instance - # The ID to be used when referring to the new instance within its project, + # Required. The ID to be used when referring to the new instance within its + # project, # e.g., just `myinstance` rather than # `projects/myproject/instances/myinstance`. # Corresponds to the JSON property `instanceId` # @return [String] attr_accessor :instance_id - # The unique name of the project in which to create the new instance. - # Values are of the form `projects/`. + # Required. The unique name of the project in which to create the new instance. + # Values are of the form `projects/`project``. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -242,14 +245,14 @@ module Google class Instance include Google::Apis::Core::Hashable - # The descriptive name for this instance as it appears in UIs. + # Required. The descriptive name for this instance as it appears in UIs. # Can be changed at any time, but should be kept globally unique # to avoid confusion. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Labels are a flexible and lightweight mechanism for organizing cloud + # Required. Labels are a flexible and lightweight mechanism for organizing cloud # resources into groups that reflect a customer's organizational needs and # deployment strategies. They can be used to filter resources and aggregate # metrics. @@ -263,9 +266,9 @@ module Google # @return [Hash] attr_accessor :labels - # (`OutputOnly`) + # Required. (`OutputOnly`) # The unique name of the instance. Values are of the form - # `projects//instances/a-z+[a-z0-9]`. + # `projects/`project`/instances/a-z+[a-z0-9]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -276,7 +279,7 @@ module Google # @return [String] attr_accessor :state - # The type of the instance. Defaults to `PRODUCTION`. + # Required. The type of the instance. Defaults to `PRODUCTION`. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -307,7 +310,7 @@ module Google # @return [Google::Apis::BigtableadminV1::Instance] attr_accessor :instance - # The subset of Instance fields which should be replaced. + # Required. The subset of Instance fields which should be replaced. # Must be explicitly set. # Corresponds to the JSON property `updateMask` # @return [String] diff --git a/generated/google/apis/bigtableadmin_v2.rb b/generated/google/apis/bigtableadmin_v2.rb index d261adc4a..3c403c347 100644 --- a/generated/google/apis/bigtableadmin_v2.rb +++ b/generated/google/apis/bigtableadmin_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigtable/ module BigtableadminV2 VERSION = 'V2' - REVISION = '20200204' + REVISION = '20200211' # Administer your Cloud Bigtable tables and clusters AUTH_BIGTABLE_ADMIN = 'https://www.googleapis.com/auth/bigtable.admin' diff --git a/generated/google/apis/bigtableadmin_v2/classes.rb b/generated/google/apis/bigtableadmin_v2/classes.rb index c991d8f8a..223ae8de4 100644 --- a/generated/google/apis/bigtableadmin_v2/classes.rb +++ b/generated/google/apis/bigtableadmin_v2/classes.rb @@ -285,7 +285,7 @@ module Google class CheckConsistencyRequest include Google::Apis::Core::Hashable - # The token created using GenerateConsistencyToken for the Table. + # Required. The token created using GenerateConsistencyToken for the Table. # Corresponds to the JSON property `consistencyToken` # @return [String] attr_accessor :consistency_token @@ -339,19 +339,20 @@ module Google # The location where this cluster's nodes and storage reside. For best # performance, clients should be located as close as possible to this # cluster. Currently only zones are supported, so values should be of the - # form `projects//locations/`. + # form `projects/`project`/locations/`zone``. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # (`OutputOnly`) + # Required. (`OutputOnly`) # The unique name of the cluster. Values are of the form - # `projects//instances//clusters/a-z*`. + # `projects/`project`/instances/`instance`/clusters/a-z*`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The number of nodes allocated to this cluster. More nodes enable higher + # Required. The number of nodes allocated to this cluster. More nodes enable + # higher # throughput and more consistent performance. # Corresponds to the JSON property `serveNodes` # @return [Fixnum] @@ -469,16 +470,17 @@ module Google # @return [Google::Apis::BigtableadminV2::Cluster] attr_accessor :cluster - # The ID to be used when referring to the new cluster within its instance, + # Required. The ID to be used when referring to the new cluster within its + # instance, # e.g., just `mycluster` rather than # `projects/myproject/instances/myinstance/clusters/mycluster`. # Corresponds to the JSON property `clusterId` # @return [String] attr_accessor :cluster_id - # The unique name of the instance in which to create the new cluster. + # Required. The unique name of the instance in which to create the new cluster. # Values are of the form - # `projects//instances/`. + # `projects/`project`/instances/`instance``. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -530,7 +532,7 @@ module Google class CreateInstanceRequest include Google::Apis::Core::Hashable - # The clusters to be created within the instance, mapped by desired + # Required. The clusters to be created within the instance, mapped by desired # cluster ID, e.g., just `mycluster` rather than # `projects/myproject/instances/myinstance/clusters/mycluster`. # Fields marked `OutputOnly` must be left blank. @@ -547,15 +549,16 @@ module Google # @return [Google::Apis::BigtableadminV2::Instance] attr_accessor :instance - # The ID to be used when referring to the new instance within its project, + # Required. The ID to be used when referring to the new instance within its + # project, # e.g., just `myinstance` rather than # `projects/myproject/instances/myinstance`. # Corresponds to the JSON property `instanceId` # @return [String] attr_accessor :instance_id - # The unique name of the project in which to create the new instance. - # Values are of the form `projects/`. + # Required. The unique name of the project in which to create the new instance. + # Values are of the form `projects/`project``. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -602,8 +605,9 @@ module Google # @return [Google::Apis::BigtableadminV2::Table] attr_accessor :table - # The name by which the new table should be referred to within the parent - # instance, e.g., `foobar` rather than `/tables/foobar`. + # Required. The name by which the new table should be referred to within the + # parent + # instance, e.g., `foobar` rather than ``parent`/tables/foobar`. # Maximum 50 characters. # Corresponds to the JSON property `tableId` # @return [String] @@ -855,14 +859,14 @@ module Google class Instance include Google::Apis::Core::Hashable - # The descriptive name for this instance as it appears in UIs. + # Required. The descriptive name for this instance as it appears in UIs. # Can be changed at any time, but should be kept globally unique # to avoid confusion. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Labels are a flexible and lightweight mechanism for organizing cloud + # Required. Labels are a flexible and lightweight mechanism for organizing cloud # resources into groups that reflect a customer's organizational needs and # deployment strategies. They can be used to filter resources and aggregate # metrics. @@ -876,9 +880,9 @@ module Google # @return [Hash] attr_accessor :labels - # (`OutputOnly`) + # Required. (`OutputOnly`) # The unique name of the instance. Values are of the form - # `projects//instances/a-z+[a-z0-9]`. + # `projects/`project`/instances/a-z+[a-z0-9]`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -889,7 +893,7 @@ module Google # @return [String] attr_accessor :state - # The type of the instance. Defaults to `PRODUCTION`. + # Required. The type of the instance. Defaults to `PRODUCTION`. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -1203,7 +1207,8 @@ module Google class ModifyColumnFamiliesRequest include Google::Apis::Core::Hashable - # Modifications to be atomically applied to the specified table's families. + # Required. Modifications to be atomically applied to the specified table's + # families. # Entries are applied in order, meaning that earlier modifications can be # masked by later ones (in the case of repeated updates to the same family, # for example). @@ -1314,7 +1319,7 @@ module Google # @return [Google::Apis::BigtableadminV2::Instance] attr_accessor :instance - # The subset of Instance fields which should be replaced. + # Required. The subset of Instance fields which should be replaced. # Must be explicitly set. # Corresponds to the JSON property `updateMask` # @return [String] diff --git a/generated/google/apis/bigtableadmin_v2/service.rb b/generated/google/apis/bigtableadmin_v2/service.rb index 2264e0d29..896a4f920 100644 --- a/generated/google/apis/bigtableadmin_v2/service.rb +++ b/generated/google/apis/bigtableadmin_v2/service.rb @@ -200,8 +200,8 @@ module Google # Create an instance within a project. # @param [String] parent - # The unique name of the project in which to create the new instance. - # Values are of the form `projects/`. + # Required. The unique name of the project in which to create the new instance. + # Values are of the form `projects/`project``. # @param [Google::Apis::BigtableadminV2::CreateInstanceRequest] create_instance_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -234,8 +234,8 @@ module Google # Delete an instance from a project. # @param [String] name - # The unique name of the instance to be deleted. - # Values are of the form `projects//instances/`. + # Required. The unique name of the instance to be deleted. + # Values are of the form `projects/`project`/instances/`instance``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -265,8 +265,8 @@ module Google # Gets information about an instance. # @param [String] name - # The unique name of the requested instance. Values are of the form - # `projects//instances/`. + # Required. The unique name of the requested instance. Values are of the form + # `projects/`project`/instances/`instance``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -331,8 +331,9 @@ module Google # Lists information about instances in a project. # @param [String] parent - # The unique name of the project for which a list of instances is requested. - # Values are of the form `projects/`. + # Required. The unique name of the project for which a list of instances is + # requested. + # Values are of the form `projects/`project``. # @param [String] page_token # DEPRECATED: This field is unused and ignored. # @param [String] fields @@ -366,12 +367,12 @@ module Google # Partially updates an instance within a project. This method can modify all # fields of an Instance and is the preferred way to update an Instance. # @param [String] name - # (`OutputOnly`) + # Required. (`OutputOnly`) # The unique name of the instance. Values are of the form - # `projects//instances/a-z+[a-z0-9]`. + # `projects/`project`/instances/a-z+[a-z0-9]`. # @param [Google::Apis::BigtableadminV2::Instance] instance_object # @param [String] update_mask - # The subset of Instance fields which should be replaced. + # Required. The subset of Instance fields which should be replaced. # Must be explicitly set. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -476,9 +477,9 @@ module Google # name and type for an Instance. To update other Instance properties, such as # labels, use PartialUpdateInstance. # @param [String] name - # (`OutputOnly`) + # Required. (`OutputOnly`) # The unique name of the instance. Values are of the form - # `projects//instances/a-z+[a-z0-9]`. + # `projects/`project`/instances/a-z+[a-z0-9]`. # @param [Google::Apis::BigtableadminV2::Instance] instance_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -511,12 +512,13 @@ module Google # Creates an app profile within an instance. # @param [String] parent - # The unique name of the instance in which to create the new app profile. + # Required. The unique name of the instance in which to create the new app + # profile. # Values are of the form - # `projects//instances/`. + # `projects/`project`/instances/`instance``. # @param [Google::Apis::BigtableadminV2::AppProfile] app_profile_object # @param [String] app_profile_id - # The ID to be used when referring to the new app profile within its + # Required. The ID to be used when referring to the new app profile within its # instance, e.g., just `myprofile` rather than # `projects/myproject/instances/myinstance/appProfiles/myprofile`. # @param [Boolean] ignore_warnings @@ -554,10 +556,11 @@ module Google # Deletes an app profile from an instance. # @param [String] name - # The unique name of the app profile to be deleted. Values are of the form - # `projects//instances//appProfiles/`. + # Required. The unique name of the app profile to be deleted. Values are of the + # form + # `projects/`project`/instances/`instance`/appProfiles/`app_profile``. # @param [Boolean] ignore_warnings - # If true, ignore safety checks when deleting the app profile. + # Required. If true, ignore safety checks when deleting the app profile. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -588,8 +591,8 @@ module Google # Gets information about an app profile. # @param [String] name - # The unique name of the requested app profile. Values are of the form - # `projects//instances//appProfiles/`. + # Required. The unique name of the requested app profile. Values are of the form + # `projects/`project`/instances/`instance`/appProfiles/`app_profile``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -619,10 +622,10 @@ module Google # Lists information about app profiles in an instance. # @param [String] parent - # The unique name of the instance for which a list of app profiles is + # Required. The unique name of the instance for which a list of app profiles is # requested. Values are of the form - # `projects//instances/`. - # Use ` = '-'` to list AppProfiles for all Instances in a project, + # `projects/`project`/instances/`instance``. + # Use ``instance` = '-'` to list AppProfiles for all Instances in a project, # e.g., `projects/myproject/instances/-`. # @param [Fixnum] page_size # Maximum number of results per page. @@ -672,7 +675,7 @@ module Google # @param [Boolean] ignore_warnings # If true, ignore safety checks when updating the app profile. # @param [String] update_mask - # The subset of app profile fields which should be replaced. + # Required. The subset of app profile fields which should be replaced. # If unset, all fields will be replaced. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -707,12 +710,13 @@ module Google # Creates a cluster within an instance. # @param [String] parent - # The unique name of the instance in which to create the new cluster. + # Required. The unique name of the instance in which to create the new cluster. # Values are of the form - # `projects//instances/`. + # `projects/`project`/instances/`instance``. # @param [Google::Apis::BigtableadminV2::Cluster] cluster_object # @param [String] cluster_id - # The ID to be used when referring to the new cluster within its instance, + # Required. The ID to be used when referring to the new cluster within its + # instance, # e.g., just `mycluster` rather than # `projects/myproject/instances/myinstance/clusters/mycluster`. # @param [String] fields @@ -747,8 +751,8 @@ module Google # Deletes a cluster from an instance. # @param [String] name - # The unique name of the cluster to be deleted. Values are of the form - # `projects//instances//clusters/`. + # Required. The unique name of the cluster to be deleted. Values are of the form + # `projects/`project`/instances/`instance`/clusters/`cluster``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -778,8 +782,8 @@ module Google # Gets information about a cluster. # @param [String] name - # The unique name of the requested cluster. Values are of the form - # `projects//instances//clusters/`. + # Required. The unique name of the requested cluster. Values are of the form + # `projects/`project`/instances/`instance`/clusters/`cluster``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -809,9 +813,10 @@ module Google # Lists information about clusters in an instance. # @param [String] parent - # The unique name of the instance for which a list of clusters is requested. - # Values are of the form `projects//instances/`. - # Use ` = '-'` to list Clusters for all Instances in a project, + # Required. The unique name of the instance for which a list of clusters is + # requested. + # Values are of the form `projects/`project`/instances/`instance``. + # Use ``instance` = '-'` to list Clusters for all Instances in a project, # e.g., `projects/myproject/instances/-`. # @param [String] page_token # DEPRECATED: This field is unused and ignored. @@ -845,9 +850,9 @@ module Google # Updates a cluster within an instance. # @param [String] name - # (`OutputOnly`) + # Required. (`OutputOnly`) # The unique name of the cluster. Values are of the form - # `projects//instances//clusters/a-z*`. + # `projects/`project`/instances/`instance`/clusters/a-z*`. # @param [Google::Apis::BigtableadminV2::Cluster] cluster_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -949,13 +954,48 @@ module Google execute_or_queue_command(command, &block) end + # Returns permissions that the caller has on the specified table resource. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::BigtableadminV2::TestIamPermissionsRequest] test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BigtableadminV2::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BigtableadminV2::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_backup_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::BigtableadminV2::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::BigtableadminV2::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::BigtableadminV2::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Checks replication consistency based on a consistency token, that is, if # replication has caught up based on the conditions specified in the token # and the check request. # @param [String] name - # The unique name of the Table for which to check replication consistency. + # Required. The unique name of the Table for which to check replication + # consistency. # Values are of the form - # `projects//instances//tables/`. + # `projects/`project`/instances/`instance`/tables/`table``. # @param [Google::Apis::BigtableadminV2::CheckConsistencyRequest] check_consistency_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -990,8 +1030,8 @@ module Google # The table can be created with a full set of initial column families, # specified in the request. # @param [String] parent - # The unique name of the instance in which to create the table. - # Values are of the form `projects//instances/`. + # Required. The unique name of the instance in which to create the table. + # Values are of the form `projects/`project`/instances/`instance``. # @param [Google::Apis::BigtableadminV2::CreateTableRequest] create_table_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1024,9 +1064,9 @@ module Google # Permanently deletes a specified table and all of its data. # @param [String] name - # The unique name of the table to be deleted. + # Required. The unique name of the table to be deleted. # Values are of the form - # `projects//instances//tables/
`. + # `projects/`project`/instances/`instance`/tables/`table``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1058,9 +1098,9 @@ module Google # specify whether to delete all rows in a table, or only those that match a # particular prefix. # @param [String] name - # The unique name of the table on which to drop a range of rows. + # Required. The unique name of the table on which to drop a range of rows. # Values are of the form - # `projects//instances//tables/
`. + # `projects/`project`/instances/`instance`/tables/`table``. # @param [Google::Apis::BigtableadminV2::DropRowRangeRequest] drop_row_range_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1096,9 +1136,9 @@ module Google # before this call started have been replicated. The tokens will be available # for 90 days. # @param [String] name - # The unique name of the Table for which to create a consistency token. + # Required. The unique name of the Table for which to create a consistency token. # Values are of the form - # `projects//instances//tables/
`. + # `projects/`project`/instances/`instance`/tables/`table``. # @param [Google::Apis::BigtableadminV2::GenerateConsistencyTokenRequest] generate_consistency_token_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1131,9 +1171,9 @@ module Google # Gets metadata information about the specified table. # @param [String] name - # The unique name of the requested table. + # Required. The unique name of the requested table. # Values are of the form - # `projects//instances//tables/
`. + # `projects/`project`/instances/`instance`/tables/`table``. # @param [String] view # The view to be applied to the returned table's fields. # Defaults to `SCHEMA_VIEW` if unspecified. @@ -1203,8 +1243,8 @@ module Google # Lists all tables served from a specified instance. # @param [String] parent - # The unique name of the instance for which tables should be listed. - # Values are of the form `projects//instances/`. + # Required. The unique name of the instance for which tables should be listed. + # Values are of the form `projects/`project`/instances/`instance``. # @param [Fixnum] page_size # Maximum number of results per page. # A page_size of zero lets the server choose the number of items to return. @@ -1253,9 +1293,9 @@ module Google # returns, but data requests received prior to that point may see a table # where only some modifications have taken effect. # @param [String] name - # The unique name of the table whose families should be modified. + # Required. The unique name of the table whose families should be modified. # Values are of the form - # `projects//instances//tables/
`. + # `projects/`project`/instances/`instance`/tables/`table``. # @param [Google::Apis::BigtableadminV2::ModifyColumnFamiliesRequest] modify_column_families_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/billingbudgets_v1beta1.rb b/generated/google/apis/billingbudgets_v1beta1.rb index dd850d6c4..8787855ce 100644 --- a/generated/google/apis/billingbudgets_v1beta1.rb +++ b/generated/google/apis/billingbudgets_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/billing/docs/how-to/budget-api-overview module BillingbudgetsV1beta1 VERSION = 'V1beta1' - REVISION = '20200308' + REVISION = '20200315' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/billingbudgets_v1beta1/service.rb b/generated/google/apis/billingbudgets_v1beta1/service.rb index 1f1ea16a7..31f8a67eb 100644 --- a/generated/google/apis/billingbudgets_v1beta1/service.rb +++ b/generated/google/apis/billingbudgets_v1beta1/service.rb @@ -117,7 +117,7 @@ module Google # Returns a budget. # WARNING: There are some fields exposed on the Google Cloud Console that - # aren’t available on this API. When reading from the API, you will not + # aren't available on this API. When reading from the API, you will not # see these fields in the return value, though they may have been set # in the Cloud Console. # @param [String] name @@ -152,7 +152,7 @@ module Google # Returns a list of budgets for a billing account. # WARNING: There are some fields exposed on the Google Cloud Console that - # aren’t available on this API. When reading from the API, you will not + # aren't available on this API. When reading from the API, you will not # see these fields in the return value, though they may have been set # in the Cloud Console. # @param [String] parent @@ -196,7 +196,7 @@ module Google # Updates a budget and returns the updated budget. # WARNING: There are some fields exposed on the Google Cloud Console that - # aren’t available on this API. Budget fields that are not exposed in + # aren't available on this API. Budget fields that are not exposed in # this API will not be changed by this method. # @param [String] name # Output only. Resource name of the budget. diff --git a/generated/google/apis/blogger_v2.rb b/generated/google/apis/blogger_v2.rb index 8d1368598..63b4d6fb7 100644 --- a/generated/google/apis/blogger_v2.rb +++ b/generated/google/apis/blogger_v2.rb @@ -18,14 +18,15 @@ require 'google/apis/blogger_v2/representations.rb' module Google module Apis - # Blogger API + # Blogger API v3 # - # API for access to the data within Blogger. + # The Blogger API provides access to posts, comments and pages of a + # Blogger blog. # - # @see https://developers.google.com/blogger/docs/2.0/json/getting_started + # @see https://developers.google.com/blogger/docs/3.0/getting_started module BloggerV2 VERSION = 'V2' - REVISION = '20150422' + REVISION = '20200405' # Manage your Blogger account AUTH_BLOGGER = 'https://www.googleapis.com/auth/blogger' diff --git a/generated/google/apis/blogger_v2/classes.rb b/generated/google/apis/blogger_v2/classes.rb index 8efa49c32..99e5803e4 100644 --- a/generated/google/apis/blogger_v2/classes.rb +++ b/generated/google/apis/blogger_v2/classes.rb @@ -26,6 +26,11 @@ module Google class Blog include Google::Apis::Core::Hashable + # The JSON custom meta-data for the Blog. + # Corresponds to the JSON property `customMetaData` + # @return [String] + attr_accessor :custom_meta_data + # The description of this blog. This is displayed underneath the title. # Corresponds to the JSON property `description` # @return [String] @@ -33,10 +38,10 @@ module Google # The identifier for this resource. # Corresponds to the JSON property `id` - # @return [Fixnum] + # @return [String] attr_accessor :id - # The kind of this entry. Always blogger#blog + # The kind of this entry. Always blogger#blog. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -63,7 +68,7 @@ module Google # RFC 3339 date-time when this blog was published. # Corresponds to the JSON property `published` - # @return [DateTime] + # @return [String] attr_accessor :published # The API REST URL to fetch this resource from. @@ -71,9 +76,14 @@ module Google # @return [String] attr_accessor :self_link + # The status of the blog. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + # RFC 3339 date-time when this blog was last updated. # Corresponds to the JSON property `updated` - # @return [DateTime] + # @return [String] attr_accessor :updated # The URL where this blog is published. @@ -87,6 +97,7 @@ module Google # Update properties of this object def update!(**args) + @custom_meta_data = args[:custom_meta_data] if args.key?(:custom_meta_data) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @@ -96,6 +107,7 @@ module Google @posts = args[:posts] if args.key?(:posts) @published = args[:published] if args.key?(:published) @self_link = args[:self_link] if args.key?(:self_link) + @status = args[:status] if args.key?(:status) @updated = args[:updated] if args.key?(:updated) @url = args[:url] if args.key?(:url) end @@ -160,6 +172,11 @@ module Google class Posts include Google::Apis::Core::Hashable + # The List of Posts for this Blog. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + # The URL of the container for posts in this blog. # Corresponds to the JSON property `selfLink` # @return [String] @@ -176,6 +193,7 @@ module Google # Update properties of this object def update!(**args) + @items = args[:items] if args.key?(:items) @self_link = args[:self_link] if args.key?(:self_link) @total_items = args[:total_items] if args.key?(:total_items) end @@ -186,12 +204,17 @@ module Google class BlogList include Google::Apis::Core::Hashable + # Admin level list of blog per-user information. + # Corresponds to the JSON property `blogUserInfos` + # @return [Array] + attr_accessor :blog_user_infos + # The list of Blogs this user has Authorship or Admin rights over. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The kind of this entity. Always blogger#blogList + # The kind of this entity. Always blogger#blogList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -202,11 +225,94 @@ module Google # Update properties of this object def update!(**args) + @blog_user_infos = args[:blog_user_infos] if args.key?(:blog_user_infos) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) end end + # + class BlogPerUserInfo + include Google::Apis::Core::Hashable + + # ID of the Blog resource. + # Corresponds to the JSON property `blogId` + # @return [String] + attr_accessor :blog_id + + # True if the user has Admin level access to the blog. + # Corresponds to the JSON property `hasAdminAccess` + # @return [Boolean] + attr_accessor :has_admin_access + alias_method :has_admin_access?, :has_admin_access + + # The kind of this entity. Always blogger#blogPerUserInfo. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The Photo Album Key for the user when adding photos to the blog. + # Corresponds to the JSON property `photosAlbumKey` + # @return [String] + attr_accessor :photos_album_key + + # Access permissions that the user has for the blog (ADMIN, AUTHOR, or + # READER). + # Corresponds to the JSON property `role` + # @return [String] + attr_accessor :role + + # ID of the User. + # Corresponds to the JSON property `userId` + # @return [String] + attr_accessor :user_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @blog_id = args[:blog_id] if args.key?(:blog_id) + @has_admin_access = args[:has_admin_access] if args.key?(:has_admin_access) + @kind = args[:kind] if args.key?(:kind) + @photos_album_key = args[:photos_album_key] if args.key?(:photos_album_key) + @role = args[:role] if args.key?(:role) + @user_id = args[:user_id] if args.key?(:user_id) + end + end + + # + class BlogUserInfo + include Google::Apis::Core::Hashable + + # The Blog resource. + # Corresponds to the JSON property `blog` + # @return [Google::Apis::BloggerV2::Blog] + attr_accessor :blog + + # Information about a User for the Blog. + # Corresponds to the JSON property `blog_user_info` + # @return [Google::Apis::BloggerV2::BlogPerUserInfo] + attr_accessor :blog_user_info + + # The kind of this entity. Always blogger#blogUserInfo. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @blog = args[:blog] if args.key?(:blog) + @blog_user_info = args[:blog_user_info] if args.key?(:blog_user_info) + @kind = args[:kind] if args.key?(:kind) + end + end + # class Comment include Google::Apis::Core::Hashable @@ -228,7 +334,7 @@ module Google # The identifier for this resource. # Corresponds to the JSON property `id` - # @return [Fixnum] + # @return [String] attr_accessor :id # Data about the comment this is in reply to. @@ -236,7 +342,7 @@ module Google # @return [Google::Apis::BloggerV2::Comment::InReplyTo] attr_accessor :in_reply_to - # The kind of this entry. Always blogger#comment + # The kind of this entry. Always blogger#comment. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -248,7 +354,7 @@ module Google # RFC 3339 date-time when this comment was published. # Corresponds to the JSON property `published` - # @return [DateTime] + # @return [String] attr_accessor :published # The API REST URL to fetch this resource from. @@ -256,9 +362,14 @@ module Google # @return [String] attr_accessor :self_link + # The status of the comment (only populated for admin users). + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + # RFC 3339 date-time when this comment was last updated. # Corresponds to the JSON property `updated` - # @return [DateTime] + # @return [String] attr_accessor :updated def initialize(**args) @@ -276,6 +387,7 @@ module Google @post = args[:post] if args.key?(:post) @published = args[:published] if args.key?(:published) @self_link = args[:self_link] if args.key?(:self_link) + @status = args[:status] if args.key?(:status) @updated = args[:updated] if args.key?(:updated) end @@ -288,17 +400,17 @@ module Google # @return [String] attr_accessor :display_name - # The identifier of the Comment creator. + # The identifier of the creator. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # The comment creator's avatar. + # The creator's avatar. # Corresponds to the JSON property `image` # @return [Google::Apis::BloggerV2::Comment::Author::Image] attr_accessor :image - # The URL of the Comment creator's Profile page. + # The URL of the creator's Profile page. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -315,11 +427,11 @@ module Google @url = args[:url] if args.key?(:url) end - # The comment creator's avatar. + # The creator's avatar. class Image include Google::Apis::Core::Hashable - # The comment creator's avatar URL. + # The creator's avatar URL. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -341,7 +453,7 @@ module Google # The identifier of the blog containing this comment. # Corresponds to the JSON property `id` - # @return [Fixnum] + # @return [String] attr_accessor :id def initialize(**args) @@ -360,7 +472,7 @@ module Google # The identified of the parent of this comment. # Corresponds to the JSON property `id` - # @return [Fixnum] + # @return [String] attr_accessor :id def initialize(**args) @@ -379,7 +491,7 @@ module Google # The identifier of the post containing this comment. # Corresponds to the JSON property `id` - # @return [Fixnum] + # @return [String] attr_accessor :id def initialize(**args) @@ -397,12 +509,17 @@ module Google class CommentList include Google::Apis::Core::Hashable + # Etag of the response. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + # The List of Comments for a Post. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The kind of this entry. Always blogger#commentList + # The kind of this entry. Always blogger#commentList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -423,6 +540,7 @@ module Google # Update properties of this object def update!(**args) + @etag = args[:etag] if args.key?(:etag) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @@ -449,19 +567,24 @@ module Google # @return [String] attr_accessor :content + # Etag of the resource. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + # The identifier for this resource. # Corresponds to the JSON property `id` - # @return [Fixnum] + # @return [String] attr_accessor :id - # The kind of this entity. Always blogger#page + # The kind of this entity. Always blogger#page. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # RFC 3339 date-time when this Page was published. # Corresponds to the JSON property `published` - # @return [DateTime] + # @return [String] attr_accessor :published # The API REST URL to fetch this resource from. @@ -469,6 +592,11 @@ module Google # @return [String] attr_accessor :self_link + # The status of the page for admin resources (either LIVE or DRAFT). + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + # The title of this entity. This is the name displayed in the Admin user # interface. # Corresponds to the JSON property `title` @@ -477,7 +605,7 @@ module Google # RFC 3339 date-time when this Page was last updated. # Corresponds to the JSON property `updated` - # @return [DateTime] + # @return [String] attr_accessor :updated # The URL that this Page is displayed at. @@ -494,10 +622,12 @@ module Google @author = args[:author] if args.key?(:author) @blog = args[:blog] if args.key?(:blog) @content = args[:content] if args.key?(:content) + @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @published = args[:published] if args.key?(:published) @self_link = args[:self_link] if args.key?(:self_link) + @status = args[:status] if args.key?(:status) @title = args[:title] if args.key?(:title) @updated = args[:updated] if args.key?(:updated) @url = args[:url] if args.key?(:url) @@ -512,17 +642,17 @@ module Google # @return [String] attr_accessor :display_name - # The identifier of the Page creator. + # The identifier of the creator. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # The page author's avatar. + # The creator's avatar. # Corresponds to the JSON property `image` # @return [Google::Apis::BloggerV2::Page::Author::Image] attr_accessor :image - # The URL of the Page creator's Profile page. + # The URL of the creator's Profile page. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -539,11 +669,11 @@ module Google @url = args[:url] if args.key?(:url) end - # The page author's avatar. + # The creator's avatar. class Image include Google::Apis::Core::Hashable - # The page author's avatar URL. + # The creator's avatar URL. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -565,7 +695,7 @@ module Google # The identifier of the blog containing this page. # Corresponds to the JSON property `id` - # @return [Fixnum] + # @return [String] attr_accessor :id def initialize(**args) @@ -583,24 +713,36 @@ module Google class PageList include Google::Apis::Core::Hashable + # Etag of the response. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + # The list of Pages for a Blog. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The kind of this entity. Always blogger#pageList + # The kind of this entity. Always blogger#pageList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind + # Pagination token to fetch the next page, if one exists. + # 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) + @etag = args[:etag] if args.key?(:etag) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end @@ -623,12 +765,27 @@ module Google # @return [String] attr_accessor :content + # The JSON meta-data for the Post. + # Corresponds to the JSON property `customMetaData` + # @return [String] + attr_accessor :custom_meta_data + + # Etag of the resource. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + # The identifier of this Post. # Corresponds to the JSON property `id` - # @return [Fixnum] + # @return [String] attr_accessor :id - # The kind of this entity. Always blogger#post + # Display image for the Post. + # Corresponds to the JSON property `images` + # @return [Array] + attr_accessor :images + + # The kind of this entity. Always blogger#post. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -638,11 +795,21 @@ module Google # @return [Array] attr_accessor :labels + # The location for geotagged posts. + # Corresponds to the JSON property `location` + # @return [Google::Apis::BloggerV2::Post::Location] + attr_accessor :location + # RFC 3339 date-time when this Post was published. # Corresponds to the JSON property `published` - # @return [DateTime] + # @return [String] attr_accessor :published + # Comment control and display setting for readers of this post. + # Corresponds to the JSON property `readerComments` + # @return [String] + attr_accessor :reader_comments + # The container of comments on this Post. # Corresponds to the JSON property `replies` # @return [Google::Apis::BloggerV2::Post::Replies] @@ -653,14 +820,24 @@ module Google # @return [String] attr_accessor :self_link + # Status of the post. Only set for admin-level requests. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + # The title of the Post. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title + # The title link URL, similar to atom's related link. + # Corresponds to the JSON property `titleLink` + # @return [String] + attr_accessor :title_link + # RFC 3339 date-time when this Post was last updated. # Corresponds to the JSON property `updated` - # @return [DateTime] + # @return [String] attr_accessor :updated # The URL where this Post is displayed. @@ -677,13 +854,20 @@ module Google @author = args[:author] if args.key?(:author) @blog = args[:blog] if args.key?(:blog) @content = args[:content] if args.key?(:content) + @custom_meta_data = args[:custom_meta_data] if args.key?(:custom_meta_data) + @etag = args[:etag] if args.key?(:etag) @id = args[:id] if args.key?(:id) + @images = args[:images] if args.key?(:images) @kind = args[:kind] if args.key?(:kind) @labels = args[:labels] if args.key?(:labels) + @location = args[:location] if args.key?(:location) @published = args[:published] if args.key?(:published) + @reader_comments = args[:reader_comments] if args.key?(:reader_comments) @replies = args[:replies] if args.key?(:replies) @self_link = args[:self_link] if args.key?(:self_link) + @status = args[:status] if args.key?(:status) @title = args[:title] if args.key?(:title) + @title_link = args[:title_link] if args.key?(:title_link) @updated = args[:updated] if args.key?(:updated) @url = args[:url] if args.key?(:url) end @@ -697,17 +881,17 @@ module Google # @return [String] attr_accessor :display_name - # The identifier of the Post creator. + # The identifier of the creator. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # The Post author's avatar. + # The creator's avatar. # Corresponds to the JSON property `image` # @return [Google::Apis::BloggerV2::Post::Author::Image] attr_accessor :image - # The URL of the Post creator's Profile page. + # The URL of the creator's Profile page. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -724,11 +908,11 @@ module Google @url = args[:url] if args.key?(:url) end - # The Post author's avatar. + # The creator's avatar. class Image include Google::Apis::Core::Hashable - # The Post author's avatar URL. + # The creator's avatar URL. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -750,7 +934,7 @@ module Google # The identifier of the Blog that contains this Post. # Corresponds to the JSON property `id` - # @return [Fixnum] + # @return [String] attr_accessor :id def initialize(**args) @@ -763,10 +947,71 @@ module Google end end + # + class Image + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @url = args[:url] if args.key?(:url) + end + end + + # The location for geotagged posts. + class Location + include Google::Apis::Core::Hashable + + # Location's latitude. + # Corresponds to the JSON property `lat` + # @return [Float] + attr_accessor :lat + + # Location's longitude. + # Corresponds to the JSON property `lng` + # @return [Float] + attr_accessor :lng + + # Location name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Location's viewport span. Can be used when rendering a map preview. + # Corresponds to the JSON property `span` + # @return [String] + attr_accessor :span + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @lat = args[:lat] if args.key?(:lat) + @lng = args[:lng] if args.key?(:lng) + @name = args[:name] if args.key?(:name) + @span = args[:span] if args.key?(:span) + end + end + # The container of comments on this Post. class Replies include Google::Apis::Core::Hashable + # The List of Comments for this Post. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + # The URL of the comments on this post. # Corresponds to the JSON property `selfLink` # @return [String] @@ -783,6 +1028,7 @@ module Google # Update properties of this object def update!(**args) + @items = args[:items] if args.key?(:items) @self_link = args[:self_link] if args.key?(:self_link) @total_items = args[:total_items] if args.key?(:total_items) end @@ -793,12 +1039,17 @@ module Google class PostList include Google::Apis::Core::Hashable + # Etag of the response. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + # The list of Posts for this Blog. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The kind of this entity. Always blogger#postList + # The kind of this entity. Always blogger#postList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -819,6 +1070,7 @@ module Google # Update properties of this object def update!(**args) + @etag = args[:etag] if args.key?(:etag) @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @@ -842,7 +1094,7 @@ module Google # The timestamp of when this profile was created, in seconds since epoch. # Corresponds to the JSON property `created` - # @return [DateTime] + # @return [String] attr_accessor :created # The display name. @@ -855,7 +1107,7 @@ module Google # @return [String] attr_accessor :id - # The kind of this entity. Always blogger#user + # The kind of this entity. Always blogger#user. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -915,17 +1167,17 @@ module Google class Locale include Google::Apis::Core::Hashable - # The user's country setting. + # The country this blog's locale is set to. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country - # The user's language setting. + # The language this blog is authored in. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language - # The user's language variant setting. + # The language variant this blog is authored in. # Corresponds to the JSON property `variant` # @return [String] attr_accessor :variant diff --git a/generated/google/apis/blogger_v2/representations.rb b/generated/google/apis/blogger_v2/representations.rb index eb98009a3..ce149b0f5 100644 --- a/generated/google/apis/blogger_v2/representations.rb +++ b/generated/google/apis/blogger_v2/representations.rb @@ -52,6 +52,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class BlogPerUserInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BlogUserInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Comment class Representation < Google::Apis::Core::JsonRepresentation; end @@ -145,6 +157,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Image + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Location + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Replies class Representation < Google::Apis::Core::JsonRepresentation; end @@ -181,8 +205,9 @@ module Google class Blog # @private class Representation < Google::Apis::Core::JsonRepresentation + property :custom_meta_data, as: 'customMetaData' property :description, as: 'description' - property :id, :numeric_string => true, as: 'id' + property :id, as: 'id' property :kind, as: 'kind' property :locale, as: 'locale', class: Google::Apis::BloggerV2::Blog::Locale, decorator: Google::Apis::BloggerV2::Blog::Locale::Representation @@ -191,11 +216,10 @@ module Google property :posts, as: 'posts', class: Google::Apis::BloggerV2::Blog::Posts, decorator: Google::Apis::BloggerV2::Blog::Posts::Representation - property :published, as: 'published', type: DateTime - + property :published, as: 'published' property :self_link, as: 'selfLink' - property :updated, as: 'updated', type: DateTime - + property :status, as: 'status' + property :updated, as: 'updated' property :url, as: 'url' end @@ -219,6 +243,8 @@ module Google class Posts # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :items, as: 'items', class: Google::Apis::BloggerV2::Post, decorator: Google::Apis::BloggerV2::Post::Representation + property :self_link, as: 'selfLink' property :total_items, as: 'totalItems' end @@ -228,12 +254,37 @@ module Google class BlogList # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :blog_user_infos, as: 'blogUserInfos', class: Google::Apis::BloggerV2::BlogUserInfo, decorator: Google::Apis::BloggerV2::BlogUserInfo::Representation + collection :items, as: 'items', class: Google::Apis::BloggerV2::Blog, decorator: Google::Apis::BloggerV2::Blog::Representation property :kind, as: 'kind' end end + class BlogPerUserInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :blog_id, as: 'blogId' + property :has_admin_access, as: 'hasAdminAccess' + property :kind, as: 'kind' + property :photos_album_key, as: 'photosAlbumKey' + property :role, as: 'role' + property :user_id, as: 'userId' + end + end + + class BlogUserInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :blog, as: 'blog', class: Google::Apis::BloggerV2::Blog, decorator: Google::Apis::BloggerV2::Blog::Representation + + property :blog_user_info, as: 'blog_user_info', class: Google::Apis::BloggerV2::BlogPerUserInfo, decorator: Google::Apis::BloggerV2::BlogPerUserInfo::Representation + + property :kind, as: 'kind' + end + end + class Comment # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -242,17 +293,16 @@ module Google property :blog, as: 'blog', class: Google::Apis::BloggerV2::Comment::Blog, decorator: Google::Apis::BloggerV2::Comment::Blog::Representation property :content, as: 'content' - property :id, :numeric_string => true, as: 'id' + property :id, as: 'id' property :in_reply_to, as: 'inReplyTo', class: Google::Apis::BloggerV2::Comment::InReplyTo, decorator: Google::Apis::BloggerV2::Comment::InReplyTo::Representation property :kind, as: 'kind' property :post, as: 'post', class: Google::Apis::BloggerV2::Comment::Post, decorator: Google::Apis::BloggerV2::Comment::Post::Representation - property :published, as: 'published', type: DateTime - + property :published, as: 'published' property :self_link, as: 'selfLink' - property :updated, as: 'updated', type: DateTime - + property :status, as: 'status' + property :updated, as: 'updated' end class Author @@ -276,21 +326,21 @@ module Google class Blog # @private class Representation < Google::Apis::Core::JsonRepresentation - property :id, :numeric_string => true, as: 'id' + property :id, as: 'id' end end class InReplyTo # @private class Representation < Google::Apis::Core::JsonRepresentation - property :id, :numeric_string => true, as: 'id' + property :id, as: 'id' end end class Post # @private class Representation < Google::Apis::Core::JsonRepresentation - property :id, :numeric_string => true, as: 'id' + property :id, as: 'id' end end end @@ -298,6 +348,7 @@ module Google class CommentList # @private class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::BloggerV2::Comment, decorator: Google::Apis::BloggerV2::Comment::Representation property :kind, as: 'kind' @@ -314,14 +365,14 @@ module Google property :blog, as: 'blog', class: Google::Apis::BloggerV2::Page::Blog, decorator: Google::Apis::BloggerV2::Page::Blog::Representation property :content, as: 'content' - property :id, :numeric_string => true, as: 'id' + property :etag, as: 'etag' + property :id, as: 'id' property :kind, as: 'kind' - property :published, as: 'published', type: DateTime - + property :published, as: 'published' property :self_link, as: 'selfLink' + property :status, as: 'status' property :title, as: 'title' - property :updated, as: 'updated', type: DateTime - + property :updated, as: 'updated' property :url, as: 'url' end @@ -346,7 +397,7 @@ module Google class Blog # @private class Representation < Google::Apis::Core::JsonRepresentation - property :id, :numeric_string => true, as: 'id' + property :id, as: 'id' end end end @@ -354,9 +405,11 @@ module Google class PageList # @private class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::BloggerV2::Page, decorator: Google::Apis::BloggerV2::Page::Representation property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' end end @@ -368,17 +421,24 @@ module Google property :blog, as: 'blog', class: Google::Apis::BloggerV2::Post::Blog, decorator: Google::Apis::BloggerV2::Post::Blog::Representation property :content, as: 'content' - property :id, :numeric_string => true, as: 'id' + property :custom_meta_data, as: 'customMetaData' + property :etag, as: 'etag' + property :id, as: 'id' + collection :images, as: 'images', class: Google::Apis::BloggerV2::Post::Image, decorator: Google::Apis::BloggerV2::Post::Image::Representation + property :kind, as: 'kind' collection :labels, as: 'labels' - property :published, as: 'published', type: DateTime + property :location, as: 'location', class: Google::Apis::BloggerV2::Post::Location, decorator: Google::Apis::BloggerV2::Post::Location::Representation + property :published, as: 'published' + property :reader_comments, as: 'readerComments' property :replies, as: 'replies', class: Google::Apis::BloggerV2::Post::Replies, decorator: Google::Apis::BloggerV2::Post::Replies::Representation property :self_link, as: 'selfLink' + property :status, as: 'status' property :title, as: 'title' - property :updated, as: 'updated', type: DateTime - + property :title_link, as: 'titleLink' + property :updated, as: 'updated' property :url, as: 'url' end @@ -403,13 +463,32 @@ module Google class Blog # @private class Representation < Google::Apis::Core::JsonRepresentation - property :id, :numeric_string => true, as: 'id' + property :id, as: 'id' + end + end + + class Image + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :url, as: 'url' + end + end + + class Location + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :lat, as: 'lat' + property :lng, as: 'lng' + property :name, as: 'name' + property :span, as: 'span' end end class Replies # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :items, as: 'items', class: Google::Apis::BloggerV2::Comment, decorator: Google::Apis::BloggerV2::Comment::Representation + property :self_link, as: 'selfLink' property :total_items, :numeric_string => true, as: 'totalItems' end @@ -419,6 +498,7 @@ module Google class PostList # @private class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' collection :items, as: 'items', class: Google::Apis::BloggerV2::Post, decorator: Google::Apis::BloggerV2::Post::Representation property :kind, as: 'kind' @@ -433,8 +513,7 @@ module Google property :about, as: 'about' property :blogs, as: 'blogs', class: Google::Apis::BloggerV2::User::Blogs, decorator: Google::Apis::BloggerV2::User::Blogs::Representation - property :created, as: 'created', type: DateTime - + property :created, as: 'created' property :display_name, as: 'displayName' property :id, as: 'id' property :kind, as: 'kind' diff --git a/generated/google/apis/blogger_v2/service.rb b/generated/google/apis/blogger_v2/service.rb index d8bbd5bf3..b7970f2e3 100644 --- a/generated/google/apis/blogger_v2/service.rb +++ b/generated/google/apis/blogger_v2/service.rb @@ -20,9 +20,10 @@ require 'google/apis/errors' module Google module Apis module BloggerV2 - # Blogger API + # Blogger API v3 # - # API for access to the data within Blogger. + # The Blogger API provides access to posts, comments and pages of a + # Blogger blog. # # @example # require 'google/apis/blogger_v2' @@ -30,7 +31,7 @@ module Google # Blogger = Google::Apis::BloggerV2 # Alias the module # service = Blogger::BloggerService.new # - # @see https://developers.google.com/blogger/docs/2.0/json/getting_started + # @see https://developers.google.com/blogger/docs/3.0/getting_started class BloggerService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, @@ -38,29 +39,22 @@ module Google attr_accessor :key # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. attr_accessor :quota_user - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - def initialize - super('https://www.googleapis.com/', 'blogger/v2/') - @batch_path = 'batch/blogger/v2' + super('https://blogger.googleapis.com/', '') + @batch_path = 'batch' end - # Gets one blog by id. + # Gets a blog by id. # @param [String] blog_id - # The ID of the blog to get. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -73,301 +67,23 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_blog(blog_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}', options) + def get_blog(blog_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2/blogs/{blogId}', options) command.response_representation = Google::Apis::BloggerV2::Blog::Representation command.response_class = Google::Apis::BloggerV2::Blog command.params['blogId'] = blog_id unless blog_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Gets one comment by id. - # @param [String] blog_id - # ID of the blog to containing the comment. - # @param [String] post_id - # ID of the post to fetch posts from. - # @param [String] comment_id - # The ID of the comment to get. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::BloggerV2::Comment] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::BloggerV2::Comment] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_comment(blog_id, post_id, comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}/posts/{postId}/comments/{commentId}', options) - command.response_representation = Google::Apis::BloggerV2::Comment::Representation - command.response_class = Google::Apis::BloggerV2::Comment - command.params['blogId'] = blog_id unless blog_id.nil? - command.params['postId'] = post_id unless post_id.nil? - command.params['commentId'] = comment_id unless comment_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves the comments for a blog, possibly filtered. - # @param [String] blog_id - # ID of the blog to fetch comments from. - # @param [String] post_id - # ID of the post to fetch posts from. - # @param [Boolean] fetch_bodies - # Whether the body content of the comments is included. - # @param [Fixnum] max_results - # Maximum number of comments to include in the result. - # @param [String] page_token - # Continuation token if request is paged. - # @param [DateTime] start_date - # Earliest date of comment to fetch, a date-time with RFC 3339 formatting. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::BloggerV2::CommentList] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::BloggerV2::CommentList] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_comments(blog_id, post_id, fetch_bodies: nil, max_results: nil, page_token: nil, start_date: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}/posts/{postId}/comments', options) - command.response_representation = Google::Apis::BloggerV2::CommentList::Representation - command.response_class = Google::Apis::BloggerV2::CommentList - command.params['blogId'] = blog_id unless blog_id.nil? - command.params['postId'] = post_id unless post_id.nil? - command.query['fetchBodies'] = fetch_bodies unless fetch_bodies.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['startDate'] = start_date unless start_date.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Gets one blog page by id. - # @param [String] blog_id - # ID of the blog containing the page. - # @param [String] page_id - # The ID of the page to get. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::BloggerV2::Page] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::BloggerV2::Page] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_page(blog_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}/pages/{pageId}', options) - command.response_representation = Google::Apis::BloggerV2::Page::Representation - command.response_class = Google::Apis::BloggerV2::Page - command.params['blogId'] = blog_id unless blog_id.nil? - command.params['pageId'] = page_id unless page_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves pages for a blog, possibly filtered. - # @param [String] blog_id - # ID of the blog to fetch pages from. - # @param [Boolean] fetch_bodies - # Whether to retrieve the Page bodies. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::BloggerV2::PageList] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::BloggerV2::PageList] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_pages(blog_id, fetch_bodies: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}/pages', options) - command.response_representation = Google::Apis::BloggerV2::PageList::Representation - command.response_class = Google::Apis::BloggerV2::PageList - command.params['blogId'] = blog_id unless blog_id.nil? - command.query['fetchBodies'] = fetch_bodies unless fetch_bodies.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Get a post by id. - # @param [String] blog_id - # ID of the blog to fetch the post from. - # @param [String] post_id - # The ID of the post - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::BloggerV2::Post] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::BloggerV2::Post] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_post(blog_id, post_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}/posts/{postId}', options) - command.response_representation = Google::Apis::BloggerV2::Post::Representation - command.response_class = Google::Apis::BloggerV2::Post - command.params['blogId'] = blog_id unless blog_id.nil? - command.params['postId'] = post_id unless post_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves a list of posts, possibly filtered. - # @param [String] blog_id - # ID of the blog to fetch posts from. - # @param [Boolean] fetch_bodies - # Whether the body content of posts is included. - # @param [Fixnum] max_results - # Maximum number of posts to fetch. - # @param [String] page_token - # Continuation token if the request is paged. - # @param [DateTime] start_date - # Earliest post date to fetch, a date-time with RFC 3339 formatting. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::BloggerV2::PostList] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::BloggerV2::PostList] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_posts(blog_id, fetch_bodies: nil, max_results: nil, page_token: nil, start_date: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}/posts', options) - command.response_representation = Google::Apis::BloggerV2::PostList::Representation - command.response_class = Google::Apis::BloggerV2::PostList - command.params['blogId'] = blog_id unless blog_id.nil? - command.query['fetchBodies'] = fetch_bodies unless fetch_bodies.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['startDate'] = start_date unless start_date.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Gets one user by id. + # Lists blogs by user id, possibly filtered. # @param [String] user_id - # The ID of the user to get. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::BloggerV2::User] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::BloggerV2::User] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userId}', options) - command.response_representation = Google::Apis::BloggerV2::User::Representation - command.response_class = Google::Apis::BloggerV2::User - command.params['userId'] = user_id unless user_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves a list of blogs, possibly filtered. - # @param [String] user_id - # ID of the user whose blogs are to be fetched. Either the word 'self' (sans - # quote marks) or the user's profile identifier. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -380,14 +96,244 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_user_blogs(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userId}/blogs', options) + def list_blogs(user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2/users/{userId}/blogs', options) command.response_representation = Google::Apis::BloggerV2::BlogList::Representation command.response_class = Google::Apis::BloggerV2::BlogList command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets a comment by blog id, post id and comment id. + # @param [String] blog_id + # @param [String] post_id + # @param [String] comment_id + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BloggerV2::Comment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BloggerV2::Comment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_comment(blog_id, post_id, comment_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2/blogs/{blogId}/posts/{postId}/comments/{commentId}', options) + command.response_representation = Google::Apis::BloggerV2::Comment::Representation + command.response_class = Google::Apis::BloggerV2::Comment + command.params['blogId'] = blog_id unless blog_id.nil? + command.params['postId'] = post_id unless post_id.nil? + command.params['commentId'] = comment_id unless comment_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists comments. + # @param [String] blog_id + # @param [String] post_id + # @param [Boolean] fetch_bodies + # @param [Fixnum] max_results + # @param [String] page_token + # @param [String] start_date + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BloggerV2::CommentList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BloggerV2::CommentList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_comments(blog_id, post_id, fetch_bodies: nil, max_results: nil, page_token: nil, start_date: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2/blogs/{blogId}/posts/{postId}/comments', options) + command.response_representation = Google::Apis::BloggerV2::CommentList::Representation + command.response_class = Google::Apis::BloggerV2::CommentList + command.params['blogId'] = blog_id unless blog_id.nil? + command.params['postId'] = post_id unless post_id.nil? + command.query['fetchBodies'] = fetch_bodies unless fetch_bodies.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['startDate'] = start_date unless start_date.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a page by blog id and page id. + # @param [String] blog_id + # @param [String] page_id + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BloggerV2::Page] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BloggerV2::Page] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_page(blog_id, page_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2/blogs/{blogId}/pages/{pageId}', options) + command.response_representation = Google::Apis::BloggerV2::Page::Representation + command.response_class = Google::Apis::BloggerV2::Page + command.params['blogId'] = blog_id unless blog_id.nil? + command.params['pageId'] = page_id unless page_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists pages. + # @param [String] blog_id + # @param [Boolean] fetch_bodies + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BloggerV2::PageList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BloggerV2::PageList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_pages(blog_id, fetch_bodies: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2/blogs/{blogId}/pages', options) + command.response_representation = Google::Apis::BloggerV2::PageList::Representation + command.response_class = Google::Apis::BloggerV2::PageList + command.params['blogId'] = blog_id unless blog_id.nil? + command.query['fetchBodies'] = fetch_bodies unless fetch_bodies.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a post by blog id and post id + # @param [String] blog_id + # @param [String] post_id + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BloggerV2::Post] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BloggerV2::Post] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_post(blog_id, post_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2/blogs/{blogId}/posts/{postId}', options) + command.response_representation = Google::Apis::BloggerV2::Post::Representation + command.response_class = Google::Apis::BloggerV2::Post + command.params['blogId'] = blog_id unless blog_id.nil? + command.params['postId'] = post_id unless post_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists posts. + # @param [String] blog_id + # @param [Boolean] fetch_bodies + # @param [Fixnum] max_results + # @param [String] page_token + # @param [String] start_date + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BloggerV2::PostList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BloggerV2::PostList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_posts(blog_id, fetch_bodies: nil, max_results: nil, page_token: nil, start_date: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2/blogs/{blogId}/posts', options) + command.response_representation = Google::Apis::BloggerV2::PostList::Representation + command.response_class = Google::Apis::BloggerV2::PostList + command.params['blogId'] = blog_id unless blog_id.nil? + command.query['fetchBodies'] = fetch_bodies unless fetch_bodies.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['startDate'] = start_date unless start_date.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a user by user id. + # @param [String] user_id + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::BloggerV2::User] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::BloggerV2::User] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_user(user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2/users/{userId}', options) + command.response_representation = Google::Apis::BloggerV2::User::Representation + command.response_class = Google::Apis::BloggerV2::User + command.params['userId'] = user_id unless user_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end @@ -396,7 +342,6 @@ module Google def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? end end end diff --git a/generated/google/apis/blogger_v3.rb b/generated/google/apis/blogger_v3.rb index ab59a1bfc..d01082fd8 100644 --- a/generated/google/apis/blogger_v3.rb +++ b/generated/google/apis/blogger_v3.rb @@ -18,14 +18,15 @@ require 'google/apis/blogger_v3/representations.rb' module Google module Apis - # Blogger API + # Blogger API v3 # - # API for access to the data within Blogger. + # The Blogger API provides access to posts, comments and pages of a + # Blogger blog. # # @see https://developers.google.com/blogger/docs/3.0/getting_started module BloggerV3 VERSION = 'V3' - REVISION = '20190917' + REVISION = '20200409' # Manage your Blogger account AUTH_BLOGGER = 'https://www.googleapis.com/auth/blogger' diff --git a/generated/google/apis/blogger_v3/classes.rb b/generated/google/apis/blogger_v3/classes.rb index 7fab7c08a..1c06a7357 100644 --- a/generated/google/apis/blogger_v3/classes.rb +++ b/generated/google/apis/blogger_v3/classes.rb @@ -26,7 +26,7 @@ module Google class Blog include Google::Apis::Core::Hashable - # The JSON custom meta-data for the Blog + # The JSON custom meta-data for the Blog. # Corresponds to the JSON property `customMetaData` # @return [String] attr_accessor :custom_meta_data @@ -41,7 +41,7 @@ module Google # @return [String] attr_accessor :id - # The kind of this entry. Always blogger#blog + # The kind of this entry. Always blogger#blog. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -68,7 +68,7 @@ module Google # RFC 3339 date-time when this blog was published. # Corresponds to the JSON property `published` - # @return [DateTime] + # @return [String] attr_accessor :published # The API REST URL to fetch this resource from. @@ -83,7 +83,7 @@ module Google # RFC 3339 date-time when this blog was last updated. # Corresponds to the JSON property `updated` - # @return [DateTime] + # @return [String] attr_accessor :updated # The URL where this blog is published. @@ -204,7 +204,7 @@ module Google class BlogList include Google::Apis::Core::Hashable - # Admin level list of blog per-user information + # Admin level list of blog per-user information. # Corresponds to the JSON property `blogUserInfos` # @return [Array] attr_accessor :blog_user_infos @@ -214,7 +214,7 @@ module Google # @return [Array] attr_accessor :items - # The kind of this entity. Always blogger#blogList + # The kind of this entity. Always blogger#blogList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -235,7 +235,7 @@ module Google class BlogPerUserInfo include Google::Apis::Core::Hashable - # ID of the Blog resource + # ID of the Blog resource. # Corresponds to the JSON property `blogId` # @return [String] attr_accessor :blog_id @@ -246,22 +246,23 @@ module Google attr_accessor :has_admin_access alias_method :has_admin_access?, :has_admin_access - # The kind of this entity. Always blogger#blogPerUserInfo + # The kind of this entity. Always blogger#blogPerUserInfo. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The Photo Album Key for the user when adding photos to the blog + # The Photo Album Key for the user when adding photos to the blog. # Corresponds to the JSON property `photosAlbumKey` # @return [String] attr_accessor :photos_album_key - # Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER). + # Access permissions that the user has for the blog (ADMIN, AUTHOR, or + # READER). # Corresponds to the JSON property `role` # @return [String] attr_accessor :role - # ID of the User + # ID of the User. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id @@ -295,7 +296,7 @@ module Google # @return [Google::Apis::BloggerV3::BlogPerUserInfo] attr_accessor :blog_user_info - # The kind of this entity. Always blogger#blogUserInfo + # The kind of this entity. Always blogger#blogUserInfo. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -341,7 +342,7 @@ module Google # @return [Google::Apis::BloggerV3::Comment::InReplyTo] attr_accessor :in_reply_to - # The kind of this entry. Always blogger#comment + # The kind of this entry. Always blogger#comment. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -353,7 +354,7 @@ module Google # RFC 3339 date-time when this comment was published. # Corresponds to the JSON property `published` - # @return [DateTime] + # @return [String] attr_accessor :published # The API REST URL to fetch this resource from. @@ -361,14 +362,14 @@ module Google # @return [String] attr_accessor :self_link - # The status of the comment (only populated for admin users) + # The status of the comment (only populated for admin users). # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # RFC 3339 date-time when this comment was last updated. # Corresponds to the JSON property `updated` - # @return [DateTime] + # @return [String] attr_accessor :updated def initialize(**args) @@ -399,17 +400,17 @@ module Google # @return [String] attr_accessor :display_name - # The identifier of the Comment creator. + # The identifier of the creator. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # The comment creator's avatar. + # The creator's avatar. # Corresponds to the JSON property `image` # @return [Google::Apis::BloggerV3::Comment::Author::Image] attr_accessor :image - # The URL of the Comment creator's Profile page. + # The URL of the creator's Profile page. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -426,11 +427,11 @@ module Google @url = args[:url] if args.key?(:url) end - # The comment creator's avatar. + # The creator's avatar. class Image include Google::Apis::Core::Hashable - # The comment creator's avatar URL. + # The creator's avatar URL. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -518,7 +519,7 @@ module Google # @return [Array] attr_accessor :items - # The kind of this entry. Always blogger#commentList + # The kind of this entry. Always blogger#commentList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -576,14 +577,14 @@ module Google # @return [String] attr_accessor :id - # The kind of this entity. Always blogger#page + # The kind of this entity. Always blogger#page. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # RFC 3339 date-time when this Page was published. # Corresponds to the JSON property `published` - # @return [DateTime] + # @return [String] attr_accessor :published # The API REST URL to fetch this resource from. @@ -604,7 +605,7 @@ module Google # RFC 3339 date-time when this Page was last updated. # Corresponds to the JSON property `updated` - # @return [DateTime] + # @return [String] attr_accessor :updated # The URL that this Page is displayed at. @@ -641,17 +642,17 @@ module Google # @return [String] attr_accessor :display_name - # The identifier of the Page creator. + # The identifier of the creator. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # The page author's avatar. + # The creator's avatar. # Corresponds to the JSON property `image` # @return [Google::Apis::BloggerV3::Page::Author::Image] attr_accessor :image - # The URL of the Page creator's Profile page. + # The URL of the creator's Profile page. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -668,11 +669,11 @@ module Google @url = args[:url] if args.key?(:url) end - # The page author's avatar. + # The creator's avatar. class Image include Google::Apis::Core::Hashable - # The page author's avatar URL. + # The creator's avatar URL. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -722,7 +723,7 @@ module Google # @return [Array] attr_accessor :items - # The kind of this entity. Always blogger#pageList + # The kind of this entity. Always blogger#pageList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -749,7 +750,7 @@ module Google class Pageviews include Google::Apis::Core::Hashable - # Blog Id + # Blog Id. # Corresponds to the JSON property `blogId` # @return [String] attr_accessor :blog_id @@ -759,7 +760,7 @@ module Google # @return [Array] attr_accessor :counts - # The kind of this entry. Always blogger#page_views + # The kind of this entry. Always blogger#page_views. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -779,12 +780,12 @@ module Google class Count include Google::Apis::Core::Hashable - # Count of page views for the given time range + # Count of page views for the given time range. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count - # Time range the given count applies to + # Time range the given count applies to. # Corresponds to the JSON property `timeRange` # @return [String] attr_accessor :time_range @@ -840,7 +841,7 @@ module Google # @return [Array] attr_accessor :images - # The kind of this entity. Always blogger#post + # The kind of this entity. Always blogger#post. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -857,7 +858,7 @@ module Google # RFC 3339 date-time when this Post was published. # Corresponds to the JSON property `published` - # @return [DateTime] + # @return [String] attr_accessor :published # Comment control and display setting for readers of this post. @@ -875,7 +876,7 @@ module Google # @return [String] attr_accessor :self_link - # Status of the post. Only set for admin-level requests + # Status of the post. Only set for admin-level requests. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -892,7 +893,7 @@ module Google # RFC 3339 date-time when this Post was last updated. # Corresponds to the JSON property `updated` - # @return [DateTime] + # @return [String] attr_accessor :updated # The URL where this Post is displayed. @@ -936,17 +937,17 @@ module Google # @return [String] attr_accessor :display_name - # The identifier of the Post creator. + # The identifier of the creator. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # The Post author's avatar. + # The creator's avatar. # Corresponds to the JSON property `image` # @return [Google::Apis::BloggerV3::Post::Author::Image] attr_accessor :image - # The URL of the Post creator's Profile page. + # The URL of the creator's Profile page. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -963,11 +964,11 @@ module Google @url = args[:url] if args.key?(:url) end - # The Post author's avatar. + # The creator's avatar. class Image include Google::Apis::Core::Hashable - # The Post author's avatar URL. + # The creator's avatar URL. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -1104,7 +1105,7 @@ module Google # @return [Array] attr_accessor :items - # The kind of this entity. Always blogger#postList + # The kind of this entity. Always blogger#postList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1114,6 +1115,11 @@ module Google # @return [String] attr_accessor :next_page_token + # Pagination token to fetch the previous page, if one exists. + # Corresponds to the JSON property `prevPageToken` + # @return [String] + attr_accessor :prev_page_token + def initialize(**args) update!(**args) end @@ -1124,6 +1130,7 @@ module Google @items = args[:items] if args.key?(:items) @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @prev_page_token = args[:prev_page_token] if args.key?(:prev_page_token) end end @@ -1142,7 +1149,7 @@ module Google attr_accessor :has_edit_access alias_method :has_edit_access?, :has_edit_access - # The kind of this entity. Always blogger#postPerUserInfo + # The kind of this entity. Always blogger#postPerUserInfo. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1175,7 +1182,7 @@ module Google class PostUserInfo include Google::Apis::Core::Hashable - # The kind of this entity. Always blogger#postUserInfo + # The kind of this entity. Always blogger#postUserInfo. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1211,7 +1218,7 @@ module Google # @return [Array] attr_accessor :items - # The kind of this entity. Always blogger#postList + # The kind of this entity. Always blogger#postList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1249,7 +1256,7 @@ module Google # The timestamp of when this profile was created, in seconds since epoch. # Corresponds to the JSON property `created` - # @return [DateTime] + # @return [String] attr_accessor :created # The display name. @@ -1262,7 +1269,7 @@ module Google # @return [String] attr_accessor :id - # The kind of this entity. Always blogger#user + # The kind of this entity. Always blogger#user. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1322,17 +1329,17 @@ module Google class Locale include Google::Apis::Core::Hashable - # The user's country setting. + # The country this blog's locale is set to. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country - # The user's language setting. + # The language this blog is authored in. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language - # The user's language variant setting. + # The language variant this blog is authored in. # Corresponds to the JSON property `variant` # @return [String] attr_accessor :variant diff --git a/generated/google/apis/blogger_v3/representations.rb b/generated/google/apis/blogger_v3/representations.rb index a335b535b..c4355acec 100644 --- a/generated/google/apis/blogger_v3/representations.rb +++ b/generated/google/apis/blogger_v3/representations.rb @@ -246,12 +246,10 @@ module Google property :posts, as: 'posts', class: Google::Apis::BloggerV3::Blog::Posts, decorator: Google::Apis::BloggerV3::Blog::Posts::Representation - property :published, as: 'published', type: DateTime - + property :published, as: 'published' property :self_link, as: 'selfLink' property :status, as: 'status' - property :updated, as: 'updated', type: DateTime - + property :updated, as: 'updated' property :url, as: 'url' end @@ -331,12 +329,10 @@ module Google property :kind, as: 'kind' property :post, as: 'post', class: Google::Apis::BloggerV3::Comment::Post, decorator: Google::Apis::BloggerV3::Comment::Post::Representation - property :published, as: 'published', type: DateTime - + property :published, as: 'published' property :self_link, as: 'selfLink' property :status, as: 'status' - property :updated, as: 'updated', type: DateTime - + property :updated, as: 'updated' end class Author @@ -402,13 +398,11 @@ module Google property :etag, as: 'etag' property :id, as: 'id' property :kind, as: 'kind' - property :published, as: 'published', type: DateTime - + property :published, as: 'published' property :self_link, as: 'selfLink' property :status, as: 'status' property :title, as: 'title' - property :updated, as: 'updated', type: DateTime - + property :updated, as: 'updated' property :url, as: 'url' end @@ -484,8 +478,7 @@ module Google collection :labels, as: 'labels' property :location, as: 'location', class: Google::Apis::BloggerV3::Post::Location, decorator: Google::Apis::BloggerV3::Post::Location::Representation - property :published, as: 'published', type: DateTime - + property :published, as: 'published' property :reader_comments, as: 'readerComments' property :replies, as: 'replies', class: Google::Apis::BloggerV3::Post::Replies, decorator: Google::Apis::BloggerV3::Post::Replies::Representation @@ -493,8 +486,7 @@ module Google property :status, as: 'status' property :title, as: 'title' property :title_link, as: 'titleLink' - property :updated, as: 'updated', type: DateTime - + property :updated, as: 'updated' property :url, as: 'url' end @@ -559,6 +551,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' + property :prev_page_token, as: 'prevPageToken' end end @@ -600,8 +593,7 @@ module Google property :about, as: 'about' property :blogs, as: 'blogs', class: Google::Apis::BloggerV3::User::Blogs, decorator: Google::Apis::BloggerV3::User::Blogs::Representation - property :created, as: 'created', type: DateTime - + property :created, as: 'created' property :display_name, as: 'displayName' property :id, as: 'id' property :kind, as: 'kind' diff --git a/generated/google/apis/blogger_v3/service.rb b/generated/google/apis/blogger_v3/service.rb index c1b6b0d2c..0124b1491 100644 --- a/generated/google/apis/blogger_v3/service.rb +++ b/generated/google/apis/blogger_v3/service.rb @@ -20,9 +20,10 @@ require 'google/apis/errors' module Google module Apis module BloggerV3 - # Blogger API + # Blogger API v3 # - # API for access to the data within Blogger. + # The Blogger API provides access to posts, comments and pages of a + # Blogger blog. # # @example # require 'google/apis/blogger_v3' @@ -38,34 +39,24 @@ module Google attr_accessor :key # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. attr_accessor :quota_user - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - def initialize - super('https://www.googleapis.com/', 'blogger/v3/') - @batch_path = 'batch/blogger/v3' + super('https://blogger.googleapis.com/', '') + @batch_path = 'batch' end - # Gets one blog and user info pair by blogId and userId. + # Gets one blog and user info pair by blog id and user id. # @param [String] user_id - # ID of the user whose blogs are to be fetched. Either the word 'self' or the - # user's profile identifier. # @param [String] blog_id - # The ID of the blog to get. # @param [Fixnum] max_posts - # Maximum number of posts to pull back with the blog. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -78,8 +69,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_blog_user_info(user_id, blog_id, max_posts: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userId}/blogs/{blogId}', options) + def get_blog_user_info(user_id, blog_id, max_posts: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/users/{userId}/blogs/{blogId}', options) command.response_representation = Google::Apis::BloggerV3::BlogUserInfo::Representation command.response_class = Google::Apis::BloggerV3::BlogUserInfo command.params['userId'] = user_id unless user_id.nil? @@ -87,25 +78,18 @@ module Google command.query['maxPosts'] = max_posts unless max_posts.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Gets one blog by ID. + # Gets a blog by id. # @param [String] blog_id - # The ID of the blog to get. # @param [Fixnum] max_posts - # Maximum number of posts to pull back with the blog. # @param [String] view - # Access level with which to view the blog. Note that some fields require - # elevated access. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -118,8 +102,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_blog(blog_id, max_posts: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}', options) + def get_blog(blog_id, max_posts: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/blogs/{blogId}', options) command.response_representation = Google::Apis::BloggerV3::Blog::Representation command.response_class = Google::Apis::BloggerV3::Blog command.params['blogId'] = blog_id unless blog_id.nil? @@ -127,23 +111,17 @@ module Google command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Retrieve a Blog by URL. + # Gets a blog by url. # @param [String] url - # The URL of the blog to retrieve. # @param [String] view - # Access level with which to view the blog. Note that some fields require - # elevated access. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -156,42 +134,29 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_blog_by_url(url, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/byurl', options) + def get_blog_by_url(url, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/blogs/byurl', options) command.response_representation = Google::Apis::BloggerV3::Blog::Representation command.response_class = Google::Apis::BloggerV3::Blog command.query['url'] = url unless url.nil? command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Retrieves a list of blogs, possibly filtered. + # Lists blogs by user. # @param [String] user_id - # ID of the user whose blogs are to be fetched. Either the word 'self' or the - # user's profile identifier. # @param [Boolean] fetch_user_info - # Whether the response is a list of blogs with per-user information instead of - # just blogs. # @param [Array, String] role - # User access types for blogs to include in the results, e.g. AUTHOR will return - # blogs where the user has author level access. If no roles are specified, - # defaults to ADMIN and AUTHOR roles. # @param [Array, String] status - # Blog statuses to include in the result (default: Live blogs only). Note that - # ADMIN access is required to view deleted blogs. + # Default value of status is LIVE. # @param [String] view - # Access level with which to view the blogs. Note that some fields require - # elevated access. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -204,8 +169,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_blogs_by_user(user_id, fetch_user_info: nil, role: nil, status: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userId}/blogs', options) + def list_blogs_by_user(user_id, fetch_user_info: nil, role: nil, status: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/users/{userId}/blogs', options) command.response_representation = Google::Apis::BloggerV3::BlogList::Representation command.response_class = Google::Apis::BloggerV3::BlogList command.params['userId'] = user_id unless user_id.nil? @@ -215,24 +180,18 @@ module Google command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Marks a comment as not spam. + # Marks a comment as not spam by blog id, post id and comment id. # @param [String] blog_id - # The ID of the Blog. # @param [String] post_id - # The ID of the Post. # @param [String] comment_id - # The ID of the comment to mark as not spam. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -245,8 +204,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def approve_comment(blog_id, post_id, comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'blogs/{blogId}/posts/{postId}/comments/{commentId}/approve', options) + def approve_comment(blog_id, post_id, comment_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/approve', options) command.response_representation = Google::Apis::BloggerV3::Comment::Representation command.response_class = Google::Apis::BloggerV3::Comment command.params['blogId'] = blog_id unless blog_id.nil? @@ -254,24 +213,18 @@ module Google command.params['commentId'] = comment_id unless comment_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Delete a comment by ID. + # Deletes a comment by blog id, post id and comment id. # @param [String] blog_id - # The ID of the Blog. # @param [String] post_id - # The ID of the Post. # @param [String] comment_id - # The ID of the comment to delete. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -284,36 +237,26 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_comment(blog_id, post_id, comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'blogs/{blogId}/posts/{postId}/comments/{commentId}', options) + def delete_comment(blog_id, post_id, comment_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v3/blogs/{blogId}/posts/{postId}/comments/{commentId}', options) command.params['blogId'] = blog_id unless blog_id.nil? command.params['postId'] = post_id unless post_id.nil? command.params['commentId'] = comment_id unless comment_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Gets one comment by ID. + # Gets a comment by id. # @param [String] blog_id - # ID of the blog to containing the comment. # @param [String] post_id - # ID of the post to fetch posts from. # @param [String] comment_id - # The ID of the comment to get. # @param [String] view - # Access level for the requested comment (default: READER). Note that some - # comments will require elevated permissions, for example comments where the - # parent posts which is in a draft state, or comments that are pending - # moderation. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -326,8 +269,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_comment(blog_id, post_id, comment_id, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}/posts/{postId}/comments/{commentId}', options) + def get_comment(blog_id, post_id, comment_id, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/blogs/{blogId}/posts/{postId}/comments/{commentId}', options) command.response_representation = Google::Apis::BloggerV3::Comment::Representation command.response_class = Google::Apis::BloggerV3::Comment command.params['blogId'] = blog_id unless blog_id.nil? @@ -336,36 +279,24 @@ module Google command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Retrieves the comments for a post, possibly filtered. + # Lists comments. # @param [String] blog_id - # ID of the blog to fetch comments from. # @param [String] post_id - # ID of the post to fetch posts from. - # @param [DateTime] end_date - # Latest date of comment to fetch, a date-time with RFC 3339 formatting. + # @param [String] end_date # @param [Boolean] fetch_bodies - # Whether the body content of the comments is included. # @param [Fixnum] max_results - # Maximum number of comments to include in the result. # @param [String] page_token - # Continuation token if request is paged. - # @param [DateTime] start_date - # Earliest date of comment to fetch, a date-time with RFC 3339 formatting. - # @param [Array, String] status + # @param [String] start_date + # @param [String] status # @param [String] view - # Access level with which to view the returned result. Note that some fields - # require elevated access. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -378,8 +309,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_comments(blog_id, post_id, end_date: nil, fetch_bodies: nil, max_results: nil, page_token: nil, start_date: nil, status: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}/posts/{postId}/comments', options) + def list_comments(blog_id, post_id, end_date: nil, fetch_bodies: nil, max_results: nil, page_token: nil, start_date: nil, status: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/blogs/{blogId}/posts/{postId}/comments', options) command.response_representation = Google::Apis::BloggerV3::CommentList::Representation command.response_class = Google::Apis::BloggerV3::CommentList command.params['blogId'] = blog_id unless blog_id.nil? @@ -393,31 +324,22 @@ module Google command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Retrieves the comments for a blog, across all posts, possibly filtered. + # Lists comments by blog. # @param [String] blog_id - # ID of the blog to fetch comments from. - # @param [DateTime] end_date - # Latest date of comment to fetch, a date-time with RFC 3339 formatting. + # @param [String] end_date # @param [Boolean] fetch_bodies - # Whether the body content of the comments is included. # @param [Fixnum] max_results - # Maximum number of comments to include in the result. # @param [String] page_token - # Continuation token if request is paged. - # @param [DateTime] start_date - # Earliest date of comment to fetch, a date-time with RFC 3339 formatting. + # @param [String] start_date # @param [Array, String] status # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -430,8 +352,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_comments_by_blog(blog_id, end_date: nil, fetch_bodies: nil, max_results: nil, page_token: nil, start_date: nil, status: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}/comments', options) + def list_comments_by_blog(blog_id, end_date: nil, fetch_bodies: nil, max_results: nil, page_token: nil, start_date: nil, status: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/blogs/{blogId}/comments', options) command.response_representation = Google::Apis::BloggerV3::CommentList::Representation command.response_class = Google::Apis::BloggerV3::CommentList command.params['blogId'] = blog_id unless blog_id.nil? @@ -443,24 +365,18 @@ module Google command.query['status'] = status unless status.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Marks a comment as spam. + # Marks a comment as spam by blog id, post id and comment id. # @param [String] blog_id - # The ID of the Blog. # @param [String] post_id - # The ID of the Post. # @param [String] comment_id - # The ID of the comment to mark as spam. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -473,8 +389,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def mark_comment_as_spam(blog_id, post_id, comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'blogs/{blogId}/posts/{postId}/comments/{commentId}/spam', options) + def mark_comment_as_spam(blog_id, post_id, comment_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/spam', options) command.response_representation = Google::Apis::BloggerV3::Comment::Representation command.response_class = Google::Apis::BloggerV3::Comment command.params['blogId'] = blog_id unless blog_id.nil? @@ -482,24 +398,18 @@ module Google command.params['commentId'] = comment_id unless comment_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Removes the content of a comment. + # Removes the content of a comment by blog id, post id and comment id. # @param [String] blog_id - # The ID of the Blog. # @param [String] post_id - # The ID of the Post. # @param [String] comment_id - # The ID of the comment to delete content from. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -512,8 +422,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def remove_comment_content(blog_id, post_id, comment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'blogs/{blogId}/posts/{postId}/comments/{commentId}/removecontent', options) + def remove_comment_content(blog_id, post_id, comment_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/removecontent', options) command.response_representation = Google::Apis::BloggerV3::Comment::Representation command.response_class = Google::Apis::BloggerV3::Comment command.params['blogId'] = blog_id unless blog_id.nil? @@ -521,21 +431,17 @@ module Google command.params['commentId'] = comment_id unless comment_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Retrieve pageview stats for a Blog. + # Gets page views by blog id. # @param [String] blog_id - # The ID of the blog to get. # @param [Array, String] range # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -548,30 +454,25 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_page_view(blog_id, range: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}/pageviews', options) + def get_page_view(blog_id, range: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/blogs/{blogId}/pageviews', options) command.response_representation = Google::Apis::BloggerV3::Pageviews::Representation command.response_class = Google::Apis::BloggerV3::Pageviews command.params['blogId'] = blog_id unless blog_id.nil? command.query['range'] = range unless range.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Delete a page by ID. + # Deletes a page by blog id and page id. # @param [String] blog_id - # The ID of the Blog. # @param [String] page_id - # The ID of the Page. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -584,29 +485,24 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_page(blog_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'blogs/{blogId}/pages/{pageId}', options) + def delete_page(blog_id, page_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v3/blogs/{blogId}/pages/{pageId}', options) command.params['blogId'] = blog_id unless blog_id.nil? command.params['pageId'] = page_id unless page_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Gets one blog page by ID. + # Gets a page by blog id and page id. # @param [String] blog_id - # ID of the blog containing the page. # @param [String] page_id - # The ID of the page to get. # @param [String] view # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -619,8 +515,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_page(blog_id, page_id, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}/pages/{pageId}', options) + def get_page(blog_id, page_id, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/blogs/{blogId}/pages/{pageId}', options) command.response_representation = Google::Apis::BloggerV3::Page::Representation command.response_class = Google::Apis::BloggerV3::Page command.params['blogId'] = blog_id unless blog_id.nil? @@ -628,23 +524,18 @@ module Google command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Add a page. + # Inserts a page. # @param [String] blog_id - # ID of the blog to add the page to. # @param [Google::Apis::BloggerV3::Page] page_object # @param [Boolean] is_draft - # Whether to create the page as a draft (default: false). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -657,8 +548,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_page(blog_id, page_object = nil, is_draft: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'blogs/{blogId}/pages', options) + def insert_page(blog_id, page_object = nil, is_draft: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v3/blogs/{blogId}/pages', options) command.request_representation = Google::Apis::BloggerV3::Page::Representation command.request_object = page_object command.response_representation = Google::Apis::BloggerV3::Page::Representation @@ -667,30 +558,21 @@ module Google command.query['isDraft'] = is_draft unless is_draft.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Retrieves the pages for a blog, optionally including non-LIVE statuses. + # Lists pages. # @param [String] blog_id - # ID of the blog to fetch Pages from. # @param [Boolean] fetch_bodies - # Whether to retrieve the Page bodies. # @param [Fixnum] max_results - # Maximum number of Pages to fetch. # @param [String] page_token - # Continuation token if the request is paged. # @param [Array, String] status # @param [String] view - # Access level with which to view the returned result. Note that some fields - # require elevated access. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -703,8 +585,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_pages(blog_id, fetch_bodies: nil, max_results: nil, page_token: nil, status: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}/pages', options) + def list_pages(blog_id, fetch_bodies: nil, max_results: nil, page_token: nil, status: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/blogs/{blogId}/pages', options) command.response_representation = Google::Apis::BloggerV3::PageList::Representation command.response_class = Google::Apis::BloggerV3::PageList command.params['blogId'] = blog_id unless blog_id.nil? @@ -715,29 +597,20 @@ module Google command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Update a page. This method supports patch semantics. + # Patches a page. # @param [String] blog_id - # The ID of the Blog. # @param [String] page_id - # The ID of the Page. # @param [Google::Apis::BloggerV3::Page] page_object # @param [Boolean] publish - # Whether a publish action should be performed when the page is updated (default: - # false). # @param [Boolean] revert - # Whether a revert action should be performed when the page is updated (default: - # false). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -750,8 +623,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_page(blog_id, page_id, page_object = nil, publish: nil, revert: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'blogs/{blogId}/pages/{pageId}', options) + def patch_page(blog_id, page_id, page_object = nil, publish: nil, revert: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v3/blogs/{blogId}/pages/{pageId}', options) command.request_representation = Google::Apis::BloggerV3::Page::Representation command.request_object = page_object command.response_representation = Google::Apis::BloggerV3::Page::Representation @@ -762,22 +635,17 @@ module Google command.query['revert'] = revert unless revert.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Publishes a draft page. + # Publishes a page. # @param [String] blog_id - # The ID of the blog. # @param [String] page_id - # The ID of the page. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -790,30 +658,25 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def publish_page(blog_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'blogs/{blogId}/pages/{pageId}/publish', options) + def publish_page(blog_id, page_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v3/blogs/{blogId}/pages/{pageId}/publish', options) command.response_representation = Google::Apis::BloggerV3::Page::Representation command.response_class = Google::Apis::BloggerV3::Page command.params['blogId'] = blog_id unless blog_id.nil? command.params['pageId'] = page_id unless page_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Revert a published or scheduled page to draft state. + # Reverts a published or scheduled page to draft state. # @param [String] blog_id - # The ID of the blog. # @param [String] page_id - # The ID of the page. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -826,37 +689,28 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def revert_page(blog_id, page_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'blogs/{blogId}/pages/{pageId}/revert', options) + def revert_page(blog_id, page_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v3/blogs/{blogId}/pages/{pageId}/revert', options) command.response_representation = Google::Apis::BloggerV3::Page::Representation command.response_class = Google::Apis::BloggerV3::Page command.params['blogId'] = blog_id unless blog_id.nil? command.params['pageId'] = page_id unless page_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Update a page. + # Updates a page by blog id and page id. # @param [String] blog_id - # The ID of the Blog. # @param [String] page_id - # The ID of the Page. # @param [Google::Apis::BloggerV3::Page] page_object # @param [Boolean] publish - # Whether a publish action should be performed when the page is updated (default: - # false). # @param [Boolean] revert - # Whether a revert action should be performed when the page is updated (default: - # false). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -869,8 +723,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_page(blog_id, page_id, page_object = nil, publish: nil, revert: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'blogs/{blogId}/pages/{pageId}', options) + def update_page(blog_id, page_id, page_object = nil, publish: nil, revert: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v3/blogs/{blogId}/pages/{pageId}', options) command.request_representation = Google::Apis::BloggerV3::Page::Representation command.request_object = page_object command.response_representation = Google::Apis::BloggerV3::Page::Representation @@ -881,29 +735,19 @@ module Google command.query['revert'] = revert unless revert.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Gets one post and user info pair, by post ID and user ID. The post user info - # contains per-user information about the post, such as access rights, specific - # to the user. + # Gets one post and user info pair, by post_id and user_id. # @param [String] user_id - # ID of the user for the per-user information to be fetched. Either the word ' - # self' or the user's profile identifier. # @param [String] blog_id - # The ID of the blog. # @param [String] post_id - # The ID of the post to get. # @param [Fixnum] max_comments - # Maximum number of comments to pull back on a post. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -916,8 +760,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_post_user_info(user_id, blog_id, post_id, max_comments: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userId}/blogs/{blogId}/posts/{postId}', options) + def get_post_user_info(user_id, blog_id, post_id, max_comments: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/users/{userId}/blogs/{blogId}/posts/{postId}', options) command.response_representation = Google::Apis::BloggerV3::PostUserInfo::Representation command.response_class = Google::Apis::BloggerV3::PostUserInfo command.params['userId'] = user_id unless user_id.nil? @@ -926,43 +770,26 @@ module Google command.query['maxComments'] = max_comments unless max_comments.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Retrieves a list of post and post user info pairs, possibly filtered. The post - # user info contains per-user information about the post, such as access rights, - # specific to the user. + # Lists post and user info pairs. # @param [String] user_id - # ID of the user for the per-user information to be fetched. Either the word ' - # self' or the user's profile identifier. # @param [String] blog_id - # ID of the blog to fetch posts from. - # @param [DateTime] end_date - # Latest post date to fetch, a date-time with RFC 3339 formatting. + # @param [String] end_date # @param [Boolean] fetch_bodies - # Whether the body content of posts is included. Default is false. # @param [String] labels - # Comma-separated list of labels to search for. # @param [Fixnum] max_results - # Maximum number of posts to fetch. # @param [String] order_by - # Sort order applied to search results. Default is published. # @param [String] page_token - # Continuation token if the request is paged. - # @param [DateTime] start_date - # Earliest post date to fetch, a date-time with RFC 3339 formatting. + # @param [String] start_date # @param [Array, String] status # @param [String] view - # Access level with which to view the returned result. Note that some fields - # require elevated access. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -975,8 +802,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_post_user_info(user_id, blog_id, end_date: nil, fetch_bodies: nil, labels: nil, max_results: nil, order_by: nil, page_token: nil, start_date: nil, status: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userId}/blogs/{blogId}/posts', options) + def list_post_user_info(user_id, blog_id, end_date: nil, fetch_bodies: nil, labels: nil, max_results: nil, order_by: nil, page_token: nil, start_date: nil, status: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/users/{userId}/blogs/{blogId}/posts', options) command.response_representation = Google::Apis::BloggerV3::PostUserInfosList::Representation command.response_class = Google::Apis::BloggerV3::PostUserInfosList command.params['userId'] = user_id unless user_id.nil? @@ -992,22 +819,17 @@ module Google command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Delete a post by ID. + # Deletes a post by blog id and post id. # @param [String] blog_id - # The ID of the Blog. # @param [String] post_id - # The ID of the Post. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1020,39 +842,27 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_post(blog_id, post_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'blogs/{blogId}/posts/{postId}', options) + def delete_post(blog_id, post_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v3/blogs/{blogId}/posts/{postId}', options) command.params['blogId'] = blog_id unless blog_id.nil? command.params['postId'] = post_id unless post_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Get a post by ID. + # Gets a post by blog id and post id # @param [String] blog_id - # ID of the blog to fetch the post from. # @param [String] post_id - # The ID of the post # @param [Boolean] fetch_body - # Whether the body content of the post is included (default: true). This should - # be set to false when the post bodies are not required, to help minimize - # traffic. # @param [Boolean] fetch_images - # Whether image URL metadata for each post is included (default: false). # @param [Fixnum] max_comments - # Maximum number of comments to pull back on a post. # @param [String] view - # Access level with which to view the returned result. Note that some fields - # require elevated access. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1065,8 +875,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_post(blog_id, post_id, fetch_body: nil, fetch_images: nil, max_comments: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}/posts/{postId}', options) + def get_post(blog_id, post_id, fetch_body: nil, fetch_images: nil, max_comments: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/blogs/{blogId}/posts/{postId}', options) command.response_representation = Google::Apis::BloggerV3::Post::Representation command.response_class = Google::Apis::BloggerV3::Post command.params['blogId'] = blog_id unless blog_id.nil? @@ -1077,27 +887,19 @@ module Google command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Retrieve a Post by Path. + # Gets a post by path. # @param [String] blog_id - # ID of the blog to fetch the post from. # @param [String] path - # Path of the Post to retrieve. # @param [Fixnum] max_comments - # Maximum number of comments to pull back on a post. # @param [String] view - # Access level with which to view the returned result. Note that some fields - # require elevated access. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1110,8 +912,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_post_by_path(blog_id, path, max_comments: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}/posts/bypath', options) + def get_post_by_path(blog_id, path, max_comments: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/blogs/{blogId}/posts/bypath', options) command.response_representation = Google::Apis::BloggerV3::Post::Representation command.response_class = Google::Apis::BloggerV3::Post command.params['blogId'] = blog_id unless blog_id.nil? @@ -1120,29 +922,20 @@ module Google command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Add a post. + # Inserts a post. # @param [String] blog_id - # ID of the blog to add the post to. # @param [Google::Apis::BloggerV3::Post] post_object # @param [Boolean] fetch_body - # Whether the body content of the post is included with the result (default: - # true). # @param [Boolean] fetch_images - # Whether image URL metadata for each post is included in the returned result ( - # default: false). # @param [Boolean] is_draft - # Whether to create the post as a draft (default: false). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1155,8 +948,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_post(blog_id, post_object = nil, fetch_body: nil, fetch_images: nil, is_draft: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'blogs/{blogId}/posts', options) + def insert_post(blog_id, post_object = nil, fetch_body: nil, fetch_images: nil, is_draft: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v3/blogs/{blogId}/posts', options) command.request_representation = Google::Apis::BloggerV3::Post::Representation command.request_object = post_object command.response_representation = Google::Apis::BloggerV3::Post::Representation @@ -1167,42 +960,26 @@ module Google command.query['isDraft'] = is_draft unless is_draft.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Retrieves a list of posts, possibly filtered. + # Lists posts. # @param [String] blog_id - # ID of the blog to fetch posts from. - # @param [DateTime] end_date - # Latest post date to fetch, a date-time with RFC 3339 formatting. + # @param [String] end_date # @param [Boolean] fetch_bodies - # Whether the body content of posts is included (default: true). This should be - # set to false when the post bodies are not required, to help minimize traffic. # @param [Boolean] fetch_images - # Whether image URL metadata for each post is included. # @param [String] labels - # Comma-separated list of labels to search for. # @param [Fixnum] max_results - # Maximum number of posts to fetch. # @param [String] order_by - # Sort search results # @param [String] page_token - # Continuation token if the request is paged. - # @param [DateTime] start_date - # Earliest post date to fetch, a date-time with RFC 3339 formatting. + # @param [String] start_date # @param [Array, String] status - # Statuses to include in the results. # @param [String] view - # Access level with which to view the returned result. Note that some fields - # require escalated access. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1215,8 +992,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_posts(blog_id, end_date: nil, fetch_bodies: nil, fetch_images: nil, labels: nil, max_results: nil, order_by: nil, page_token: nil, start_date: nil, status: nil, view: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}/posts', options) + def list_posts(blog_id, end_date: nil, fetch_bodies: nil, fetch_images: nil, labels: nil, max_results: nil, order_by: nil, page_token: nil, start_date: nil, status: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/blogs/{blogId}/posts', options) command.response_representation = Google::Apis::BloggerV3::PostList::Representation command.response_class = Google::Apis::BloggerV3::PostList command.params['blogId'] = blog_id unless blog_id.nil? @@ -1232,37 +1009,23 @@ module Google command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Update a post. This method supports patch semantics. + # Patches a post. # @param [String] blog_id - # The ID of the Blog. # @param [String] post_id - # The ID of the Post. # @param [Google::Apis::BloggerV3::Post] post_object # @param [Boolean] fetch_body - # Whether the body content of the post is included with the result (default: - # true). # @param [Boolean] fetch_images - # Whether image URL metadata for each post is included in the returned result ( - # default: false). # @param [Fixnum] max_comments - # Maximum number of comments to retrieve with the returned post. # @param [Boolean] publish - # Whether a publish action should be performed when the post is updated (default: - # false). # @param [Boolean] revert - # Whether a revert action should be performed when the post is updated (default: - # false). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1275,8 +1038,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_post(blog_id, post_id, post_object = nil, fetch_body: nil, fetch_images: nil, max_comments: nil, publish: nil, revert: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'blogs/{blogId}/posts/{postId}', options) + def patch_post(blog_id, post_id, post_object = nil, fetch_body: nil, fetch_images: nil, max_comments: nil, publish: nil, revert: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v3/blogs/{blogId}/posts/{postId}', options) command.request_representation = Google::Apis::BloggerV3::Post::Representation command.request_object = post_object command.response_representation = Google::Apis::BloggerV3::Post::Representation @@ -1290,28 +1053,18 @@ module Google command.query['revert'] = revert unless revert.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Publishes a draft post, optionally at the specific time of the given - # publishDate parameter. + # Publishes a post. # @param [String] blog_id - # The ID of the Blog. # @param [String] post_id - # The ID of the Post. - # @param [DateTime] publish_date - # Optional date and time to schedule the publishing of the Blog. If no - # publishDate parameter is given, the post is either published at the a - # previously saved schedule date (if present), or the current time. If a future - # date is given, the post will be scheduled to be published. + # @param [String] publish_date # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1324,8 +1077,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def publish_post(blog_id, post_id, publish_date: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'blogs/{blogId}/posts/{postId}/publish', options) + def publish_post(blog_id, post_id, publish_date: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v3/blogs/{blogId}/posts/{postId}/publish', options) command.response_representation = Google::Apis::BloggerV3::Post::Representation command.response_class = Google::Apis::BloggerV3::Post command.params['blogId'] = blog_id unless blog_id.nil? @@ -1333,22 +1086,17 @@ module Google command.query['publishDate'] = publish_date unless publish_date.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Revert a published or scheduled post to draft state. + # Reverts a published or scheduled post to draft state. # @param [String] blog_id - # The ID of the Blog. # @param [String] post_id - # The ID of the Post. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1361,35 +1109,27 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def revert_post(blog_id, post_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'blogs/{blogId}/posts/{postId}/revert', options) + def revert_post(blog_id, post_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v3/blogs/{blogId}/posts/{postId}/revert', options) command.response_representation = Google::Apis::BloggerV3::Post::Representation command.response_class = Google::Apis::BloggerV3::Post command.params['blogId'] = blog_id unless blog_id.nil? command.params['postId'] = post_id unless post_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Search for a post. + # Searches for posts matching given query terms in the specified blog. # @param [String] blog_id - # ID of the blog to fetch the post from. # @param [String] q - # Query terms to search this blog for matching posts. # @param [Boolean] fetch_bodies - # Whether the body content of posts is included (default: true). This should be - # set to false when the post bodies are not required, to help minimize traffic. # @param [String] order_by - # Sort search results # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1402,8 +1142,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def search_posts(blog_id, q, fetch_bodies: nil, order_by: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'blogs/{blogId}/posts/search', options) + def search_posts(blog_id, q, fetch_bodies: nil, order_by: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/blogs/{blogId}/posts/search', options) command.response_representation = Google::Apis::BloggerV3::PostList::Representation command.response_class = Google::Apis::BloggerV3::PostList command.params['blogId'] = blog_id unless blog_id.nil? @@ -1412,37 +1152,23 @@ module Google command.query['q'] = q unless q.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Update a post. + # Updates a post by blog id and post id. # @param [String] blog_id - # The ID of the Blog. # @param [String] post_id - # The ID of the Post. # @param [Google::Apis::BloggerV3::Post] post_object # @param [Boolean] fetch_body - # Whether the body content of the post is included with the result (default: - # true). # @param [Boolean] fetch_images - # Whether image URL metadata for each post is included in the returned result ( - # default: false). # @param [Fixnum] max_comments - # Maximum number of comments to retrieve with the returned post. # @param [Boolean] publish - # Whether a publish action should be performed when the post is updated (default: - # false). # @param [Boolean] revert - # Whether a revert action should be performed when the post is updated (default: - # false). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1455,8 +1181,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_post(blog_id, post_id, post_object = nil, fetch_body: nil, fetch_images: nil, max_comments: nil, publish: nil, revert: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'blogs/{blogId}/posts/{postId}', options) + def update_post(blog_id, post_id, post_object = nil, fetch_body: nil, fetch_images: nil, max_comments: nil, publish: nil, revert: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v3/blogs/{blogId}/posts/{postId}', options) command.request_representation = Google::Apis::BloggerV3::Post::Representation command.request_object = post_object command.response_representation = Google::Apis::BloggerV3::Post::Representation @@ -1470,20 +1196,16 @@ module Google command.query['revert'] = revert unless revert.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Gets one user by ID. + # Gets one user by user_id. # @param [String] user_id - # The ID of the user to get. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1496,14 +1218,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'users/{userId}', options) + def get_user(user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/users/{userId}', options) command.response_representation = Google::Apis::BloggerV3::User::Representation command.response_class = Google::Apis::BloggerV3::User command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1512,7 +1233,6 @@ module Google def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? end end end diff --git a/generated/google/apis/calendar_v3.rb b/generated/google/apis/calendar_v3.rb index bbd8f7b85..9ff73fc7e 100644 --- a/generated/google/apis/calendar_v3.rb +++ b/generated/google/apis/calendar_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/google-apps/calendar/firstapp module CalendarV3 VERSION = 'V3' - REVISION = '20191117' + REVISION = '20200315' # See, edit, share, and permanently delete all the calendars you can access using Google Calendar AUTH_CALENDAR = 'https://www.googleapis.com/auth/calendar' diff --git a/generated/google/apis/calendar_v3/classes.rb b/generated/google/apis/calendar_v3/classes.rb index 5e1020aa0..22707886b 100644 --- a/generated/google/apis/calendar_v3/classes.rb +++ b/generated/google/apis/calendar_v3/classes.rb @@ -438,15 +438,8 @@ module Google class CalendarNotification include Google::Apis::Core::Hashable - # The method used to deliver the notification. Possible values are: + # The method used to deliver the notification. The possible value is: # - "email" - Notifications are sent via email. - # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer - # return notifications using this method. Any newly added SMS notifications will - # be ignored. See Google Calendar SMS notifications to be removed for more - # information. - # Notifications are sent via SMS. This value is read-only and is ignored on - # inserts and updates. SMS notifications are only available for G Suite - # customers. # Required when adding a notification. # Corresponds to the JSON property `method` # @return [String] @@ -1782,12 +1775,6 @@ module Google # The method used by this reminder. Possible values are: # - "email" - Reminders are sent via email. - # - "sms" - Deprecated. Once this feature is shutdown, the API will no longer - # return reminders using this method. Any newly added SMS reminders will be - # ignored. See Google Calendar SMS notifications to be removed for more - # information. - # Reminders are sent via SMS. These are only available for G Suite customers. - # Requests to set SMS reminders for other account types are ignored. # - "popup" - Reminders are sent via a UI popup. # Required when adding a reminder. # Corresponds to the JSON property `method` diff --git a/generated/google/apis/chat_v1.rb b/generated/google/apis/chat_v1.rb index 3d1c0eeb4..56d80d6c7 100644 --- a/generated/google/apis/chat_v1.rb +++ b/generated/google/apis/chat_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/hangouts/chat module ChatV1 VERSION = 'V1' - REVISION = '20200304' + REVISION = '20200405' end end end diff --git a/generated/google/apis/chat_v1/classes.rb b/generated/google/apis/chat_v1/classes.rb index a8ce60569..0299a057a 100644 --- a/generated/google/apis/chat_v1/classes.rb +++ b/generated/google/apis/chat_v1/classes.rb @@ -395,7 +395,7 @@ module Google # The aspect ratio of this image (width/height). This field allows clients # to reserve the right height for the image while waiting for it to load. # It's not meant to override the native aspect ratio of the image. - # If unset, server will fill it by prefetching the image. + # If unset, the server fills it by prefetching the image. # Corresponds to the JSON property `aspectRatio` # @return [Float] attr_accessor :aspect_ratio diff --git a/generated/google/apis/cloudasset_v1.rb b/generated/google/apis/cloudasset_v1.rb index 558a6502a..445e7b409 100644 --- a/generated/google/apis/cloudasset_v1.rb +++ b/generated/google/apis/cloudasset_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/asset-inventory/docs/quickstart module CloudassetV1 VERSION = 'V1' - REVISION = '20200221' + REVISION = '20200403' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudasset_v1/classes.rb b/generated/google/apis/cloudasset_v1/classes.rb index c51fb5bea..a40876509 100644 --- a/generated/google/apis/cloudasset_v1/classes.rb +++ b/generated/google/apis/cloudasset_v1/classes.rb @@ -22,8 +22,12 @@ module Google module Apis module CloudassetV1 - # Cloud asset. This includes all Google Cloud Platform resources, - # Cloud IAM policies, and other non-GCP assets. + # An asset in Google Cloud. An asset can be any resource in the Google Cloud + # [resource + # hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform- + # resource-hierarchy), + # a resource outside the Google Cloud resource hierarchy (such as Google + # Kubernetes Engine clusters and objects), or a Cloud IAM policy. class Asset include Google::Apis::Core::Hashable @@ -43,16 +47,22 @@ module Google # @return [Google::Apis::CloudassetV1::GoogleIdentityAccesscontextmanagerV1AccessPolicy] attr_accessor :access_policy - # Asset's ancestry path in Cloud Resource Manager (CRM) hierarchy, - # represented as a list of relative resource names. Ancestry path starts with - # the closest CRM ancestor and ends at root. If the asset is a CRM - # project/folder/organization, this starts from the asset itself. - # Example: ["projects/123456789", "folders/5432", "organizations/1234"] + # The ancestry path of an asset in Google Cloud [resource + # hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform- + # resource-hierarchy), + # represented as a list of relative resource names. An ancestry path starts + # with the closest ancestor in the hierarchy and ends at root. If the asset + # is a project, folder, or organization, the ancestry path starts from the + # asset itself. + # For example: `["projects/123456789", "folders/5432", "organizations/1234"]` # Corresponds to the JSON property `ancestors` # @return [Array] attr_accessor :ancestors - # Type of the asset. Example: "compute.googleapis.com/Disk". + # The type of the asset. For example: "compute.googleapis.com/Disk" + # See [Supported asset + # types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) + # for more information. # Corresponds to the JSON property `assetType` # @return [String] attr_accessor :asset_type @@ -118,23 +128,25 @@ module Google attr_accessor :iam_policy # The full name of the asset. For example: - # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/ - # instance1`. + # "//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/ + # instance1" # See [Resource - # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) + # names](https://cloud.google.com/apis/design/resource_names#full_resource_name) # for more information. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Representation of the Cloud Organization Policy set on an asset. For each - # asset, there could be multiple Organization policies with different - # constraints. + # A representation of an [organization + # policy](https://cloud.google.com/resource-manager/docs/organization-policy/ + # overview#organization_policy). + # There can be more than one organization policy with different constraints + # set on a given resource. # Corresponds to the JSON property `orgPolicy` # @return [Array] attr_accessor :org_policy - # Representation of a cloud resource. + # A representation of a Google Cloud resource. # Corresponds to the JSON property `resource` # @return [Google::Apis::CloudassetV1::Resource] attr_accessor :resource @@ -313,15 +325,15 @@ module Google # Required. The BigQuery dataset in format # "projects/projectId/datasets/datasetId", to which the snapshot result # should be exported. If this dataset does not exist, the export call returns - # an error. + # an INVALID_ARGUMENT error. # Corresponds to the JSON property `dataset` # @return [String] attr_accessor :dataset # If the destination table already exists and this flag is `TRUE`, the # table will be overwritten by the contents of assets snapshot. If the flag - # is not set and the destination table already exists, the export call - # returns an error. + # is `FALSE` or unset and the destination table already exists, the export + # call returns an INVALID_ARGUMEMT error. # Corresponds to the JSON property `force` # @return [Boolean] attr_accessor :force @@ -437,7 +449,7 @@ module Google # An asset feed filter controls what updates are exported. # The asset feed must be created within a project, organization, or # folder. Supported destinations are: - # Cloud Pub/Sub topics. + # Pub/Sub topics. # Corresponds to the JSON property `feed` # @return [Google::Apis::CloudassetV1::Feed] attr_accessor :feed @@ -503,10 +515,10 @@ module Google attr_accessor :output_config # Timestamp to take an asset snapshot. This can only be set to a timestamp - # between 2018-10-02 UTC (inclusive) and the current time. If not specified, - # the current time will be used. Due to delays in resource data collection - # and indexing, there is a volatile window during which running the same - # query may get different results. + # between the current time and the current time minus 35 days (inclusive). + # If not specified, the current time will be used. Due to delays in resource + # data collection and indexing, there is a volatile window during which + # running the same query may get different results. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -591,7 +603,7 @@ module Google # An asset feed filter controls what updates are exported. # The asset feed must be created within a project, organization, or # folder. Supported destinations are: - # Cloud Pub/Sub topics. + # Pub/Sub topics. class Feed include Google::Apis::Core::Hashable @@ -658,7 +670,7 @@ module Google class FeedOutputConfig include Google::Apis::Core::Hashable - # A Cloud Pubsub destination. + # A Pub/Sub destination. # Corresponds to the JSON property `pubsubDestination` # @return [Google::Apis::CloudassetV1::PubsubDestination] attr_accessor :pubsub_destination @@ -1058,11 +1070,6 @@ module Google # @return [Google::Apis::CloudassetV1::GoogleIdentityAccesscontextmanagerV1BasicLevel] attr_accessor :basic - # Output only. Time the `AccessLevel` was created in UTC. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language # to represent the necessary conditions for the level to apply to a request. # See CEL spec at: https://github.com/google/cel-spec @@ -1077,7 +1084,8 @@ module Google # Required. Resource name for the Access Level. The `short_name` component # must begin with a letter and only include alphanumeric and '_'. Format: - # `accessPolicies/`policy_id`/accessLevels/`short_name`` + # `accessPolicies/`policy_id`/accessLevels/`short_name``. The maximum length + # of the `short_name` component is 50 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1087,11 +1095,6 @@ module Google # @return [String] attr_accessor :title - # Output only. Time the `AccessLevel` was updated in UTC. - # Corresponds to the JSON property `updateTime` - # @return [String] - attr_accessor :update_time - def initialize(**args) update!(**args) end @@ -1099,12 +1102,10 @@ module Google # Update properties of this object def update!(**args) @basic = args[:basic] if args.key?(:basic) - @create_time = args[:create_time] if args.key?(:create_time) @custom = args[:custom] if args.key?(:custom) @description = args[:description] if args.key?(:description) @name = args[:name] if args.key?(:name) @title = args[:title] if args.key?(:title) - @update_time = args[:update_time] if args.key?(:update_time) end end @@ -1116,10 +1117,13 @@ module Google class GoogleIdentityAccesscontextmanagerV1AccessPolicy include Google::Apis::Core::Hashable - # Output only. Time the `AccessPolicy` was created in UTC. - # Corresponds to the JSON property `createTime` + # Output only. An opaque identifier for the current version of the + # `AccessPolicy`. This will always be a strongly validated etag, meaning that + # two Access Polices will be identical if and only if their etags are + # identical. Clients should not expect this to be in any specific format. + # Corresponds to the JSON property `etag` # @return [String] - attr_accessor :create_time + attr_accessor :etag # Output only. Resource name of the `AccessPolicy`. Format: # `accessPolicies/`policy_id`` @@ -1139,22 +1143,16 @@ module Google # @return [String] attr_accessor :title - # Output only. Time the `AccessPolicy` was updated in UTC. - # 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) + @etag = args[:etag] if args.key?(:etag) @name = args[:name] if args.key?(:name) @parent = args[:parent] if args.key?(:parent) @title = args[:title] if args.key?(:title) - @update_time = args[:update_time] if args.key?(:update_time) end end @@ -1422,11 +1420,6 @@ module Google class GoogleIdentityAccesscontextmanagerV1ServicePerimeter include Google::Apis::Core::Hashable - # Output only. Time the `ServicePerimeter` was created in UTC. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - # Description of the `ServicePerimeter` and its use. Does not affect # behavior. # Corresponds to the JSON property `description` @@ -1467,11 +1460,6 @@ module Google # @return [String] attr_accessor :title - # Output only. Time the `ServicePerimeter` was updated in UTC. - # Corresponds to the JSON property `updateTime` - # @return [String] - attr_accessor :update_time - # Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly # exists for all Service Perimeters, and that spec is identical to the # status for those Service Perimeters. When this flag is set, it inhibits the @@ -1493,14 +1481,12 @@ module Google # Update properties of this object def update!(**args) - @create_time = args[:create_time] if args.key?(:create_time) @description = args[:description] if args.key?(:description) @name = args[:name] if args.key?(:name) @perimeter_type = args[:perimeter_type] if args.key?(:perimeter_type) @spec = args[:spec] if args.key?(:spec) @status = args[:status] if args.key?(:status) @title = args[:title] if args.key?(:title) - @update_time = args[:update_time] if args.key?(:update_time) @use_explicit_dry_run_spec = args[:use_explicit_dry_run_spec] if args.key?(:use_explicit_dry_run_spec) end end @@ -1812,11 +1798,11 @@ module Google end end - # A Cloud Pubsub destination. + # A Pub/Sub destination. class PubsubDestination include Google::Apis::Core::Hashable - # The name of the Cloud Pub/Sub topic to publish to. + # The name of the Pub/Sub topic to publish to. # For example: `projects/PROJECT_ID/topics/TOPIC_ID`. # Corresponds to the JSON property `topic` # @return [String] @@ -1832,28 +1818,29 @@ module Google end end - # Representation of a cloud resource. + # A representation of a Google Cloud resource. class Resource include Google::Apis::Core::Hashable - # The content of the resource, in which some sensitive fields are scrubbed - # away and may not be present. + # The content of the resource, in which some sensitive fields are removed + # and may not be present. # Corresponds to the JSON property `data` # @return [Hash] attr_accessor :data # The URL of the discovery document containing the resource's JSON schema. # For example: - # `"https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"`. - # It will be left unspecified for resources without a discovery-based API, - # such as Cloud Bigtable. + # "https://www.googleapis.com/discovery/v1/apis/compute/v1/rest" + # This value is unspecified for resources that do not have an API based on a + # discovery document, such as Cloud Bigtable. # Corresponds to the JSON property `discoveryDocumentUri` # @return [String] attr_accessor :discovery_document_uri - # The JSON schema name listed in the discovery document. - # Example: "Project". It will be left unspecified for resources (such as - # Cloud Bigtable) without a discovery-based API. + # The JSON schema name listed in the discovery document. For example: + # "Project" + # This value is unspecified for resources that do not have an API based on a + # discovery document, such as Cloud Bigtable. # Corresponds to the JSON property `discoveryName` # @return [String] attr_accessor :discovery_name @@ -1862,25 +1849,25 @@ module Google # [Resource # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) # for more information. - # For GCP assets, it is the parent resource defined in the [Cloud IAM policy + # For Google Cloud assets, this value is the parent resource defined in the + # [Cloud IAM policy # hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy). # For example: - # `"//cloudresourcemanager.googleapis.com/projects/my_project_123"`. - # For third-party assets, it is up to the users to define. + # "//cloudresourcemanager.googleapis.com/projects/my_project_123" + # For third-party assets, this field may be set differently. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # The REST URL for accessing the resource. An HTTP GET operation using this - # URL returns the resource itself. - # Example: - # `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`. - # It will be left unspecified for resources without a REST API. + # The REST URL for accessing the resource. An HTTP `GET` request using this + # URL returns the resource itself. For example: + # "https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123" + # This value is unspecified for resources without a REST API. # Corresponds to the JSON property `resourceUrl` # @return [String] attr_accessor :resource_url - # The API version. Example: "v1". + # The API version. For example: "v1" # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -1939,24 +1926,28 @@ module Google end end - # Temporal asset. In addition to the asset, the temporal asset includes the - # status of the asset and valid from and to time of it. + # An asset in Google Cloud and its temporal metadata, including the time window + # when it was observed and its status during that window. class TemporalAsset include Google::Apis::Core::Hashable - # Cloud asset. This includes all Google Cloud Platform resources, - # Cloud IAM policies, and other non-GCP assets. + # An asset in Google Cloud. An asset can be any resource in the Google Cloud + # [resource + # hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform- + # resource-hierarchy), + # a resource outside the Google Cloud resource hierarchy (such as Google + # Kubernetes Engine clusters and objects), or a Cloud IAM policy. # Corresponds to the JSON property `asset` # @return [Google::Apis::CloudassetV1::Asset] attr_accessor :asset - # If the asset is deleted or not. + # Whether the asset has been deleted or not. # Corresponds to the JSON property `deleted` # @return [Boolean] attr_accessor :deleted alias_method :deleted?, :deleted - # A time window of (start_time, end_time]. + # A time window specified by its "start_time" and "end_time". # Corresponds to the JSON property `window` # @return [Google::Apis::CloudassetV1::TimeWindow] attr_accessor :window @@ -1973,12 +1964,12 @@ module Google end end - # A time window of (start_time, end_time]. + # A time window specified by its "start_time" and "end_time". class TimeWindow include Google::Apis::Core::Hashable - # End time of the time window (inclusive). - # Current timestamp if not specified. + # End time of the time window (inclusive). If not specified, the current + # timestamp is used instead. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -2007,7 +1998,7 @@ module Google # An asset feed filter controls what updates are exported. # The asset feed must be created within a project, organization, or # folder. Supported destinations are: - # Cloud Pub/Sub topics. + # Pub/Sub topics. # Corresponds to the JSON property `feed` # @return [Google::Apis::CloudassetV1::Feed] attr_accessor :feed diff --git a/generated/google/apis/cloudasset_v1/representations.rb b/generated/google/apis/cloudasset_v1/representations.rb index 529b5cdf9..5e9a6a8ee 100644 --- a/generated/google/apis/cloudasset_v1/representations.rb +++ b/generated/google/apis/cloudasset_v1/representations.rb @@ -418,24 +418,21 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :basic, as: 'basic', class: Google::Apis::CloudassetV1::GoogleIdentityAccesscontextmanagerV1BasicLevel, decorator: Google::Apis::CloudassetV1::GoogleIdentityAccesscontextmanagerV1BasicLevel::Representation - property :create_time, as: 'createTime' property :custom, as: 'custom', class: Google::Apis::CloudassetV1::GoogleIdentityAccesscontextmanagerV1CustomLevel, decorator: Google::Apis::CloudassetV1::GoogleIdentityAccesscontextmanagerV1CustomLevel::Representation property :description, as: 'description' property :name, as: 'name' property :title, as: 'title' - property :update_time, as: 'updateTime' end end class GoogleIdentityAccesscontextmanagerV1AccessPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation - property :create_time, as: 'createTime' + property :etag, as: 'etag' property :name, as: 'name' property :parent, as: 'parent' property :title, as: 'title' - property :update_time, as: 'updateTime' end end @@ -494,7 +491,6 @@ module Google class GoogleIdentityAccesscontextmanagerV1ServicePerimeter # @private class Representation < Google::Apis::Core::JsonRepresentation - property :create_time, as: 'createTime' property :description, as: 'description' property :name, as: 'name' property :perimeter_type, as: 'perimeterType' @@ -503,7 +499,6 @@ module Google property :status, as: 'status', class: Google::Apis::CloudassetV1::GoogleIdentityAccesscontextmanagerV1ServicePerimeterConfig, decorator: Google::Apis::CloudassetV1::GoogleIdentityAccesscontextmanagerV1ServicePerimeterConfig::Representation property :title, as: 'title' - property :update_time, as: 'updateTime' property :use_explicit_dry_run_spec, as: 'useExplicitDryRunSpec' end end diff --git a/generated/google/apis/cloudasset_v1/service.rb b/generated/google/apis/cloudasset_v1/service.rb index 3ea0b400b..ac62af13a 100644 --- a/generated/google/apis/cloudasset_v1/service.rb +++ b/generated/google/apis/cloudasset_v1/service.rb @@ -278,8 +278,8 @@ module Google # @param [String] content_type # Optional. The content type. # @param [String] read_time_window_end_time - # End time of the time window (inclusive). - # Current timestamp if not specified. + # End time of the time window (inclusive). If not specified, the current + # timestamp is used instead. # @param [String] read_time_window_start_time # Start time of the time window (exclusive). # @param [String] fields diff --git a/generated/google/apis/cloudasset_v1p1beta1.rb b/generated/google/apis/cloudasset_v1p1beta1.rb new file mode 100644 index 000000000..5df86de92 --- /dev/null +++ b/generated/google/apis/cloudasset_v1p1beta1.rb @@ -0,0 +1,34 @@ +# Copyright 2015 Google Inc. +# +# 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 'google/apis/cloudasset_v1p1beta1/service.rb' +require 'google/apis/cloudasset_v1p1beta1/classes.rb' +require 'google/apis/cloudasset_v1p1beta1/representations.rb' + +module Google + module Apis + # Cloud Asset API + # + # The cloud asset API manages the history and inventory of cloud resources. + # + # @see https://cloud.google.com/asset-inventory/docs/quickstart + module CloudassetV1p1beta1 + VERSION = 'V1p1beta1' + REVISION = '20200403' + + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' + end + end +end diff --git a/generated/google/apis/cloudasset_v1p1beta1/classes.rb b/generated/google/apis/cloudasset_v1p1beta1/classes.rb new file mode 100644 index 000000000..8f60dee06 --- /dev/null +++ b/generated/google/apis/cloudasset_v1p1beta1/classes.rb @@ -0,0 +1,669 @@ +# Copyright 2015 Google Inc. +# +# 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 CloudassetV1p1beta1 + + # 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 AuditConfig + include Google::Apis::Core::Hashable + + # The configuration for logging of each type of permission. + # Corresponds to the JSON property `auditLogConfigs` + # @return [Array] + 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 AuditLogConfig + 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] + 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 + + # Associates `members` with a `role`. + class Binding + 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::CloudassetV1p1beta1::Expr] + 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] + 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 + + # Explanation about the IAM policy search result. + class Explanation + include Google::Apis::Core::Hashable + + # The map from roles to their included permission matching the permission + # query (e.g. containing `policy.role.permissions:`). A sample role string: + # "roles/compute.instanceAdmin". The roles can also be found in the + # returned `policy` bindings. Note that the map is populated only if + # requesting with a permission query. + # Corresponds to the JSON property `matchedPermissions` + # @return [Hash] + attr_accessor :matched_permissions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @matched_permissions = args[:matched_permissions] if args.key?(:matched_permissions) + 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 Expr + 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 + + # The result for a IAM Policy search. + class IamPolicySearchResult + include Google::Apis::Core::Hashable + + # Explanation about the IAM policy search result. + # Corresponds to the JSON property `explanation` + # @return [Google::Apis::CloudassetV1p1beta1::Explanation] + attr_accessor :explanation + + # 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. + # Optionally, a `binding` can 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. + # **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::CloudassetV1p1beta1::Policy] + attr_accessor :policy + + # The project that the associated GCP resource belongs to, in the form of + # `projects/`project_number``. If an IAM policy is set on a resource (like VM + # instance, Cloud Storage bucket), the project field will indicate the + # project that contains the resource. If an IAM policy is set on a folder or + # orgnization, the project field will be empty. + # Corresponds to the JSON property `project` + # @return [String] + attr_accessor :project + + # The [full resource + # name](https://cloud.google.com/apis/design/resource_names#full_resource_name) + # of the resource associated with this IAM policy. + # Corresponds to the JSON property `resource` + # @return [String] + attr_accessor :resource + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @explanation = args[:explanation] if args.key?(:explanation) + @policy = args[:policy] if args.key?(:policy) + @project = args[:project] if args.key?(:project) + @resource = args[:resource] if args.key?(:resource) + end + end + + # IAM permissions + class Permissions + include Google::Apis::Core::Hashable + + # A list of permissions. A sample permission string: "compute.disk.get". + # Corresponds to the JSON property `permissions` + # @return [Array] + 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 + + # 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. + # Optionally, a `binding` can 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. + # **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 Policy + include Google::Apis::Core::Hashable + + # Specifies cloud audit logging configuration for this policy. + # Corresponds to the JSON property `auditConfigs` + # @return [Array] + 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] + 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. + # 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 + + # Search all IAM policies response. + class SearchAllIamPoliciesResponse + include Google::Apis::Core::Hashable + + # Set if there are more results than those appearing in this response; to get + # the next set of results, call this method again, using this value as the + # `page_token`. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # A list of IamPolicy that match the search query. Related information such + # as the associated resource is returned along with the policy. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + 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) + @results = args[:results] if args.key?(:results) + end + end + + # Search all resources response. + class SearchAllResourcesResponse + include Google::Apis::Core::Hashable + + # If there are more results than those appearing in this response, then + # `next_page_token` is included. To get the next set of results, call this + # method again using the value of `next_page_token` as `page_token`. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # A list of resource that match the search query. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + 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) + @results = args[:results] if args.key?(:results) + end + end + + # The standard metadata of a cloud resource. + class StandardResourceMetadata + include Google::Apis::Core::Hashable + + # Additional searchable attributes of this resource. + # Informational only. The exact set of attributes is subject to change. + # For example: project id, DNS name etc. + # Corresponds to the JSON property `additionalAttributes` + # @return [Array] + attr_accessor :additional_attributes + + # The type of this resource. + # For example: "compute.googleapis.com/Disk". + # Corresponds to the JSON property `assetType` + # @return [String] + attr_accessor :asset_type + + # One or more paragraphs of text description of this resource. Maximum length + # could be up to 1M bytes. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The display name of this resource. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Location can be "global", regional like "us-east1", or zonal like + # "us-west1-b". + # Corresponds to the JSON property `location` + # @return [String] + attr_accessor :location + + # The full resource name. For example: + # `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/ + # instance1`. + # See [Resource + # Names](https://cloud.google.com/apis/design/resource_names#full_resource_name) + # for more information. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The project that this resource belongs to, in the form of + # `projects/`project_number``. + # Corresponds to the JSON property `project` + # @return [String] + attr_accessor :project + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @additional_attributes = args[:additional_attributes] if args.key?(:additional_attributes) + @asset_type = args[:asset_type] if args.key?(:asset_type) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @location = args[:location] if args.key?(:location) + @name = args[:name] if args.key?(:name) + @project = args[:project] if args.key?(:project) + end + end + end + end +end diff --git a/generated/google/apis/cloudasset_v1p1beta1/representations.rb b/generated/google/apis/cloudasset_v1p1beta1/representations.rb new file mode 100644 index 000000000..bdae3456a --- /dev/null +++ b/generated/google/apis/cloudasset_v1p1beta1/representations.rb @@ -0,0 +1,199 @@ +# Copyright 2015 Google Inc. +# +# 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 CloudassetV1p1beta1 + + class AuditConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuditLogConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Binding + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Explanation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Expr + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IamPolicySearchResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Permissions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Policy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SearchAllIamPoliciesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SearchAllResourcesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class StandardResourceMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuditConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::CloudassetV1p1beta1::AuditLogConfig, decorator: Google::Apis::CloudassetV1p1beta1::AuditLogConfig::Representation + + property :service, as: 'service' + end + end + + class AuditLogConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :exempted_members, as: 'exemptedMembers' + property :log_type, as: 'logType' + end + end + + class Binding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :condition, as: 'condition', class: Google::Apis::CloudassetV1p1beta1::Expr, decorator: Google::Apis::CloudassetV1p1beta1::Expr::Representation + + collection :members, as: 'members' + property :role, as: 'role' + end + end + + class Explanation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :matched_permissions, as: 'matchedPermissions', class: Google::Apis::CloudassetV1p1beta1::Permissions, decorator: Google::Apis::CloudassetV1p1beta1::Permissions::Representation + + end + end + + class Expr + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :expression, as: 'expression' + property :location, as: 'location' + property :title, as: 'title' + end + end + + class IamPolicySearchResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :explanation, as: 'explanation', class: Google::Apis::CloudassetV1p1beta1::Explanation, decorator: Google::Apis::CloudassetV1p1beta1::Explanation::Representation + + property :policy, as: 'policy', class: Google::Apis::CloudassetV1p1beta1::Policy, decorator: Google::Apis::CloudassetV1p1beta1::Policy::Representation + + property :project, as: 'project' + property :resource, as: 'resource' + end + end + + class Permissions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class Policy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_configs, as: 'auditConfigs', class: Google::Apis::CloudassetV1p1beta1::AuditConfig, decorator: Google::Apis::CloudassetV1p1beta1::AuditConfig::Representation + + collection :bindings, as: 'bindings', class: Google::Apis::CloudassetV1p1beta1::Binding, decorator: Google::Apis::CloudassetV1p1beta1::Binding::Representation + + property :etag, :base64 => true, as: 'etag' + property :version, as: 'version' + end + end + + class SearchAllIamPoliciesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :results, as: 'results', class: Google::Apis::CloudassetV1p1beta1::IamPolicySearchResult, decorator: Google::Apis::CloudassetV1p1beta1::IamPolicySearchResult::Representation + + end + end + + class SearchAllResourcesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :results, as: 'results', class: Google::Apis::CloudassetV1p1beta1::StandardResourceMetadata, decorator: Google::Apis::CloudassetV1p1beta1::StandardResourceMetadata::Representation + + end + end + + class StandardResourceMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :additional_attributes, as: 'additionalAttributes' + property :asset_type, as: 'assetType' + property :description, as: 'description' + property :display_name, as: 'displayName' + property :location, as: 'location' + property :name, as: 'name' + property :project, as: 'project' + end + end + end + end +end diff --git a/generated/google/apis/cloudasset_v1p1beta1/service.rb b/generated/google/apis/cloudasset_v1p1beta1/service.rb new file mode 100644 index 000000000..7853d028d --- /dev/null +++ b/generated/google/apis/cloudasset_v1p1beta1/service.rb @@ -0,0 +1,187 @@ +# Copyright 2015 Google Inc. +# +# 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 '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 CloudassetV1p1beta1 + # Cloud Asset API + # + # The cloud asset API manages the history and inventory of cloud resources. + # + # @example + # require 'google/apis/cloudasset_v1p1beta1' + # + # Cloudasset = Google::Apis::CloudassetV1p1beta1 # Alias the module + # service = Cloudasset::CloudAssetService.new + # + # @see https://cloud.google.com/asset-inventory/docs/quickstart + class CloudAssetService < Google::Apis::Core::BaseService + # @return [String] + # API key. Your API key identifies your project and provides you with API access, + # quota, and reports. Required unless you provide an OAuth 2.0 token. + attr_accessor :key + + # @return [String] + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + attr_accessor :quota_user + + def initialize + super('https://cloudasset.googleapis.com/', '') + @batch_path = 'batch' + end + + # Searches all the IAM policies under a given accessible CRM scope + # (project/folder/organization). This RPC gives callers + # especially admins the ability to search all the IAM policies under a scope, + # even if they don't have .getIamPolicy permission of all the IAM policies. + # Callers should have cloud.assets.SearchAllIamPolicies permission on the + # requested scope, otherwise it will be rejected. + # @param [String] scope + # Required. The relative name of an asset. The search is limited to the + # resources + # within the `scope`. The allowed value must be: + # * Organization number (such as "organizations/123") + # * Folder number(such as "folders/1234") + # * Project number (such as "projects/12345") + # @param [Fixnum] page_size + # Optional. The page size for search result pagination. Page size is capped at + # 500 even + # if a larger value is given. If set to zero, server will pick an appropriate + # default. Returned results may be fewer than requested. When this happens, + # there could be more results as long as `next_page_token` is returned. + # @param [String] page_token + # Optional. If present, retrieve the next batch of results from the preceding + # call to + # this method. `page_token` must be the value of `next_page_token` from the + # previous response. The values of all other method parameters must be + # identical to those in the previous call. + # @param [String] query + # Optional. The query statement. + # Examples: + # * "policy:myuser@mydomain.com" + # * "policy:(myuser@mydomain.com viewer)" + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudassetV1p1beta1::SearchAllIamPoliciesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudassetV1p1beta1::SearchAllIamPoliciesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_iam_policy_all(scope, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1p1beta1/{+scope}/iamPolicies:searchAll', options) + command.response_representation = Google::Apis::CloudassetV1p1beta1::SearchAllIamPoliciesResponse::Representation + command.response_class = Google::Apis::CloudassetV1p1beta1::SearchAllIamPoliciesResponse + command.params['scope'] = scope unless scope.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['query'] = query unless query.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Searches all the resources under a given accessible CRM scope + # (project/folder/organization). This RPC gives callers + # especially admins the ability to search all the resources under a scope, + # even if they don't have .get permission of all the resources. Callers + # should have cloud.assets.SearchAllResources permission on the requested + # scope, otherwise it will be rejected. + # @param [String] scope + # Required. The relative name of an asset. The search is limited to the + # resources + # within the `scope`. The allowed value must be: + # * Organization number (such as "organizations/123") + # * Folder number(such as "folders/1234") + # * Project number (such as "projects/12345") + # @param [Array, String] asset_types + # Optional. A list of asset types that this request searches for. If empty, it + # will + # search all the supported asset types. + # @param [String] order_by + # Optional. A comma separated list of fields specifying the sorting order of the + # results. The default order is ascending. Add " desc" after the field name + # to indicate descending order. Redundant space characters are ignored. For + # example, " foo , bar desc ". + # @param [Fixnum] page_size + # Optional. The page size for search result pagination. Page size is capped at + # 500 even + # if a larger value is given. If set to zero, server will pick an appropriate + # default. Returned results may be fewer than requested. When this happens, + # there could be more results as long as `next_page_token` is returned. + # @param [String] page_token + # Optional. If present, then retrieve the next batch of results from the + # preceding call + # to this method. `page_token` must be the value of `next_page_token` from + # the previous response. The values of all other method parameters, must be + # identical to those in the previous call. + # @param [String] query + # Optional. The query statement. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudassetV1p1beta1::SearchAllResourcesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudassetV1p1beta1::SearchAllResourcesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_resource_all(scope, asset_types: nil, order_by: nil, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1p1beta1/{+scope}/resources:searchAll', options) + command.response_representation = Google::Apis::CloudassetV1p1beta1::SearchAllResourcesResponse::Representation + command.response_class = Google::Apis::CloudassetV1p1beta1::SearchAllResourcesResponse + command.params['scope'] = scope unless scope.nil? + command.query['assetTypes'] = asset_types unless asset_types.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['query'] = query unless query.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/cloudbuild_v1.rb b/generated/google/apis/cloudbuild_v1.rb index 003ab4f9e..a4728a218 100644 --- a/generated/google/apis/cloudbuild_v1.rb +++ b/generated/google/apis/cloudbuild_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/cloud-build/docs/ module CloudbuildV1 VERSION = 'V1' - REVISION = '20200308' + REVISION = '20200317' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudbuild_v1/classes.rb b/generated/google/apis/cloudbuild_v1/classes.rb index 35904d1e3..21355b92f 100644 --- a/generated/google/apis/cloudbuild_v1/classes.rb +++ b/generated/google/apis/cloudbuild_v1/classes.rb @@ -200,6 +200,14 @@ module Google # @return [String] attr_accessor :project_id + # TTL in queue for this build. If provided and the build is enqueued longer + # than this value, the build will expire and the build status will be + # `EXPIRED`. + # The TTL starts ticking from create_time. + # Corresponds to the JSON property `queueTtl` + # @return [String] + attr_accessor :queue_ttl + # Artifacts created by the build pipeline. # Corresponds to the JSON property `results` # @return [Google::Apis::CloudbuildV1::Results] @@ -286,6 +294,7 @@ module Google @logs_bucket = args[:logs_bucket] if args.key?(:logs_bucket) @options = args[:options] if args.key?(:options) @project_id = args[:project_id] if args.key?(:project_id) + @queue_ttl = args[:queue_ttl] if args.key?(:queue_ttl) @results = args[:results] if args.key?(:results) @secrets = args[:secrets] if args.key?(:secrets) @source = args[:source] if args.key?(:source) @@ -658,7 +667,9 @@ module Google # @return [String] attr_accessor :name - # Substitutions data for Build resource. + # Substitutions for Build resource. The keys must match the following + # regular expression: `^_[A-Z0-9_]+$`.The keys cannot conflict with the + # keys in bindings. # Corresponds to the JSON property `substitutions` # @return [Hash] attr_accessor :substitutions diff --git a/generated/google/apis/cloudbuild_v1/representations.rb b/generated/google/apis/cloudbuild_v1/representations.rb index 784046d7e..27d49d141 100644 --- a/generated/google/apis/cloudbuild_v1/representations.rb +++ b/generated/google/apis/cloudbuild_v1/representations.rb @@ -251,6 +251,7 @@ module Google property :options, as: 'options', class: Google::Apis::CloudbuildV1::BuildOptions, decorator: Google::Apis::CloudbuildV1::BuildOptions::Representation property :project_id, as: 'projectId' + property :queue_ttl, as: 'queueTtl' property :results, as: 'results', class: Google::Apis::CloudbuildV1::Results, decorator: Google::Apis::CloudbuildV1::Results::Representation collection :secrets, as: 'secrets', class: Google::Apis::CloudbuildV1::Secret, decorator: Google::Apis::CloudbuildV1::Secret::Representation diff --git a/generated/google/apis/cloudbuild_v1alpha1.rb b/generated/google/apis/cloudbuild_v1alpha1.rb index 88a199ee8..c93ccb168 100644 --- a/generated/google/apis/cloudbuild_v1alpha1.rb +++ b/generated/google/apis/cloudbuild_v1alpha1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/cloud-build/docs/ module CloudbuildV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200308' + REVISION = '20200317' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudbuild_v1alpha1/classes.rb b/generated/google/apis/cloudbuild_v1alpha1/classes.rb index 8914a65df..4d40544e3 100644 --- a/generated/google/apis/cloudbuild_v1alpha1/classes.rb +++ b/generated/google/apis/cloudbuild_v1alpha1/classes.rb @@ -200,6 +200,14 @@ module Google # @return [String] attr_accessor :project_id + # TTL in queue for this build. If provided and the build is enqueued longer + # than this value, the build will expire and the build status will be + # `EXPIRED`. + # The TTL starts ticking from create_time. + # Corresponds to the JSON property `queueTtl` + # @return [String] + attr_accessor :queue_ttl + # Artifacts created by the build pipeline. # Corresponds to the JSON property `results` # @return [Google::Apis::CloudbuildV1alpha1::Results] @@ -286,6 +294,7 @@ module Google @logs_bucket = args[:logs_bucket] if args.key?(:logs_bucket) @options = args[:options] if args.key?(:options) @project_id = args[:project_id] if args.key?(:project_id) + @queue_ttl = args[:queue_ttl] if args.key?(:queue_ttl) @results = args[:results] if args.key?(:results) @secrets = args[:secrets] if args.key?(:secrets) @source = args[:source] if args.key?(:source) diff --git a/generated/google/apis/cloudbuild_v1alpha1/representations.rb b/generated/google/apis/cloudbuild_v1alpha1/representations.rb index 218b58166..055a052e1 100644 --- a/generated/google/apis/cloudbuild_v1alpha1/representations.rb +++ b/generated/google/apis/cloudbuild_v1alpha1/representations.rb @@ -203,6 +203,7 @@ module Google property :options, as: 'options', class: Google::Apis::CloudbuildV1alpha1::BuildOptions, decorator: Google::Apis::CloudbuildV1alpha1::BuildOptions::Representation property :project_id, as: 'projectId' + property :queue_ttl, as: 'queueTtl' property :results, as: 'results', class: Google::Apis::CloudbuildV1alpha1::Results, decorator: Google::Apis::CloudbuildV1alpha1::Results::Representation collection :secrets, as: 'secrets', class: Google::Apis::CloudbuildV1alpha1::Secret, decorator: Google::Apis::CloudbuildV1alpha1::Secret::Representation diff --git a/generated/google/apis/cloudbuild_v1alpha2.rb b/generated/google/apis/cloudbuild_v1alpha2.rb index a7ad832ab..ad713e1d9 100644 --- a/generated/google/apis/cloudbuild_v1alpha2.rb +++ b/generated/google/apis/cloudbuild_v1alpha2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/cloud-build/docs/ module CloudbuildV1alpha2 VERSION = 'V1alpha2' - REVISION = '20200308' + REVISION = '20200317' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudbuild_v1alpha2/classes.rb b/generated/google/apis/cloudbuild_v1alpha2/classes.rb index 86f65a0d9..8a0a3bcc4 100644 --- a/generated/google/apis/cloudbuild_v1alpha2/classes.rb +++ b/generated/google/apis/cloudbuild_v1alpha2/classes.rb @@ -200,6 +200,14 @@ module Google # @return [String] attr_accessor :project_id + # TTL in queue for this build. If provided and the build is enqueued longer + # than this value, the build will expire and the build status will be + # `EXPIRED`. + # The TTL starts ticking from create_time. + # Corresponds to the JSON property `queueTtl` + # @return [String] + attr_accessor :queue_ttl + # Artifacts created by the build pipeline. # Corresponds to the JSON property `results` # @return [Google::Apis::CloudbuildV1alpha2::Results] @@ -286,6 +294,7 @@ module Google @logs_bucket = args[:logs_bucket] if args.key?(:logs_bucket) @options = args[:options] if args.key?(:options) @project_id = args[:project_id] if args.key?(:project_id) + @queue_ttl = args[:queue_ttl] if args.key?(:queue_ttl) @results = args[:results] if args.key?(:results) @secrets = args[:secrets] if args.key?(:secrets) @source = args[:source] if args.key?(:source) diff --git a/generated/google/apis/cloudbuild_v1alpha2/representations.rb b/generated/google/apis/cloudbuild_v1alpha2/representations.rb index 570704c45..d844198b7 100644 --- a/generated/google/apis/cloudbuild_v1alpha2/representations.rb +++ b/generated/google/apis/cloudbuild_v1alpha2/representations.rb @@ -203,6 +203,7 @@ module Google property :options, as: 'options', class: Google::Apis::CloudbuildV1alpha2::BuildOptions, decorator: Google::Apis::CloudbuildV1alpha2::BuildOptions::Representation property :project_id, as: 'projectId' + property :queue_ttl, as: 'queueTtl' property :results, as: 'results', class: Google::Apis::CloudbuildV1alpha2::Results, decorator: Google::Apis::CloudbuildV1alpha2::Results::Representation collection :secrets, as: 'secrets', class: Google::Apis::CloudbuildV1alpha2::Secret, decorator: Google::Apis::CloudbuildV1alpha2::Secret::Representation diff --git a/generated/google/apis/clouddebugger_v2.rb b/generated/google/apis/clouddebugger_v2.rb index 09d2ac9ed..c53a63367 100644 --- a/generated/google/apis/clouddebugger_v2.rb +++ b/generated/google/apis/clouddebugger_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/debugger module ClouddebuggerV2 VERSION = 'V2' - REVISION = '20200228' + REVISION = '20200313' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/clouddebugger_v2/classes.rb b/generated/google/apis/clouddebugger_v2/classes.rb index 07335c813..632500cb8 100644 --- a/generated/google/apis/clouddebugger_v2/classes.rb +++ b/generated/google/apis/clouddebugger_v2/classes.rb @@ -47,6 +47,8 @@ module Google end end + # ------------------------------------------------------------------------------ + # ## Breakpoint (the resource) # Represents the breakpoint specification, status and results. class Breakpoint include Google::Apis::Core::Hashable @@ -517,6 +519,8 @@ module Google class GetBreakpointResponse include Google::Apis::Core::Hashable + # ------------------------------------------------------------------------------ + # ## Breakpoint (the resource) # Represents the breakpoint specification, status and results. # Corresponds to the JSON property `breakpoint` # @return [Google::Apis::ClouddebuggerV2::Breakpoint] @@ -748,6 +752,8 @@ module Google class SetBreakpointResponse include Google::Apis::Core::Hashable + # ------------------------------------------------------------------------------ + # ## Breakpoint (the resource) # Represents the breakpoint specification, status and results. # Corresponds to the JSON property `breakpoint` # @return [Google::Apis::ClouddebuggerV2::Breakpoint] @@ -915,6 +921,8 @@ module Google class UpdateActiveBreakpointRequest include Google::Apis::Core::Hashable + # ------------------------------------------------------------------------------ + # ## Breakpoint (the resource) # Represents the breakpoint specification, status and results. # Corresponds to the JSON property `breakpoint` # @return [Google::Apis::ClouddebuggerV2::Breakpoint] diff --git a/generated/google/apis/cloudidentity_v1.rb b/generated/google/apis/cloudidentity_v1.rb index 7841e87e2..01fd12a6c 100644 --- a/generated/google/apis/cloudidentity_v1.rb +++ b/generated/google/apis/cloudidentity_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/identity/ module CloudidentityV1 VERSION = 'V1' - REVISION = '20200215' + REVISION = '20200401' # See, change, create, and delete any of the Cloud Identity Groups that you can access, including the members of each group AUTH_CLOUD_IDENTITY_GROUPS = 'https://www.googleapis.com/auth/cloud-identity.groups' diff --git a/generated/google/apis/cloudidentity_v1/classes.rb b/generated/google/apis/cloudidentity_v1/classes.rb index d9fe617ac..dce6ef14b 100644 --- a/generated/google/apis/cloudidentity_v1/classes.rb +++ b/generated/google/apis/cloudidentity_v1/classes.rb @@ -22,450 +22,6 @@ module Google module Apis module CloudidentityV1 - # Resource representing the Android specific attributes of a Device. - class AndroidAttributes - include Google::Apis::Core::Hashable - - # Baseband version of Android device. - # Corresponds to the JSON property `basebandVersion` - # @return [String] - attr_accessor :baseband_version - - # Device bootloader version. Example: 0.6.7. - # Corresponds to the JSON property `bootloaderVersion` - # @return [String] - attr_accessor :bootloader_version - - # Build number of Android device. - # Corresponds to the JSON property `buildNumber` - # @return [String] - attr_accessor :build_number - - # Whether developer options is enabled on device. - # Corresponds to the JSON property `enabledDeveloperOptions` - # @return [Boolean] - attr_accessor :enabled_developer_options - alias_method :enabled_developer_options?, :enabled_developer_options - - # Whether applications from unknown sources can be installed on device. - # Corresponds to the JSON property `enabledUnknownSources` - # @return [Boolean] - attr_accessor :enabled_unknown_sources - alias_method :enabled_unknown_sources?, :enabled_unknown_sources - - # Whether adb (USB debugging) is enabled on device. - # Corresponds to the JSON property `enabledUsbDebugging` - # @return [Boolean] - attr_accessor :enabled_usb_debugging - alias_method :enabled_usb_debugging?, :enabled_usb_debugging - - # Device encryption state. - # Corresponds to the JSON property `encryptionState` - # @return [String] - attr_accessor :encryption_state - - # Device hardware. Example: Sprout. - # Corresponds to the JSON property `hardware` - # @return [String] - attr_accessor :hardware - - # Kernel version of Android device. - # Corresponds to the JSON property `kernelVersion` - # @return [String] - attr_accessor :kernel_version - - # Domain name for Google accounts on device. Type for other accounts on - # device. Will only be populated if |ownership_privilege| is - # |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in - # to the device policy app if that account's domain has only one account. - # Examples: "com.example", "xyz.com". - # Corresponds to the JSON property `otherAccounts` - # @return [Array] - attr_accessor :other_accounts - - # Whether this account is on an owner/primary profile. - # For phones, only true for owner profiles. Android 4+ devices - # can have secondary or restricted user profiles. - # Corresponds to the JSON property `ownerProfileAccount` - # @return [Boolean] - attr_accessor :owner_profile_account - alias_method :owner_profile_account?, :owner_profile_account - - # Ownership privileges on device. - # Corresponds to the JSON property `ownershipPrivilege` - # @return [String] - attr_accessor :ownership_privilege - - # OS security patch update time on device. - # Corresponds to the JSON property `securityPatchTime` - # @return [String] - attr_accessor :security_patch_time - - # Whether device supports Android work profiles. If false, this service - # will not block access to corp data even if an administrator turns on the - # "Enforce Work Profile" policy. - # Corresponds to the JSON property `supportsWorkProfile` - # @return [Boolean] - attr_accessor :supports_work_profile - alias_method :supports_work_profile?, :supports_work_profile - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @baseband_version = args[:baseband_version] if args.key?(:baseband_version) - @bootloader_version = args[:bootloader_version] if args.key?(:bootloader_version) - @build_number = args[:build_number] if args.key?(:build_number) - @enabled_developer_options = args[:enabled_developer_options] if args.key?(:enabled_developer_options) - @enabled_unknown_sources = args[:enabled_unknown_sources] if args.key?(:enabled_unknown_sources) - @enabled_usb_debugging = args[:enabled_usb_debugging] if args.key?(:enabled_usb_debugging) - @encryption_state = args[:encryption_state] if args.key?(:encryption_state) - @hardware = args[:hardware] if args.key?(:hardware) - @kernel_version = args[:kernel_version] if args.key?(:kernel_version) - @other_accounts = args[:other_accounts] if args.key?(:other_accounts) - @owner_profile_account = args[:owner_profile_account] if args.key?(:owner_profile_account) - @ownership_privilege = args[:ownership_privilege] if args.key?(:ownership_privilege) - @security_patch_time = args[:security_patch_time] if args.key?(:security_patch_time) - @supports_work_profile = args[:supports_work_profile] if args.key?(:supports_work_profile) - end - end - - # Response message for approving the device to access user data. - class ApproveDeviceUserResponse - include Google::Apis::Core::Hashable - - # A DeviceUser is a resource representing a user's use of a Device - # Corresponds to the JSON property `deviceUser` - # @return [Google::Apis::CloudidentityV1::DeviceUser] - attr_accessor :device_user - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @device_user = args[:device_user] if args.key?(:device_user) - end - end - - # Response message for blocking the device from accessing user data. - class BlockDeviceUserResponse - include Google::Apis::Core::Hashable - - # A DeviceUser is a resource representing a user's use of a Device - # Corresponds to the JSON property `deviceUser` - # @return [Google::Apis::CloudidentityV1::DeviceUser] - attr_accessor :device_user - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @device_user = args[:device_user] if args.key?(:device_user) - end - end - - # Response message for cancelling an unfinished device wipe. - class CancelWipeDeviceResponse - include Google::Apis::Core::Hashable - - # Represents a Device known to Google Cloud, independent of the device - # ownership, type, and whether it is assigned or in use by a user. - # Corresponds to the JSON property `device` - # @return [Google::Apis::CloudidentityV1::Device] - attr_accessor :device - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @device = args[:device] if args.key?(:device) - end - end - - # Response message for cancelling an unfinished user account wipe. - class CancelWipeDeviceUserResponse - include Google::Apis::Core::Hashable - - # A DeviceUser is a resource representing a user's use of a Device - # Corresponds to the JSON property `deviceUser` - # @return [Google::Apis::CloudidentityV1::DeviceUser] - attr_accessor :device_user - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @device_user = args[:device_user] if args.key?(:device_user) - end - end - - # Represents a Device known to Google Cloud, independent of the device - # ownership, type, and whether it is assigned or in use by a user. - class Device - include Google::Apis::Core::Hashable - - # Resource representing the Android specific attributes of a Device. - # Corresponds to the JSON property `androidSpecificAttributes` - # @return [Google::Apis::CloudidentityV1::AndroidAttributes] - attr_accessor :android_specific_attributes - - # Asset tag of the device. - # Corresponds to the JSON property `assetTag` - # @return [String] - attr_accessor :asset_tag - - # Output only. Device brand. Example: Samsung. - # Corresponds to the JSON property `brand` - # @return [String] - attr_accessor :brand - - # Output only. Represents whether the Device is compromised. - # Corresponds to the JSON property `compromisedState` - # @return [String] - attr_accessor :compromised_state - - # Output only. When the Company-Owned device was imported. This field is empty - # for BYOD - # devices. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Output only. Type of device. - # Corresponds to the JSON property `deviceType` - # @return [String] - attr_accessor :device_type - - # Output only. IMEI number of device if GSM device; empty otherwise. - # Corresponds to the JSON property `imei` - # @return [String] - attr_accessor :imei - - # Most recent time when device synced with this service. - # Corresponds to the JSON property `lastSyncTime` - # @return [String] - attr_accessor :last_sync_time - - # Output only. Management state of the device - # Corresponds to the JSON property `managementState` - # @return [String] - attr_accessor :management_state - - # Output only. Device manufacturer. Example: Motorola. - # Corresponds to the JSON property `manufacturer` - # @return [String] - attr_accessor :manufacturer - - # Output only. MEID number of device if CDMA device; empty otherwise. - # Corresponds to the JSON property `meid` - # @return [String] - attr_accessor :meid - - # Output only. Model name of device. Example: Pixel 3. - # Corresponds to the JSON property `model` - # @return [String] - attr_accessor :model - - # Output only. [Resource name](https://cloud.google.com/apis/design/ - # resource_names) - # of the Device in format: `devices/`device_id``, where device_id is - # the unique id assigned to the Device. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Output only. Mobile or network operator of device, if available. - # Corresponds to the JSON property `networkOperator` - # @return [String] - attr_accessor :network_operator - - # Output only. OS version of the device. Example: Android 8.1.0. - # Corresponds to the JSON property `osVersion` - # @return [String] - attr_accessor :os_version - - # Whether the device is owned by the company or an individual - # Corresponds to the JSON property `ownerType` - # @return [String] - attr_accessor :owner_type - - # Output only. OS release version. Example: 6.0. - # Corresponds to the JSON property `releaseVersion` - # @return [String] - attr_accessor :release_version - - # Serial Number of device. Example: HT82V1A01076. - # Corresponds to the JSON property `serialNumber` - # @return [String] - attr_accessor :serial_number - - # WiFi MAC addresses of device. - # Corresponds to the JSON property `wifiMacAddresses` - # @return [Array] - attr_accessor :wifi_mac_addresses - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @android_specific_attributes = args[:android_specific_attributes] if args.key?(:android_specific_attributes) - @asset_tag = args[:asset_tag] if args.key?(:asset_tag) - @brand = args[:brand] if args.key?(:brand) - @compromised_state = args[:compromised_state] if args.key?(:compromised_state) - @create_time = args[:create_time] if args.key?(:create_time) - @device_type = args[:device_type] if args.key?(:device_type) - @imei = args[:imei] if args.key?(:imei) - @last_sync_time = args[:last_sync_time] if args.key?(:last_sync_time) - @management_state = args[:management_state] if args.key?(:management_state) - @manufacturer = args[:manufacturer] if args.key?(:manufacturer) - @meid = args[:meid] if args.key?(:meid) - @model = args[:model] if args.key?(:model) - @name = args[:name] if args.key?(:name) - @network_operator = args[:network_operator] if args.key?(:network_operator) - @os_version = args[:os_version] if args.key?(:os_version) - @owner_type = args[:owner_type] if args.key?(:owner_type) - @release_version = args[:release_version] if args.key?(:release_version) - @serial_number = args[:serial_number] if args.key?(:serial_number) - @wifi_mac_addresses = args[:wifi_mac_addresses] if args.key?(:wifi_mac_addresses) - end - end - - # A DeviceUser is a resource representing a user's use of a Device - class DeviceUser - include Google::Apis::Core::Hashable - - # Compromised State of the DeviceUser object - # Corresponds to the JSON property `compromisedState` - # @return [String] - attr_accessor :compromised_state - - # Output only. Most recent time when user registered with this service. - # Corresponds to the JSON property `firstSyncTime` - # @return [String] - attr_accessor :first_sync_time - - # Output only. Default locale used on device, in IETF BCP-47 format. - # Corresponds to the JSON property `languageCode` - # @return [String] - attr_accessor :language_code - - # Output only. Last time when user synced with policies. - # Corresponds to the JSON property `lastSyncTime` - # @return [String] - attr_accessor :last_sync_time - - # Output only. Management state of the user on the device. - # Corresponds to the JSON property `managementState` - # @return [String] - attr_accessor :management_state - - # Output only. [Resource name](https://cloud.google.com/apis/design/ - # resource_names) of - # the DeviceUser in format: `devices/`device_id`/deviceUsers/`user_id``, - # where user_id is the ID of the user associated with the user session. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Password state of the DeviceUser object - # Corresponds to the JSON property `passwordState` - # @return [String] - attr_accessor :password_state - - # Output only. User agent on the device for this specific user - # Corresponds to the JSON property `userAgent` - # @return [String] - attr_accessor :user_agent - - # Email address of the user registered on the device. - # Corresponds to the JSON property `userEmail` - # @return [String] - attr_accessor :user_email - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @compromised_state = args[:compromised_state] if args.key?(:compromised_state) - @first_sync_time = args[:first_sync_time] if args.key?(:first_sync_time) - @language_code = args[:language_code] if args.key?(:language_code) - @last_sync_time = args[:last_sync_time] if args.key?(:last_sync_time) - @management_state = args[:management_state] if args.key?(:management_state) - @name = args[:name] if args.key?(:name) - @password_state = args[:password_state] if args.key?(:password_state) - @user_agent = args[:user_agent] if args.key?(:user_agent) - @user_email = args[:user_email] if args.key?(:user_email) - end - end - - # An EndpointApp represents an app that is installed on a device - # Next ID to use: 7 - class EndpointApp - include Google::Apis::Core::Hashable - - # Output only. Name of the app displayed to the user - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # Output only. [Resource name](https://cloud.google.com/apis/design/ - # resource_names) of - # the EndpointApp in format: - # `devices/`device`/deviceUsers/`device_user`/endpointApps/`endpoint_app``, - # where client_app_id is the ID of the app associated with the Device. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Output only. Full package name of the installed app - # Corresponds to the JSON property `packageName` - # @return [String] - attr_accessor :package_name - - # Output only. Names of all permissions granted to the installed app - # Corresponds to the JSON property `permissions` - # @return [Array] - attr_accessor :permissions - - # Output only. Version code of the installed app - # Corresponds to the JSON property `versionCode` - # @return [Fixnum] - attr_accessor :version_code - - # Output only. Version name of the installed app - # Corresponds to the JSON property `versionName` - # @return [String] - attr_accessor :version_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) - @name = args[:name] if args.key?(:name) - @package_name = args[:package_name] if args.key?(:package_name) - @permissions = args[:permissions] if args.key?(:permissions) - @version_code = args[:version_code] if args.key?(:version_code) - @version_name = args[:version_name] if args.key?(:version_name) - end - end - # An EntityKey uniquely identifies an Entity. Namespaces are used to provide # isolation for IDs. A single ID can be reused across namespaces but the # combination of a namespace and an ID must be unique. @@ -575,84 +131,6 @@ module Google end end - # Response message that is returned in LRO result of ListDeviceUsers Operation. - class ListDeviceUsersResponse - include Google::Apis::Core::Hashable - - # Devices meeting the list restrictions. - # Corresponds to the JSON property `deviceUsers` - # @return [Array] - attr_accessor :device_users - - # Token to retrieve the next page of results. Empty if there are no more - # results. - # 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) - @device_users = args[:device_users] if args.key?(:device_users) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # Response message that is returned in LRO result of ListDevices Operation. - class ListDevicesResponse - include Google::Apis::Core::Hashable - - # Devices meeting the list restrictions. - # Corresponds to the JSON property `devices` - # @return [Array] - attr_accessor :devices - - # Token to retrieve the next page of results. Empty if there are no more - # results. - # 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) - @devices = args[:devices] if args.key?(:devices) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # Response message for listing all apps on the device. - class ListEndpointAppsResponse - include Google::Apis::Core::Hashable - - # The list of matching EndpointApps found as a result of the request. - # Corresponds to the JSON property `endpointApps` - # @return [Array] - attr_accessor :endpoint_apps - - # Token to retrieve the next page of results. Empty if there are no more - # results. - # 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) - @endpoint_apps = args[:endpoint_apps] if args.key?(:endpoint_apps) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - # Response message for ListGroups operation. class ListGroupsResponse include Google::Apis::Core::Hashable @@ -949,45 +427,6 @@ module Google @message = args[:message] if args.key?(:message) end end - - # Response message for wiping all data on the device. - class WipeDeviceResponse - include Google::Apis::Core::Hashable - - # Represents a Device known to Google Cloud, independent of the device - # ownership, type, and whether it is assigned or in use by a user. - # Corresponds to the JSON property `device` - # @return [Google::Apis::CloudidentityV1::Device] - attr_accessor :device - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @device = args[:device] if args.key?(:device) - end - end - - # Response message for wiping the user's account from the device. - class WipeDeviceUserResponse - include Google::Apis::Core::Hashable - - # A DeviceUser is a resource representing a user's use of a Device - # Corresponds to the JSON property `deviceUser` - # @return [Google::Apis::CloudidentityV1::DeviceUser] - attr_accessor :device_user - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @device_user = args[:device_user] if args.key?(:device_user) - end - end end end end diff --git a/generated/google/apis/cloudidentity_v1/representations.rb b/generated/google/apis/cloudidentity_v1/representations.rb index 3132c8532..6a972091f 100644 --- a/generated/google/apis/cloudidentity_v1/representations.rb +++ b/generated/google/apis/cloudidentity_v1/representations.rb @@ -22,54 +22,6 @@ module Google module Apis module CloudidentityV1 - class AndroidAttributes - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ApproveDeviceUserResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BlockDeviceUserResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CancelWipeDeviceResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CancelWipeDeviceUserResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Device - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeviceUser - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class EndpointApp - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class EntityKey class Representation < Google::Apis::Core::JsonRepresentation; end @@ -82,24 +34,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class ListDeviceUsersResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListDevicesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListEndpointAppsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class ListGroupsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -154,123 +88,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class WipeDeviceResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class WipeDeviceUserResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AndroidAttributes - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :baseband_version, as: 'basebandVersion' - property :bootloader_version, as: 'bootloaderVersion' - property :build_number, as: 'buildNumber' - property :enabled_developer_options, as: 'enabledDeveloperOptions' - property :enabled_unknown_sources, as: 'enabledUnknownSources' - property :enabled_usb_debugging, as: 'enabledUsbDebugging' - property :encryption_state, as: 'encryptionState' - property :hardware, as: 'hardware' - property :kernel_version, as: 'kernelVersion' - collection :other_accounts, as: 'otherAccounts' - property :owner_profile_account, as: 'ownerProfileAccount' - property :ownership_privilege, as: 'ownershipPrivilege' - property :security_patch_time, as: 'securityPatchTime' - property :supports_work_profile, as: 'supportsWorkProfile' - end - end - - class ApproveDeviceUserResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :device_user, as: 'deviceUser', class: Google::Apis::CloudidentityV1::DeviceUser, decorator: Google::Apis::CloudidentityV1::DeviceUser::Representation - - end - end - - class BlockDeviceUserResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :device_user, as: 'deviceUser', class: Google::Apis::CloudidentityV1::DeviceUser, decorator: Google::Apis::CloudidentityV1::DeviceUser::Representation - - end - end - - class CancelWipeDeviceResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :device, as: 'device', class: Google::Apis::CloudidentityV1::Device, decorator: Google::Apis::CloudidentityV1::Device::Representation - - end - end - - class CancelWipeDeviceUserResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :device_user, as: 'deviceUser', class: Google::Apis::CloudidentityV1::DeviceUser, decorator: Google::Apis::CloudidentityV1::DeviceUser::Representation - - end - end - - class Device - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :android_specific_attributes, as: 'androidSpecificAttributes', class: Google::Apis::CloudidentityV1::AndroidAttributes, decorator: Google::Apis::CloudidentityV1::AndroidAttributes::Representation - - property :asset_tag, as: 'assetTag' - property :brand, as: 'brand' - property :compromised_state, as: 'compromisedState' - property :create_time, as: 'createTime' - property :device_type, as: 'deviceType' - property :imei, as: 'imei' - property :last_sync_time, as: 'lastSyncTime' - property :management_state, as: 'managementState' - property :manufacturer, as: 'manufacturer' - property :meid, as: 'meid' - property :model, as: 'model' - property :name, as: 'name' - property :network_operator, as: 'networkOperator' - property :os_version, as: 'osVersion' - property :owner_type, as: 'ownerType' - property :release_version, as: 'releaseVersion' - property :serial_number, as: 'serialNumber' - collection :wifi_mac_addresses, as: 'wifiMacAddresses' - end - end - - class DeviceUser - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :compromised_state, as: 'compromisedState' - property :first_sync_time, as: 'firstSyncTime' - property :language_code, as: 'languageCode' - property :last_sync_time, as: 'lastSyncTime' - property :management_state, as: 'managementState' - property :name, as: 'name' - property :password_state, as: 'passwordState' - property :user_agent, as: 'userAgent' - property :user_email, as: 'userEmail' - end - end - - class EndpointApp - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :display_name, as: 'displayName' - property :name, as: 'name' - property :package_name, as: 'packageName' - collection :permissions, as: 'permissions' - property :version_code, as: 'versionCode' - property :version_name, as: 'versionName' - end - end - class EntityKey # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -294,33 +111,6 @@ module Google end end - class ListDeviceUsersResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :device_users, as: 'deviceUsers', class: Google::Apis::CloudidentityV1::DeviceUser, decorator: Google::Apis::CloudidentityV1::DeviceUser::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class ListDevicesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :devices, as: 'devices', class: Google::Apis::CloudidentityV1::Device, decorator: Google::Apis::CloudidentityV1::Device::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class ListEndpointAppsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :endpoint_apps, as: 'endpointApps', class: Google::Apis::CloudidentityV1::EndpointApp, decorator: Google::Apis::CloudidentityV1::EndpointApp::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - class ListGroupsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -402,22 +192,6 @@ module Google property :message, as: 'message' end end - - class WipeDeviceResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :device, as: 'device', class: Google::Apis::CloudidentityV1::Device, decorator: Google::Apis::CloudidentityV1::Device::Representation - - end - end - - class WipeDeviceUserResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :device_user, as: 'deviceUser', class: Google::Apis::CloudidentityV1::DeviceUser, decorator: Google::Apis::CloudidentityV1::DeviceUser::Representation - - end - end end end end diff --git a/generated/google/apis/cloudidentity_v1beta1.rb b/generated/google/apis/cloudidentity_v1beta1.rb index 5047ffd43..6502a7c98 100644 --- a/generated/google/apis/cloudidentity_v1beta1.rb +++ b/generated/google/apis/cloudidentity_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/identity/ module CloudidentityV1beta1 VERSION = 'V1beta1' - REVISION = '20200303' + REVISION = '20200401' # See, change, create, and delete any of the Cloud Identity Groups that you can access, including the members of each group AUTH_CLOUD_IDENTITY_GROUPS = 'https://www.googleapis.com/auth/cloud-identity.groups' diff --git a/generated/google/apis/cloudidentity_v1beta1/classes.rb b/generated/google/apis/cloudidentity_v1beta1/classes.rb index 05869861b..b349057ca 100644 --- a/generated/google/apis/cloudidentity_v1beta1/classes.rb +++ b/generated/google/apis/cloudidentity_v1beta1/classes.rb @@ -22,6 +22,449 @@ module Google module Apis module CloudidentityV1beta1 + # Resource representing the Android specific attributes of a Device. + class AndroidAttributes + include Google::Apis::Core::Hashable + + # Baseband version of Android device. + # Corresponds to the JSON property `basebandVersion` + # @return [String] + attr_accessor :baseband_version + + # Device bootloader version. Example: 0.6.7. + # Corresponds to the JSON property `bootloaderVersion` + # @return [String] + attr_accessor :bootloader_version + + # Build number of Android device. + # Corresponds to the JSON property `buildNumber` + # @return [String] + attr_accessor :build_number + + # Whether developer options is enabled on device. + # Corresponds to the JSON property `enabledDeveloperOptions` + # @return [Boolean] + attr_accessor :enabled_developer_options + alias_method :enabled_developer_options?, :enabled_developer_options + + # Whether applications from unknown sources can be installed on device. + # Corresponds to the JSON property `enabledUnknownSources` + # @return [Boolean] + attr_accessor :enabled_unknown_sources + alias_method :enabled_unknown_sources?, :enabled_unknown_sources + + # Whether adb (USB debugging) is enabled on device. + # Corresponds to the JSON property `enabledUsbDebugging` + # @return [Boolean] + attr_accessor :enabled_usb_debugging + alias_method :enabled_usb_debugging?, :enabled_usb_debugging + + # Device encryption state. + # Corresponds to the JSON property `encryptionState` + # @return [String] + attr_accessor :encryption_state + + # Device hardware. Example: Sprout. + # Corresponds to the JSON property `hardware` + # @return [String] + attr_accessor :hardware + + # Kernel version of Android device. + # Corresponds to the JSON property `kernelVersion` + # @return [String] + attr_accessor :kernel_version + + # Domain name for Google accounts on device. Type for other accounts on + # device. Will only be populated if |ownership_privilege| is + # |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in + # to the device policy app if that account's domain has only one account. + # Examples: "com.example", "xyz.com". + # Corresponds to the JSON property `otherAccounts` + # @return [Array] + attr_accessor :other_accounts + + # Whether this account is on an owner/primary profile. + # For phones, only true for owner profiles. Android 4+ devices + # can have secondary or restricted user profiles. + # Corresponds to the JSON property `ownerProfileAccount` + # @return [Boolean] + attr_accessor :owner_profile_account + alias_method :owner_profile_account?, :owner_profile_account + + # Ownership privileges on device. + # Corresponds to the JSON property `ownershipPrivilege` + # @return [String] + attr_accessor :ownership_privilege + + # OS security patch update time on device. + # Corresponds to the JSON property `securityPatchTime` + # @return [String] + attr_accessor :security_patch_time + + # Whether device supports Android work profiles. If false, this service + # will not block access to corp data even if an administrator turns on the + # "Enforce Work Profile" policy. + # Corresponds to the JSON property `supportsWorkProfile` + # @return [Boolean] + attr_accessor :supports_work_profile + alias_method :supports_work_profile?, :supports_work_profile + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @baseband_version = args[:baseband_version] if args.key?(:baseband_version) + @bootloader_version = args[:bootloader_version] if args.key?(:bootloader_version) + @build_number = args[:build_number] if args.key?(:build_number) + @enabled_developer_options = args[:enabled_developer_options] if args.key?(:enabled_developer_options) + @enabled_unknown_sources = args[:enabled_unknown_sources] if args.key?(:enabled_unknown_sources) + @enabled_usb_debugging = args[:enabled_usb_debugging] if args.key?(:enabled_usb_debugging) + @encryption_state = args[:encryption_state] if args.key?(:encryption_state) + @hardware = args[:hardware] if args.key?(:hardware) + @kernel_version = args[:kernel_version] if args.key?(:kernel_version) + @other_accounts = args[:other_accounts] if args.key?(:other_accounts) + @owner_profile_account = args[:owner_profile_account] if args.key?(:owner_profile_account) + @ownership_privilege = args[:ownership_privilege] if args.key?(:ownership_privilege) + @security_patch_time = args[:security_patch_time] if args.key?(:security_patch_time) + @supports_work_profile = args[:supports_work_profile] if args.key?(:supports_work_profile) + end + end + + # Response message for approving the device to access user data. + class ApproveDeviceUserResponse + include Google::Apis::Core::Hashable + + # A DeviceUser is a resource representing a user's use of a Device + # Corresponds to the JSON property `deviceUser` + # @return [Google::Apis::CloudidentityV1beta1::DeviceUser] + attr_accessor :device_user + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @device_user = args[:device_user] if args.key?(:device_user) + end + end + + # Response message for blocking the device from accessing user data. + class BlockDeviceUserResponse + include Google::Apis::Core::Hashable + + # A DeviceUser is a resource representing a user's use of a Device + # Corresponds to the JSON property `deviceUser` + # @return [Google::Apis::CloudidentityV1beta1::DeviceUser] + attr_accessor :device_user + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @device_user = args[:device_user] if args.key?(:device_user) + end + end + + # Response message for cancelling an unfinished device wipe. + class CancelWipeDeviceResponse + include Google::Apis::Core::Hashable + + # Represents a Device known to Google Cloud, independent of the device + # ownership, type, and whether it is assigned or in use by a user. + # Corresponds to the JSON property `device` + # @return [Google::Apis::CloudidentityV1beta1::Device] + attr_accessor :device + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @device = args[:device] if args.key?(:device) + end + end + + # Response message for cancelling an unfinished user account wipe. + class CancelWipeDeviceUserResponse + include Google::Apis::Core::Hashable + + # A DeviceUser is a resource representing a user's use of a Device + # Corresponds to the JSON property `deviceUser` + # @return [Google::Apis::CloudidentityV1beta1::DeviceUser] + attr_accessor :device_user + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @device_user = args[:device_user] if args.key?(:device_user) + end + end + + # Represents a Device known to Google Cloud, independent of the device + # ownership, type, and whether it is assigned or in use by a user. + class Device + include Google::Apis::Core::Hashable + + # Resource representing the Android specific attributes of a Device. + # Corresponds to the JSON property `androidSpecificAttributes` + # @return [Google::Apis::CloudidentityV1beta1::AndroidAttributes] + attr_accessor :android_specific_attributes + + # Asset tag of the device. + # Corresponds to the JSON property `assetTag` + # @return [String] + attr_accessor :asset_tag + + # Output only. Device brand. Example: Samsung. + # Corresponds to the JSON property `brand` + # @return [String] + attr_accessor :brand + + # Output only. Represents whether the Device is compromised. + # Corresponds to the JSON property `compromisedState` + # @return [String] + attr_accessor :compromised_state + + # Output only. When the Company-Owned device was imported. This field is empty + # for BYOD + # devices. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Output only. Type of device. + # Corresponds to the JSON property `deviceType` + # @return [String] + attr_accessor :device_type + + # Output only. IMEI number of device if GSM device; empty otherwise. + # Corresponds to the JSON property `imei` + # @return [String] + attr_accessor :imei + + # Most recent time when device synced with this service. + # Corresponds to the JSON property `lastSyncTime` + # @return [String] + attr_accessor :last_sync_time + + # Output only. Management state of the device + # Corresponds to the JSON property `managementState` + # @return [String] + attr_accessor :management_state + + # Output only. Device manufacturer. Example: Motorola. + # Corresponds to the JSON property `manufacturer` + # @return [String] + attr_accessor :manufacturer + + # Output only. MEID number of device if CDMA device; empty otherwise. + # Corresponds to the JSON property `meid` + # @return [String] + attr_accessor :meid + + # Output only. Model name of device. Example: Pixel 3. + # Corresponds to the JSON property `model` + # @return [String] + attr_accessor :model + + # Output only. [Resource name](https://cloud.google.com/apis/design/ + # resource_names) + # of the Device in format: `devices/`device_id``, where device_id is + # the unique id assigned to the Device. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. Mobile or network operator of device, if available. + # Corresponds to the JSON property `networkOperator` + # @return [String] + attr_accessor :network_operator + + # Output only. OS version of the device. Example: Android 8.1.0. + # Corresponds to the JSON property `osVersion` + # @return [String] + attr_accessor :os_version + + # Whether the device is owned by the company or an individual + # Corresponds to the JSON property `ownerType` + # @return [String] + attr_accessor :owner_type + + # Output only. OS release version. Example: 6.0. + # Corresponds to the JSON property `releaseVersion` + # @return [String] + attr_accessor :release_version + + # Serial Number of device. Example: HT82V1A01076. + # Corresponds to the JSON property `serialNumber` + # @return [String] + attr_accessor :serial_number + + # WiFi MAC addresses of device. + # Corresponds to the JSON property `wifiMacAddresses` + # @return [Array] + attr_accessor :wifi_mac_addresses + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @android_specific_attributes = args[:android_specific_attributes] if args.key?(:android_specific_attributes) + @asset_tag = args[:asset_tag] if args.key?(:asset_tag) + @brand = args[:brand] if args.key?(:brand) + @compromised_state = args[:compromised_state] if args.key?(:compromised_state) + @create_time = args[:create_time] if args.key?(:create_time) + @device_type = args[:device_type] if args.key?(:device_type) + @imei = args[:imei] if args.key?(:imei) + @last_sync_time = args[:last_sync_time] if args.key?(:last_sync_time) + @management_state = args[:management_state] if args.key?(:management_state) + @manufacturer = args[:manufacturer] if args.key?(:manufacturer) + @meid = args[:meid] if args.key?(:meid) + @model = args[:model] if args.key?(:model) + @name = args[:name] if args.key?(:name) + @network_operator = args[:network_operator] if args.key?(:network_operator) + @os_version = args[:os_version] if args.key?(:os_version) + @owner_type = args[:owner_type] if args.key?(:owner_type) + @release_version = args[:release_version] if args.key?(:release_version) + @serial_number = args[:serial_number] if args.key?(:serial_number) + @wifi_mac_addresses = args[:wifi_mac_addresses] if args.key?(:wifi_mac_addresses) + end + end + + # A DeviceUser is a resource representing a user's use of a Device + class DeviceUser + include Google::Apis::Core::Hashable + + # Compromised State of the DeviceUser object + # Corresponds to the JSON property `compromisedState` + # @return [String] + attr_accessor :compromised_state + + # Output only. Most recent time when user registered with this service. + # Corresponds to the JSON property `firstSyncTime` + # @return [String] + attr_accessor :first_sync_time + + # Output only. Default locale used on device, in IETF BCP-47 format. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # Output only. Last time when user synced with policies. + # Corresponds to the JSON property `lastSyncTime` + # @return [String] + attr_accessor :last_sync_time + + # Output only. Management state of the user on the device. + # Corresponds to the JSON property `managementState` + # @return [String] + attr_accessor :management_state + + # Output only. [Resource name](https://cloud.google.com/apis/design/ + # resource_names) of + # the DeviceUser in format: `devices/`device_id`/deviceUsers/`user_id``, + # where user_id is the ID of the user associated with the user session. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Password state of the DeviceUser object + # Corresponds to the JSON property `passwordState` + # @return [String] + attr_accessor :password_state + + # Output only. User agent on the device for this specific user + # Corresponds to the JSON property `userAgent` + # @return [String] + attr_accessor :user_agent + + # Email address of the user registered on the device. + # Corresponds to the JSON property `userEmail` + # @return [String] + attr_accessor :user_email + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @compromised_state = args[:compromised_state] if args.key?(:compromised_state) + @first_sync_time = args[:first_sync_time] if args.key?(:first_sync_time) + @language_code = args[:language_code] if args.key?(:language_code) + @last_sync_time = args[:last_sync_time] if args.key?(:last_sync_time) + @management_state = args[:management_state] if args.key?(:management_state) + @name = args[:name] if args.key?(:name) + @password_state = args[:password_state] if args.key?(:password_state) + @user_agent = args[:user_agent] if args.key?(:user_agent) + @user_email = args[:user_email] if args.key?(:user_email) + end + end + + # An EndpointApp represents an app that is installed on a device + class EndpointApp + include Google::Apis::Core::Hashable + + # Output only. Name of the app displayed to the user + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. [Resource name](https://cloud.google.com/apis/design/ + # resource_names) of + # the EndpointApp in format: + # `devices/`device`/deviceUsers/`device_user`/endpointApps/`endpoint_app``, + # where client_app_id is the ID of the app associated with the Device. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. Full package name of the installed app + # Corresponds to the JSON property `packageName` + # @return [String] + attr_accessor :package_name + + # Output only. Names of all permissions granted to the installed app + # Corresponds to the JSON property `permissions` + # @return [Array] + attr_accessor :permissions + + # Output only. Version code of the installed app + # Corresponds to the JSON property `versionCode` + # @return [Fixnum] + attr_accessor :version_code + + # Output only. Version name of the installed app + # Corresponds to the JSON property `versionName` + # @return [String] + attr_accessor :version_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) + @name = args[:name] if args.key?(:name) + @package_name = args[:package_name] if args.key?(:package_name) + @permissions = args[:permissions] if args.key?(:permissions) + @version_code = args[:version_code] if args.key?(:version_code) + @version_name = args[:version_name] if args.key?(:version_name) + end + end + # A unique identifier for an entity in the Cloud Identity Groups API. # An entity can represent either a group with an optional `namespace` or a user # without a `namespace`. The combination of `id` and `namespace` must be @@ -44,7 +487,7 @@ module Google # as a Google user or a Google Group. # If specified, the `EntityKey` represents an external-identity-mapped group. # The namespace must correspond to an identity source created in Admin - # Console. Must be of the form `identitysources/`identity_source_id`. + # Console and must be in the form of `identitysources/`identity_source_id`. # Corresponds to the JSON property `namespace` # @return [String] attr_accessor :namespace @@ -60,8 +503,35 @@ module Google end end + # The response message for MembershipsService.GetMembershipGraph. + class GetMembershipGraphResponse + include Google::Apis::Core::Hashable + + # The membership graph's path information represented as an adjacency list. + # Corresponds to the JSON property `adjacencyList` + # @return [Array] + attr_accessor :adjacency_list + + # The resources representing each group in the adjacency list. Each + # group in this list can be correlated to a 'group' of the + # MembershipAdjacencyList using the 'name' of the Group resource. + # Corresponds to the JSON property `groups` + # @return [Array] + attr_accessor :groups + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @adjacency_list = args[:adjacency_list] if args.key?(:adjacency_list) + @groups = args[:groups] if args.key?(:groups) + end + end + # A group within the Cloud Identity Groups API. - # A `Group` is a collection of entities, where each entity is either a user or + # A `Group` is a collection of entities, where each entity is either a user, # another group or a service account. class Group include Google::Apis::Core::Hashable @@ -144,6 +614,84 @@ module Google end end + # Response message that is returned in LRO result of ListDeviceUsers Operation. + class ListDeviceUsersResponse + include Google::Apis::Core::Hashable + + # Devices meeting the list restrictions. + # Corresponds to the JSON property `deviceUsers` + # @return [Array] + attr_accessor :device_users + + # Token to retrieve the next page of results. Empty if there are no more + # results. + # 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) + @device_users = args[:device_users] if args.key?(:device_users) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Response message that is returned in LRO result of ListDevices Operation. + class ListDevicesResponse + include Google::Apis::Core::Hashable + + # Devices meeting the list restrictions. + # Corresponds to the JSON property `devices` + # @return [Array] + attr_accessor :devices + + # Token to retrieve the next page of results. Empty if there are no more + # results. + # 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) + @devices = args[:devices] if args.key?(:devices) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Response message for listing all apps on the device. + class ListEndpointAppsResponse + include Google::Apis::Core::Hashable + + # The list of matching EndpointApps found as a result of the request. + # Corresponds to the JSON property `endpointApps` + # @return [Array] + attr_accessor :endpoint_apps + + # Token to retrieve the next page of results. Empty if there are no more + # results. + # 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) + @endpoint_apps = args[:endpoint_apps] if args.key?(:endpoint_apps) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + # The response message for GroupsService.ListGroups. class ListGroupsResponse include Google::Apis::Core::Hashable @@ -238,6 +786,44 @@ module Google end end + # Response containing resource names of the DeviceUsers associated with the + # caller's credentials. + class LookupSelfDeviceUsersResponse + include Google::Apis::Core::Hashable + + # The obfuscated customer Id that may be passed back to other + # Devices API methods such as List, Get, etc. + # Corresponds to the JSON property `customer` + # @return [String] + attr_accessor :customer + + # [Resource names](https://cloud.google.com/apis/design/resource_names) of + # the DeviceUsers in the format: + # `devices/`device_id`/deviceUsers/`user_resource_id``, where + # device_id is the unique ID assigned to a Device and + # user_resource_id is the unique user ID + # Corresponds to the JSON property `names` + # @return [Array] + attr_accessor :names + + # Token to retrieve the next page of results. Empty if there are no more + # results. + # 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) + @customer = args[:customer] if args.key?(:customer) + @names = args[:names] if args.key?(:names) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + # A membership within the Cloud Identity Groups API. # A `Membership` defines a relationship between a `Group` and an entity # belonging to that `Group`, referred to as a "member". @@ -300,6 +886,31 @@ module Google end end + # Membership graph's path information as an adjacency list. + class MembershipAdjacencyList + include Google::Apis::Core::Hashable + + # Each edge contains information about the member that belongs to this group. + # Corresponds to the JSON property `edges` + # @return [Array] + attr_accessor :edges + + # Resource name of the group that the members belong to. + # Corresponds to the JSON property `group` + # @return [String] + attr_accessor :group + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @edges = args[:edges] if args.key?(:edges) + @group = args[:group] if args.key?(:group) + end + end + # A membership role within the Cloud Identity Groups API. # A `MembershipRole` defines the privileges granted to a `Membership`. class MembershipRole @@ -540,6 +1151,45 @@ module Google @membership_role = args[:membership_role] if args.key?(:membership_role) end end + + # Response message for wiping all data on the device. + class WipeDeviceResponse + include Google::Apis::Core::Hashable + + # Represents a Device known to Google Cloud, independent of the device + # ownership, type, and whether it is assigned or in use by a user. + # Corresponds to the JSON property `device` + # @return [Google::Apis::CloudidentityV1beta1::Device] + attr_accessor :device + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @device = args[:device] if args.key?(:device) + end + end + + # Response message for wiping the user's account from the device. + class WipeDeviceUserResponse + include Google::Apis::Core::Hashable + + # A DeviceUser is a resource representing a user's use of a Device + # Corresponds to the JSON property `deviceUser` + # @return [Google::Apis::CloudidentityV1beta1::DeviceUser] + attr_accessor :device_user + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @device_user = args[:device_user] if args.key?(:device_user) + end + end end end end diff --git a/generated/google/apis/cloudidentity_v1beta1/representations.rb b/generated/google/apis/cloudidentity_v1beta1/representations.rb index 43c52a1e9..7723eb424 100644 --- a/generated/google/apis/cloudidentity_v1beta1/representations.rb +++ b/generated/google/apis/cloudidentity_v1beta1/representations.rb @@ -22,18 +22,90 @@ module Google module Apis module CloudidentityV1beta1 + class AndroidAttributes + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApproveDeviceUserResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BlockDeviceUserResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CancelWipeDeviceResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CancelWipeDeviceUserResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Device + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeviceUser + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EndpointApp + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class EntityKey class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GetMembershipGraphResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Group class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class ListDeviceUsersResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListDevicesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListEndpointAppsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ListGroupsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -58,12 +130,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class LookupSelfDeviceUsersResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Membership class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class MembershipAdjacencyList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class MembershipRole class Representation < Google::Apis::Core::JsonRepresentation; end @@ -106,6 +190,123 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class WipeDeviceResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class WipeDeviceUserResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AndroidAttributes + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :baseband_version, as: 'basebandVersion' + property :bootloader_version, as: 'bootloaderVersion' + property :build_number, as: 'buildNumber' + property :enabled_developer_options, as: 'enabledDeveloperOptions' + property :enabled_unknown_sources, as: 'enabledUnknownSources' + property :enabled_usb_debugging, as: 'enabledUsbDebugging' + property :encryption_state, as: 'encryptionState' + property :hardware, as: 'hardware' + property :kernel_version, as: 'kernelVersion' + collection :other_accounts, as: 'otherAccounts' + property :owner_profile_account, as: 'ownerProfileAccount' + property :ownership_privilege, as: 'ownershipPrivilege' + property :security_patch_time, as: 'securityPatchTime' + property :supports_work_profile, as: 'supportsWorkProfile' + end + end + + class ApproveDeviceUserResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :device_user, as: 'deviceUser', class: Google::Apis::CloudidentityV1beta1::DeviceUser, decorator: Google::Apis::CloudidentityV1beta1::DeviceUser::Representation + + end + end + + class BlockDeviceUserResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :device_user, as: 'deviceUser', class: Google::Apis::CloudidentityV1beta1::DeviceUser, decorator: Google::Apis::CloudidentityV1beta1::DeviceUser::Representation + + end + end + + class CancelWipeDeviceResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :device, as: 'device', class: Google::Apis::CloudidentityV1beta1::Device, decorator: Google::Apis::CloudidentityV1beta1::Device::Representation + + end + end + + class CancelWipeDeviceUserResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :device_user, as: 'deviceUser', class: Google::Apis::CloudidentityV1beta1::DeviceUser, decorator: Google::Apis::CloudidentityV1beta1::DeviceUser::Representation + + end + end + + class Device + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :android_specific_attributes, as: 'androidSpecificAttributes', class: Google::Apis::CloudidentityV1beta1::AndroidAttributes, decorator: Google::Apis::CloudidentityV1beta1::AndroidAttributes::Representation + + property :asset_tag, as: 'assetTag' + property :brand, as: 'brand' + property :compromised_state, as: 'compromisedState' + property :create_time, as: 'createTime' + property :device_type, as: 'deviceType' + property :imei, as: 'imei' + property :last_sync_time, as: 'lastSyncTime' + property :management_state, as: 'managementState' + property :manufacturer, as: 'manufacturer' + property :meid, as: 'meid' + property :model, as: 'model' + property :name, as: 'name' + property :network_operator, as: 'networkOperator' + property :os_version, as: 'osVersion' + property :owner_type, as: 'ownerType' + property :release_version, as: 'releaseVersion' + property :serial_number, as: 'serialNumber' + collection :wifi_mac_addresses, as: 'wifiMacAddresses' + end + end + + class DeviceUser + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :compromised_state, as: 'compromisedState' + property :first_sync_time, as: 'firstSyncTime' + property :language_code, as: 'languageCode' + property :last_sync_time, as: 'lastSyncTime' + property :management_state, as: 'managementState' + property :name, as: 'name' + property :password_state, as: 'passwordState' + property :user_agent, as: 'userAgent' + property :user_email, as: 'userEmail' + end + end + + class EndpointApp + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :name, as: 'name' + property :package_name, as: 'packageName' + collection :permissions, as: 'permissions' + property :version_code, as: 'versionCode' + property :version_name, as: 'versionName' + end + end + class EntityKey # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -114,6 +315,16 @@ module Google end end + class GetMembershipGraphResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :adjacency_list, as: 'adjacencyList', class: Google::Apis::CloudidentityV1beta1::MembershipAdjacencyList, decorator: Google::Apis::CloudidentityV1beta1::MembershipAdjacencyList::Representation + + collection :groups, as: 'groups', class: Google::Apis::CloudidentityV1beta1::Group, decorator: Google::Apis::CloudidentityV1beta1::Group::Representation + + end + end + class Group # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -131,6 +342,33 @@ module Google end end + class ListDeviceUsersResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :device_users, as: 'deviceUsers', class: Google::Apis::CloudidentityV1beta1::DeviceUser, decorator: Google::Apis::CloudidentityV1beta1::DeviceUser::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListDevicesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :devices, as: 'devices', class: Google::Apis::CloudidentityV1beta1::Device, decorator: Google::Apis::CloudidentityV1beta1::Device::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListEndpointAppsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :endpoint_apps, as: 'endpointApps', class: Google::Apis::CloudidentityV1beta1::EndpointApp, decorator: Google::Apis::CloudidentityV1beta1::EndpointApp::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + class ListGroupsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -163,6 +401,15 @@ module Google end end + class LookupSelfDeviceUsersResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer, as: 'customer' + collection :names, as: 'names' + property :next_page_token, as: 'nextPageToken' + end + end + class Membership # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -178,6 +425,15 @@ module Google end end + class MembershipAdjacencyList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :edges, as: 'edges', class: Google::Apis::CloudidentityV1beta1::Membership, decorator: Google::Apis::CloudidentityV1beta1::Membership::Representation + + property :group, as: 'group' + end + end + class MembershipRole # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -242,6 +498,22 @@ module Google end end + + class WipeDeviceResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :device, as: 'device', class: Google::Apis::CloudidentityV1beta1::Device, decorator: Google::Apis::CloudidentityV1beta1::Device::Representation + + end + end + + class WipeDeviceUserResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :device_user, as: 'deviceUser', class: Google::Apis::CloudidentityV1beta1::DeviceUser, decorator: Google::Apis::CloudidentityV1beta1::DeviceUser::Representation + + end + end end end end diff --git a/generated/google/apis/cloudidentity_v1beta1/service.rb b/generated/google/apis/cloudidentity_v1beta1/service.rb index 8fb88c46e..ccf3f4392 100644 --- a/generated/google/apis/cloudidentity_v1beta1/service.rb +++ b/generated/google/apis/cloudidentity_v1beta1/service.rb @@ -210,7 +210,7 @@ module Google # as a Google user or a Google Group. # If specified, the `EntityKey` represents an external-identity-mapped group. # The namespace must correspond to an identity source created in Admin - # Console. Must be of the form `identitysources/`identity_source_id`. + # Console and must be in the form of `identitysources/`identity_source_id`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -504,7 +504,7 @@ module Google # as a Google user or a Google Group. # If specified, the `EntityKey` represents an external-identity-mapped group. # The namespace must correspond to an identity source created in Admin - # Console. Must be of the form `identitysources/`identity_source_id`. + # Console and must be in the form of `identitysources/`identity_source_id`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/cloudprivatecatalog_v1beta1/classes.rb b/generated/google/apis/cloudprivatecatalog_v1beta1/classes.rb deleted file mode 100644 index d4e4b97c5..000000000 --- a/generated/google/apis/cloudprivatecatalog_v1beta1/classes.rb +++ /dev/null @@ -1,358 +0,0 @@ -# Copyright 2015 Google Inc. -# -# 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 CloudprivatecatalogV1beta1 - - # The readonly representation of a catalog computed with a given resource - # context. - class GoogleCloudPrivatecatalogV1beta1Catalog - include Google::Apis::Core::Hashable - - # Output only. The time when the catalog was created. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Output only. The description of the catalog. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # Output only. The descriptive name of the catalog as it appears in UIs. - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # Output only. The resource name of the target catalog, in the format of - # `catalogs/`catalog_id`'. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Output only. The time when the catalog was last updated. - # 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) - @description = args[:description] if args.key?(:description) - @display_name = args[:display_name] if args.key?(:display_name) - @name = args[:name] if args.key?(:name) - @update_time = args[:update_time] if args.key?(:update_time) - end - end - - # The readonly representation of a product computed with a given resource - # context. - class GoogleCloudPrivatecatalogV1beta1Product - include Google::Apis::Core::Hashable - - # Output only. The type of the product asset. It can be one of the - # following values: - # * `google.deploymentmanager.Template` - # * `google.cloudprivatecatalog.ListingOnly` - # Corresponds to the JSON property `assetType` - # @return [String] - attr_accessor :asset_type - - # Output only. The time when the product was created. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Output only. The display metadata to describe the product. - # The JSON schema of the metadata differs by Product.asset_type. - # When the type is `google.deploymentmanager.Template`, the schema is as - # follows: - # ``` - # "$schema": http://json-schema.org/draft-04/schema# - # type: object - # properties: - # name: - # type: string - # minLength: 1 - # maxLength: 64 - # description: - # type: string - # minLength: 1 - # maxLength: 2048 - # tagline: - # type: string - # minLength: 1 - # maxLength: 100 - # support_info: - # type: string - # minLength: 1 - # maxLength: 2048 - # creator: - # type: string - # minLength: 1 - # maxLength: 100 - # documentation: - # type: array - # items: - # type: object - # properties: - # url: - # type: string - # pattern: - # "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" - # title: - # type: string - # minLength: 1 - # maxLength: 64 - # description: - # type: string - # minLength: 1 - # maxLength: 2048 - # required: - # - name - # - description - # additionalProperties: false - # ``` - # When the asset type is `google.cloudprivatecatalog.ListingOnly`, the schema - # is as follows: - # ``` - # "$schema": http://json-schema.org/draft-04/schema# - # type: object - # properties: - # name: - # type: string - # minLength: 1 - # maxLength: 64 - # description: - # type: string - # minLength: 1 - # maxLength: 2048 - # tagline: - # type: string - # minLength: 1 - # maxLength: 100 - # support_info: - # type: string - # minLength: 1 - # maxLength: 2048 - # creator: - # type: string - # minLength: 1 - # maxLength: 100 - # documentation: - # type: array - # items: - # type: object - # properties: - # url: - # type: string - # pattern: - # "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" - # title: - # type: string - # minLength: 1 - # maxLength: 64 - # description: - # type: string - # minLength: 1 - # maxLength: 2048 - # signup_url: - # type: string - # pattern: - # "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" - # required: - # - name - # - description - # - signup_url - # additionalProperties: false - # ``` - # Corresponds to the JSON property `displayMetadata` - # @return [Hash] - attr_accessor :display_metadata - - # Output only. The icon URI of the product. - # Corresponds to the JSON property `iconUri` - # @return [String] - attr_accessor :icon_uri - - # Output only. The resource name of the target product, in the format of - # `products/a-z*[a-z0-9]'. - # A unique identifier for the product under a catalog. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Output only. The time when the product was last updated. - # 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) - @asset_type = args[:asset_type] if args.key?(:asset_type) - @create_time = args[:create_time] if args.key?(:create_time) - @display_metadata = args[:display_metadata] if args.key?(:display_metadata) - @icon_uri = args[:icon_uri] if args.key?(:icon_uri) - @name = args[:name] if args.key?(:name) - @update_time = args[:update_time] if args.key?(:update_time) - end - end - - # Response message for PrivateCatalog.SearchCatalogs. - class GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse - include Google::Apis::Core::Hashable - - # The `Catalog`s computed from the resource context. - # Corresponds to the JSON property `catalogs` - # @return [Array] - attr_accessor :catalogs - - # A pagination token returned from a previous call to SearchCatalogs that - # indicates from where listing should continue. - # This field is optional. - # 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) - @catalogs = args[:catalogs] if args.key?(:catalogs) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # Response message for PrivateCatalog.SearchProducts. - class GoogleCloudPrivatecatalogV1beta1SearchProductsResponse - include Google::Apis::Core::Hashable - - # A pagination token returned from a previous call to SearchProducts that - # indicates from where listing should continue. - # This field is optional. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # The `Product` resources computed from the resource context. - # Corresponds to the JSON property `products` - # @return [Array] - attr_accessor :products - - 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) - @products = args[:products] if args.key?(:products) - end - end - - # Response message for PrivateCatalog.SearchVersions. - class GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse - include Google::Apis::Core::Hashable - - # A pagination token returned from a previous call to SearchVersions that - # indicates from where the listing should continue. - # This field is optional. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # The `Version` resources computed from the resource context. - # Corresponds to the JSON property `versions` - # @return [Array] - attr_accessor :versions - - 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) - @versions = args[:versions] if args.key?(:versions) - end - end - - # The consumer representation of a version which is a child resource under a - # `Product` with asset data. - class GoogleCloudPrivatecatalogV1beta1Version - include Google::Apis::Core::Hashable - - # Output only. The asset which has been validated and is ready to be - # provisioned. See - # google.cloud.privatecatalogproducer.v1beta.Version.asset for details. - # Corresponds to the JSON property `asset` - # @return [Hash] - attr_accessor :asset - - # Output only. The time when the version was created. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Output only. The user-supplied description of the version. Maximum of 256 - # characters. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # Output only. The resource name of the version, in the format - # `catalogs/`catalog_id`/products/`product_id`/versions/a-z*[a-z0-9]'. - # A unique identifier for the version under a product. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Output only. The time when the version was last updated. - # 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) - @asset = args[:asset] if args.key?(:asset) - @create_time = args[:create_time] if args.key?(:create_time) - @description = args[:description] if args.key?(:description) - @name = args[:name] if args.key?(:name) - @update_time = args[:update_time] if args.key?(:update_time) - end - end - end - end -end diff --git a/generated/google/apis/cloudprivatecatalog_v1beta1/representations.rb b/generated/google/apis/cloudprivatecatalog_v1beta1/representations.rb deleted file mode 100644 index 49c45561a..000000000 --- a/generated/google/apis/cloudprivatecatalog_v1beta1/representations.rb +++ /dev/null @@ -1,123 +0,0 @@ -# Copyright 2015 Google Inc. -# -# 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 CloudprivatecatalogV1beta1 - - class GoogleCloudPrivatecatalogV1beta1Catalog - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogV1beta1Product - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogV1beta1SearchProductsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogV1beta1Version - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogV1beta1Catalog - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :create_time, as: 'createTime' - property :description, as: 'description' - property :display_name, as: 'displayName' - property :name, as: 'name' - property :update_time, as: 'updateTime' - end - end - - class GoogleCloudPrivatecatalogV1beta1Product - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :asset_type, as: 'assetType' - property :create_time, as: 'createTime' - hash :display_metadata, as: 'displayMetadata' - property :icon_uri, as: 'iconUri' - property :name, as: 'name' - property :update_time, as: 'updateTime' - end - end - - class GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :catalogs, as: 'catalogs', class: Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1Catalog, decorator: Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1Catalog::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class GoogleCloudPrivatecatalogV1beta1SearchProductsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :products, as: 'products', class: Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1Product, decorator: Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1Product::Representation - - end - end - - class GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :versions, as: 'versions', class: Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1Version, decorator: Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1Version::Representation - - end - end - - class GoogleCloudPrivatecatalogV1beta1Version - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :asset, as: 'asset' - property :create_time, as: 'createTime' - property :description, as: 'description' - property :name, as: 'name' - property :update_time, as: 'updateTime' - end - end - end - end -end diff --git a/generated/google/apis/cloudprivatecatalog_v1beta1/service.rb b/generated/google/apis/cloudprivatecatalog_v1beta1/service.rb deleted file mode 100644 index 4a562e08a..000000000 --- a/generated/google/apis/cloudprivatecatalog_v1beta1/service.rb +++ /dev/null @@ -1,486 +0,0 @@ -# Copyright 2015 Google Inc. -# -# 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 '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 CloudprivatecatalogV1beta1 - # Cloud Private Catalog API - # - # Enable cloud users to discover enterprise catalogs and products in their - # organizations. - # - # @example - # require 'google/apis/cloudprivatecatalog_v1beta1' - # - # Cloudprivatecatalog = Google::Apis::CloudprivatecatalogV1beta1 # Alias the module - # service = Cloudprivatecatalog::CloudPrivateCatalogService.new - # - # @see https://cloud.google.com/private-catalog/ - class CloudPrivateCatalogService < Google::Apis::Core::BaseService - # @return [String] - # API key. Your API key identifies your project and provides you with API access, - # quota, and reports. Required unless you provide an OAuth 2.0 token. - attr_accessor :key - - # @return [String] - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - attr_accessor :quota_user - - def initialize - super('https://cloudprivatecatalog.googleapis.com/', '') - @batch_path = 'batch' - end - - # Search Catalog resources that consumers have access to, within the - # scope of the consumer cloud resource hierarchy context. - # @param [String] resource - # Required. The name of the resource context. It can be in following formats: - # * `projects/`project_id`` - # * `folders/`folder_id`` - # * `organizations/`organization_id`` - # @param [Fixnum] page_size - # The maximum number of entries that are requested. - # @param [String] page_token - # A pagination token returned from a previous call to SearchCatalogs that - # indicates where this listing should continue from. - # This field is optional. - # @param [String] query - # The query to filter the catalogs. The supported queries are: - # * Get a single catalog: `name=catalogs/`catalog_id`` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def search_folder_catalogs(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+resource}/catalogs:search', options) - command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse::Representation - command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse - command.params['resource'] = resource unless resource.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['query'] = query unless query.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Search Product resources that consumers have access to, within the - # scope of the consumer cloud resource hierarchy context. - # @param [String] resource - # Required. The name of the resource context. See - # SearchCatalogsRequest.resource for details. - # @param [Fixnum] page_size - # The maximum number of entries that are requested. - # @param [String] page_token - # A pagination token returned from a previous call to SearchProducts that - # indicates where this listing should continue from. - # This field is optional. - # @param [String] query - # The query to filter the products. - # The supported queries are: - # * List products of all catalogs: empty - # * List products under a catalog: `parent=catalogs/`catalog_id`` - # * Get a product by name: - # `name=catalogs/`catalog_id`/products/`product_id`` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def search_folder_products(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+resource}/products:search', options) - command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse::Representation - command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse - command.params['resource'] = resource unless resource.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['query'] = query unless query.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Search Version resources that consumers have access to, within the - # scope of the consumer cloud resource hierarchy context. - # @param [String] resource - # Required. The name of the resource context. See - # SearchCatalogsRequest.resource for details. - # @param [Fixnum] page_size - # The maximum number of entries that are requested. - # @param [String] page_token - # A pagination token returned from a previous call to SearchVersions - # that indicates where this listing should continue from. - # This field is optional. - # @param [String] query - # The query to filter the versions. Required. - # The supported queries are: - # * List versions under a product: - # `parent=catalogs/`catalog_id`/products/`product_id`` - # * Get a version by name: - # `name=catalogs/`catalog_id`/products/`product_id`/versions/`version_id`` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def search_folder_versions(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+resource}/versions:search', options) - command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse::Representation - command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse - command.params['resource'] = resource unless resource.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['query'] = query unless query.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Search Catalog resources that consumers have access to, within the - # scope of the consumer cloud resource hierarchy context. - # @param [String] resource - # Required. The name of the resource context. It can be in following formats: - # * `projects/`project_id`` - # * `folders/`folder_id`` - # * `organizations/`organization_id`` - # @param [Fixnum] page_size - # The maximum number of entries that are requested. - # @param [String] page_token - # A pagination token returned from a previous call to SearchCatalogs that - # indicates where this listing should continue from. - # This field is optional. - # @param [String] query - # The query to filter the catalogs. The supported queries are: - # * Get a single catalog: `name=catalogs/`catalog_id`` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def search_organization_catalogs(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+resource}/catalogs:search', options) - command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse::Representation - command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse - command.params['resource'] = resource unless resource.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['query'] = query unless query.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Search Product resources that consumers have access to, within the - # scope of the consumer cloud resource hierarchy context. - # @param [String] resource - # Required. The name of the resource context. See - # SearchCatalogsRequest.resource for details. - # @param [Fixnum] page_size - # The maximum number of entries that are requested. - # @param [String] page_token - # A pagination token returned from a previous call to SearchProducts that - # indicates where this listing should continue from. - # This field is optional. - # @param [String] query - # The query to filter the products. - # The supported queries are: - # * List products of all catalogs: empty - # * List products under a catalog: `parent=catalogs/`catalog_id`` - # * Get a product by name: - # `name=catalogs/`catalog_id`/products/`product_id`` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def search_organization_products(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+resource}/products:search', options) - command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse::Representation - command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse - command.params['resource'] = resource unless resource.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['query'] = query unless query.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Search Version resources that consumers have access to, within the - # scope of the consumer cloud resource hierarchy context. - # @param [String] resource - # Required. The name of the resource context. See - # SearchCatalogsRequest.resource for details. - # @param [Fixnum] page_size - # The maximum number of entries that are requested. - # @param [String] page_token - # A pagination token returned from a previous call to SearchVersions - # that indicates where this listing should continue from. - # This field is optional. - # @param [String] query - # The query to filter the versions. Required. - # The supported queries are: - # * List versions under a product: - # `parent=catalogs/`catalog_id`/products/`product_id`` - # * Get a version by name: - # `name=catalogs/`catalog_id`/products/`product_id`/versions/`version_id`` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def search_organization_versions(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+resource}/versions:search', options) - command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse::Representation - command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse - command.params['resource'] = resource unless resource.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['query'] = query unless query.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Search Catalog resources that consumers have access to, within the - # scope of the consumer cloud resource hierarchy context. - # @param [String] resource - # Required. The name of the resource context. It can be in following formats: - # * `projects/`project_id`` - # * `folders/`folder_id`` - # * `organizations/`organization_id`` - # @param [Fixnum] page_size - # The maximum number of entries that are requested. - # @param [String] page_token - # A pagination token returned from a previous call to SearchCatalogs that - # indicates where this listing should continue from. - # This field is optional. - # @param [String] query - # The query to filter the catalogs. The supported queries are: - # * Get a single catalog: `name=catalogs/`catalog_id`` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def search_project_catalogs(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+resource}/catalogs:search', options) - command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse::Representation - command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse - command.params['resource'] = resource unless resource.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['query'] = query unless query.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Search Product resources that consumers have access to, within the - # scope of the consumer cloud resource hierarchy context. - # @param [String] resource - # Required. The name of the resource context. See - # SearchCatalogsRequest.resource for details. - # @param [Fixnum] page_size - # The maximum number of entries that are requested. - # @param [String] page_token - # A pagination token returned from a previous call to SearchProducts that - # indicates where this listing should continue from. - # This field is optional. - # @param [String] query - # The query to filter the products. - # The supported queries are: - # * List products of all catalogs: empty - # * List products under a catalog: `parent=catalogs/`catalog_id`` - # * Get a product by name: - # `name=catalogs/`catalog_id`/products/`product_id`` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def search_project_products(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+resource}/products:search', options) - command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse::Representation - command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchProductsResponse - command.params['resource'] = resource unless resource.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['query'] = query unless query.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Search Version resources that consumers have access to, within the - # scope of the consumer cloud resource hierarchy context. - # @param [String] resource - # Required. The name of the resource context. See - # SearchCatalogsRequest.resource for details. - # @param [Fixnum] page_size - # The maximum number of entries that are requested. - # @param [String] page_token - # A pagination token returned from a previous call to SearchVersions - # that indicates where this listing should continue from. - # This field is optional. - # @param [String] query - # The query to filter the versions. Required. - # The supported queries are: - # * List versions under a product: - # `parent=catalogs/`catalog_id`/products/`product_id`` - # * Get a version by name: - # `name=catalogs/`catalog_id`/products/`product_id`/versions/`version_id`` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def search_project_versions(resource, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+resource}/versions:search', options) - command.response_representation = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse::Representation - command.response_class = Google::Apis::CloudprivatecatalogV1beta1::GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse - command.params['resource'] = resource unless resource.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['query'] = query unless query.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - protected - - def apply_command_defaults(command) - command.query['key'] = key unless key.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - end - end - end - end -end diff --git a/generated/google/apis/cloudprivatecatalogproducer_v1beta1/representations.rb b/generated/google/apis/cloudprivatecatalogproducer_v1beta1/representations.rb deleted file mode 100644 index 621b8876d..000000000 --- a/generated/google/apis/cloudprivatecatalogproducer_v1beta1/representations.rb +++ /dev/null @@ -1,399 +0,0 @@ -# Copyright 2015 Google Inc. -# -# 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 CloudprivatecatalogproducerV1beta1 - - class GoogleCloudPrivatecatalogproducerV1beta1Association - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogproducerV1beta1Catalog - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogproducerV1beta1CopyProductRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogproducerV1beta1CreateAssociationRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogproducerV1beta1ListAssociationsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogproducerV1beta1ListCatalogsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogproducerV1beta1ListProductsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogproducerV1beta1ListVersionsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogproducerV1beta1Product - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogproducerV1beta1UndeleteCatalogRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogproducerV1beta1UploadIconRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogproducerV1beta1Version - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleIamV1AuditConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleIamV1AuditLogConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleIamV1Binding - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleIamV1Policy - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleIamV1SetIamPolicyRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleIamV1TestIamPermissionsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleIamV1TestIamPermissionsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleLongrunningCancelOperationRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleLongrunningListOperationsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleLongrunningOperation - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleProtobufEmpty - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleRpcStatus - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleTypeExpr - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudPrivatecatalogproducerV1beta1Association - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :create_time, as: 'createTime' - property :name, as: 'name' - property :resource, as: 'resource' - end - end - - class GoogleCloudPrivatecatalogproducerV1beta1Catalog - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :create_time, as: 'createTime' - property :description, as: 'description' - property :display_name, as: 'displayName' - property :name, as: 'name' - property :parent, as: 'parent' - property :update_time, as: 'updateTime' - end - end - - class GoogleCloudPrivatecatalogproducerV1beta1CopyProductRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :destination_product_name, as: 'destinationProductName' - end - end - - class GoogleCloudPrivatecatalogproducerV1beta1CreateAssociationRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :association, as: 'association', class: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Association, decorator: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Association::Representation - - end - end - - class GoogleCloudPrivatecatalogproducerV1beta1ListAssociationsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :associations, as: 'associations', class: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Association, decorator: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Association::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class GoogleCloudPrivatecatalogproducerV1beta1ListCatalogsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :catalogs, as: 'catalogs', class: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog, decorator: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class GoogleCloudPrivatecatalogproducerV1beta1ListProductsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :products, as: 'products', class: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product, decorator: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product::Representation - - end - end - - class GoogleCloudPrivatecatalogproducerV1beta1ListVersionsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :versions, as: 'versions', class: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Version, decorator: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Version::Representation - - end - end - - class GoogleCloudPrivatecatalogproducerV1beta1Product - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :asset_type, as: 'assetType' - property :create_time, as: 'createTime' - hash :display_metadata, as: 'displayMetadata' - property :icon_uri, as: 'iconUri' - property :name, as: 'name' - property :update_time, as: 'updateTime' - end - end - - class GoogleCloudPrivatecatalogproducerV1beta1UndeleteCatalogRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - - class GoogleCloudPrivatecatalogproducerV1beta1UploadIconRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :icon, :base64 => true, as: 'icon' - end - end - - class GoogleCloudPrivatecatalogproducerV1beta1Version - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :asset, as: 'asset' - property :create_time, as: 'createTime' - property :description, as: 'description' - property :name, as: 'name' - hash :original_asset, as: 'originalAsset' - property :update_time, as: 'updateTime' - end - end - - class GoogleIamV1AuditConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1AuditLogConfig, decorator: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1AuditLogConfig::Representation - - property :service, as: 'service' - end - end - - class GoogleIamV1AuditLogConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :exempted_members, as: 'exemptedMembers' - property :log_type, as: 'logType' - end - end - - class GoogleIamV1Binding - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :condition, as: 'condition', class: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleTypeExpr, decorator: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleTypeExpr::Representation - - collection :members, as: 'members' - property :role, as: 'role' - end - end - - class GoogleIamV1Policy - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :audit_configs, as: 'auditConfigs', class: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1AuditConfig, decorator: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1AuditConfig::Representation - - collection :bindings, as: 'bindings', class: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1Binding, decorator: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1Binding::Representation - - property :etag, :base64 => true, as: 'etag' - property :version, as: 'version' - end - end - - class GoogleIamV1SetIamPolicyRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :policy, as: 'policy', class: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1Policy, decorator: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1Policy::Representation - - property :update_mask, as: 'updateMask' - end - end - - class GoogleIamV1TestIamPermissionsRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :permissions, as: 'permissions' - end - end - - class GoogleIamV1TestIamPermissionsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :permissions, as: 'permissions' - end - end - - class GoogleLongrunningCancelOperationRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - - class GoogleLongrunningListOperationsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :operations, as: 'operations', class: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation, decorator: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation::Representation - - end - end - - class GoogleLongrunningOperation - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :done, as: 'done' - property :error, as: 'error', class: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleRpcStatus, decorator: Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleRpcStatus::Representation - - hash :metadata, as: 'metadata' - property :name, as: 'name' - hash :response, as: 'response' - end - end - - class GoogleProtobufEmpty - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - - class GoogleRpcStatus - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :code, as: 'code' - collection :details, as: 'details' - property :message, as: 'message' - end - end - - class GoogleTypeExpr - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :description, as: 'description' - property :expression, as: 'expression' - property :location, as: 'location' - property :title, as: 'title' - end - end - end - end -end diff --git a/generated/google/apis/cloudprivatecatalogproducer_v1beta1/service.rb b/generated/google/apis/cloudprivatecatalogproducer_v1beta1/service.rb deleted file mode 100644 index 5aea695e9..000000000 --- a/generated/google/apis/cloudprivatecatalogproducer_v1beta1/service.rb +++ /dev/null @@ -1,1081 +0,0 @@ -# Copyright 2015 Google Inc. -# -# 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 '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 CloudprivatecatalogproducerV1beta1 - # Cloud Private Catalog Producer API - # - # Enables cloud users to manage and share enterprise catalogs intheir - # organizations. - # - # @example - # require 'google/apis/cloudprivatecatalogproducer_v1beta1' - # - # Cloudprivatecatalogproducer = Google::Apis::CloudprivatecatalogproducerV1beta1 # Alias the module - # service = Cloudprivatecatalogproducer::CloudPrivateCatalogProducerService.new - # - # @see https://cloud.google.com/private-catalog/ - class CloudPrivateCatalogProducerService < Google::Apis::Core::BaseService - # @return [String] - # API key. Your API key identifies your project and provides you with API access, - # quota, and reports. Required unless you provide an OAuth 2.0 token. - attr_accessor :key - - # @return [String] - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - attr_accessor :quota_user - - def initialize - super('https://cloudprivatecatalogproducer.googleapis.com/', '') - @batch_path = 'batch' - end - - # Creates a new Catalog resource. - # @param [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog] google_cloud_privatecatalogproducer_v1beta1_catalog_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_catalog(google_cloud_privatecatalogproducer_v1beta1_catalog_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/catalogs', options) - command.request_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog::Representation - command.request_object = google_cloud_privatecatalogproducer_v1beta1_catalog_object - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Soft deletes an existing Catalog and all resources under it. - # The catalog can only be deleted if there is no associations under it or - # DeleteCatalogRequest.force is true. The delete operation - # can be recovered by the PrivateCatalogProducer.UndeleteCatalog - # method. - # @param [String] name - # The resource name of the catalog. - # @param [Boolean] force - # Forces deletion of the `Catalog` and its `Association` resources. - # If the `Catalog` is still associated with other resources and - # force is not set to true, then the operation fails. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_catalog(name, force: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v1beta1/{+name}', options) - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog - command.params['name'] = name unless name.nil? - command.query['force'] = force unless force.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Returns the requested Catalog resource. - # @param [String] name - # The resource name of the catalog. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_catalog(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+name}', options) - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets IAM policy for the specified Catalog. - # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. - # @param [Fixnum] options_requested_policy_version - # Optional. The policy format version to be returned. - # Valid values are 0, 1, and 3. Requests specifying an invalid value will be - # rejected. - # Requests for policies with any conditional bindings must specify version 3. - # Policies without any conditional bindings may specify any valid value or - # leave the field unset. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1Policy] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1Policy] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_catalog_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+resource}:getIamPolicy', options) - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1Policy::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1Policy - command.params['resource'] = resource unless resource.nil? - command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists Catalog resources that the producer has access to, within the - # scope of the parent resource. - # @param [Fixnum] page_size - # The maximum number of catalogs to return. - # @param [String] page_token - # A pagination token returned from a previous call to ListCatalogs - # that indicates where this listing should continue from. - # This field is optional. - # @param [String] parent - # The resource name of the parent resource. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1ListCatalogsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1ListCatalogsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_catalogs(page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/catalogs', options) - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1ListCatalogsResponse::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1ListCatalogsResponse - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a specific Catalog resource. - # @param [String] name - # Output only. The resource name of the catalog, in the format - # `catalogs/`catalog_id`'. - # A unique identifier for the catalog, which is generated - # by catalog service. - # @param [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog] google_cloud_privatecatalogproducer_v1beta1_catalog_object - # @param [String] update_mask - # Field mask that controls which fields of the catalog should be updated. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_catalog(name, google_cloud_privatecatalogproducer_v1beta1_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'v1beta1/{+name}', options) - command.request_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog::Representation - command.request_object = google_cloud_privatecatalogproducer_v1beta1_catalog_object - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog - command.params['name'] = name unless name.nil? - command.query['updateMask'] = update_mask unless update_mask.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Sets the IAM policy for the specified Catalog. - # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. - # See the operation documentation for the appropriate value for this field. - # @param [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1Policy] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1Policy] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def set_catalog_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', options) - command.request_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1SetIamPolicyRequest::Representation - command.request_object = google_iam_v1_set_iam_policy_request_object - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1Policy::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1Policy - command.params['resource'] = resource unless resource.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Tests the IAM permissions for the specified Catalog. - # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. - # @param [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1TestIamPermissionsRequest] google_iam_v1_test_iam_permissions_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1TestIamPermissionsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1TestIamPermissionsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def test_catalog_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options) - command.request_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1TestIamPermissionsRequest::Representation - command.request_object = google_iam_v1_test_iam_permissions_request_object - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1TestIamPermissionsResponse::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleIamV1TestIamPermissionsResponse - command.params['resource'] = resource unless resource.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Undeletes a deleted Catalog and all resources under it. - # @param [String] name - # The resource name of the catalog. - # @param [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1UndeleteCatalogRequest] google_cloud_privatecatalogproducer_v1beta1_undelete_catalog_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def undelete_catalog(name, google_cloud_privatecatalogproducer_v1beta1_undelete_catalog_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/{+name}:undelete', options) - command.request_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1UndeleteCatalogRequest::Representation - command.request_object = google_cloud_privatecatalogproducer_v1beta1_undelete_catalog_request_object - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Catalog - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates an Association instance under a given Catalog. - # @param [String] parent - # The `Catalog` resource's name. - # @param [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1CreateAssociationRequest] google_cloud_privatecatalogproducer_v1beta1_create_association_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Association] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Association] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_catalog_association(parent, google_cloud_privatecatalogproducer_v1beta1_create_association_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/{+parent}/associations', options) - command.request_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1CreateAssociationRequest::Representation - command.request_object = google_cloud_privatecatalogproducer_v1beta1_create_association_request_object - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Association::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Association - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes the given Association. - # @param [String] name - # The resource name of the `Association` to delete. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_catalog_association(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v1beta1/{+name}', options) - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Returns the requested Association resource. - # @param [String] name - # The resource name of the `Association` to retrieve. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Association] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Association] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_catalog_association(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+name}', options) - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Association::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Association - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all Association resources under a catalog. - # @param [String] parent - # The resource name of the `Catalog` whose `Associations` are - # being retrieved. In the format `catalogs/`. - # @param [Fixnum] page_size - # The maximum number of catalog associations to return. - # @param [String] page_token - # A pagination token returned from the previous call to - # `ListAssociations`. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1ListAssociationsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1ListAssociationsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_catalog_associations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+parent}/associations', options) - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1ListAssociationsResponse::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1ListAssociationsResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Copies a Product under another Catalog. - # @param [String] name - # The resource name of the current product that is copied from. - # @param [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1CopyProductRequest] google_cloud_privatecatalogproducer_v1beta1_copy_product_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def copy_catalog_product(name, google_cloud_privatecatalogproducer_v1beta1_copy_product_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/{+name}:copy', options) - command.request_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1CopyProductRequest::Representation - command.request_object = google_cloud_privatecatalogproducer_v1beta1_copy_product_request_object - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a Product instance under a given Catalog. - # @param [String] parent - # The catalog name of the new product's parent. - # @param [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product] google_cloud_privatecatalogproducer_v1beta1_product_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_catalog_product(parent, google_cloud_privatecatalogproducer_v1beta1_product_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/{+parent}/products', options) - command.request_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product::Representation - command.request_object = google_cloud_privatecatalogproducer_v1beta1_product_object - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Hard deletes a Product. - # @param [String] name - # The resource name of the product. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_catalog_product(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v1beta1/{+name}', options) - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Returns the requested Product resource. - # @param [String] name - # The resource name of the product. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_catalog_product(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+name}', options) - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists Product resources that the producer has access to, within the - # scope of the parent catalog. - # @param [String] parent - # The resource name of the parent resource. - # @param [String] filter - # A filter expression used to restrict the returned results based - # upon properties of the product. - # @param [Fixnum] page_size - # The maximum number of products to return. - # @param [String] page_token - # A pagination token returned from a previous call to ListProducts - # that indicates where this listing should continue from. - # This field is optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1ListProductsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1ListProductsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_catalog_products(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+parent}/products', options) - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1ListProductsResponse::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1ListProductsResponse - command.params['parent'] = parent unless parent.nil? - command.query['filter'] = filter unless filter.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a specific Product resource. - # @param [String] name - # Required. The resource name of the product in the format - # `catalogs/`catalog_id`/products/a-z*[a-z0-9]'. - # A unique identifier for the product under a catalog, which cannot - # be changed after the product is created. The final - # segment of the name must between 1 and 256 characters in length. - # @param [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product] google_cloud_privatecatalogproducer_v1beta1_product_object - # @param [String] update_mask - # Field mask that controls which fields of the product should be updated. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_catalog_product(name, google_cloud_privatecatalogproducer_v1beta1_product_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'v1beta1/{+name}', options) - command.request_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product::Representation - command.request_object = google_cloud_privatecatalogproducer_v1beta1_product_object - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Product - command.params['name'] = name unless name.nil? - command.query['updateMask'] = update_mask unless update_mask.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates an Icon instance under a given Product. - # If Product only has a default icon, a new Icon - # instance is created and associated with the given Product. - # If Product already has a non-default icon, the action creates - # a new Icon instance, associates the newly created - # Icon with the given Product and deletes the old icon. - # @param [String] product - # The resource name of the product. - # @param [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1UploadIconRequest] google_cloud_privatecatalogproducer_v1beta1_upload_icon_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def upload_catalog_product_icon(product, google_cloud_privatecatalogproducer_v1beta1_upload_icon_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/{+product}/icons:upload', options) - command.request_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1UploadIconRequest::Representation - command.request_object = google_cloud_privatecatalogproducer_v1beta1_upload_icon_request_object - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty - command.params['product'] = product unless product.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a Version instance under a given Product. - # @param [String] parent - # The product name of the new version's parent. - # @param [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Version] google_cloud_privatecatalogproducer_v1beta1_version_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_catalog_product_version(parent, google_cloud_privatecatalogproducer_v1beta1_version_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/{+parent}/versions', options) - command.request_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Version::Representation - command.request_object = google_cloud_privatecatalogproducer_v1beta1_version_object - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Hard deletes a Version. - # @param [String] name - # The resource name of the version. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_catalog_product_version(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v1beta1/{+name}', options) - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Returns the requested Version resource. - # @param [String] name - # The resource name of the version. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Version] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Version] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_catalog_product_version(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+name}', options) - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Version::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Version - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists Version resources that the producer has access to, within the - # scope of the parent Product. - # @param [String] parent - # The resource name of the parent resource. - # @param [Fixnum] page_size - # The maximum number of versions to return. - # @param [String] page_token - # A pagination token returned from a previous call to ListVersions - # that indicates where this listing should continue from. - # This field is optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1ListVersionsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1ListVersionsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_catalog_product_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+parent}/versions', options) - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1ListVersionsResponse::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1ListVersionsResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a specific Version resource. - # @param [String] name - # Required. The resource name of the version, in the format - # `catalogs/`catalog_id`/products/`product_id`/versions/a-z*[a-z0-9]'. - # A unique identifier for the version under a product, which can't - # be changed after the version is created. The final segment of the name must - # between 1 and 63 characters in length. - # @param [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Version] google_cloud_privatecatalogproducer_v1beta1_version_object - # @param [String] update_mask - # Field mask that controls which fields of the version should be updated. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Version] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Version] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_catalog_product_version(name, google_cloud_privatecatalogproducer_v1beta1_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'v1beta1/{+name}', options) - command.request_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Version::Representation - command.request_object = google_cloud_privatecatalogproducer_v1beta1_version_object - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Version::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Version - command.params['name'] = name unless name.nil? - command.query['updateMask'] = update_mask unless update_mask.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Starts asynchronous cancellation on a long-running operation. The server - # makes a best effort to cancel the operation, but success is not - # guaranteed. If the server doesn't support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. Clients can use - # Operations.GetOperation or - # other methods to check whether the cancellation succeeded or whether the - # operation completed despite cancellation. On successful cancellation, - # the operation is not deleted; instead, it becomes an operation with - # an Operation.error value with a google.rpc.Status.code of 1, - # corresponding to `Code.CANCELLED`. - # @param [String] name - # The name of the operation resource to be cancelled. - # @param [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def cancel_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options) - command.request_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningCancelOperationRequest::Representation - command.request_object = google_longrunning_cancel_operation_request_object - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a long-running operation. This method indicates that the client is - # no longer interested in the operation result. It does not cancel the - # operation. If the server doesn't support this method, it returns - # `google.rpc.Code.UNIMPLEMENTED`. - # @param [String] name - # The name of the operation resource to be deleted. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_operation(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v1beta1/{+name}', options) - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleProtobufEmpty - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets the latest state of a long-running operation. Clients can use this - # method to poll the operation result at intervals as recommended by the API - # service. - # @param [String] name - # The name of the operation resource. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_operation(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+name}', options) - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningOperation - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists operations that match the specified filter in the request. If the - # server doesn't support this method, it returns `UNIMPLEMENTED`. - # NOTE: the `name` binding allows API services to override the binding - # to use different resource name schemes, such as `users/*/operations`. To - # override the binding, API services can add a binding such as - # `"/v1/`name=users/*`/operations"` to their service configuration. - # For backwards compatibility, the default name includes the operations - # collection id, however overriding users must ensure the name binding - # is the parent resource, without the operations collection id. - # @param [String] filter - # The standard list filter. - # @param [String] name - # The name of the operation's parent resource. - # @param [Fixnum] page_size - # The standard list page size. - # @param [String] page_token - # The standard list page token. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningListOperationsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningListOperationsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_operations(filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/operations', options) - command.response_representation = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningListOperationsResponse::Representation - command.response_class = Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleLongrunningListOperationsResponse - command.query['filter'] = filter unless filter.nil? - command.query['name'] = name unless name.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - protected - - def apply_command_defaults(command) - command.query['key'] = key unless key.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - end - end - end - end -end diff --git a/generated/google/apis/cloudresourcemanager_v1.rb b/generated/google/apis/cloudresourcemanager_v1.rb index f3d051aa0..5757a9b4f 100644 --- a/generated/google/apis/cloudresourcemanager_v1.rb +++ b/generated/google/apis/cloudresourcemanager_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/resource-manager module CloudresourcemanagerV1 VERSION = 'V1' - REVISION = '20200210' + REVISION = '20200311' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudresourcemanager_v1/service.rb b/generated/google/apis/cloudresourcemanager_v1/service.rb index ea736f959..67e3e0c05 100644 --- a/generated/google/apis/cloudresourcemanager_v1/service.rb +++ b/generated/google/apis/cloudresourcemanager_v1/service.rb @@ -369,6 +369,9 @@ module Google # @param [String] parent # Required. The name of the resource to list all attached Liens. # For example, `projects/1234`. + # (google.api.field_policy).resource_type annotation is not set since the + # parent depends on the meta api implementation. This field could be a + # project or other sub project resources. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/cloudsearch_v1.rb b/generated/google/apis/cloudsearch_v1.rb index 7acfacf52..3184cd548 100644 --- a/generated/google/apis/cloudsearch_v1.rb +++ b/generated/google/apis/cloudsearch_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/cloud-search/docs/guides/ module CloudsearchV1 VERSION = 'V1' - REVISION = '20200212' + REVISION = '20200331' # Index and serve your organization's data with Cloud Search AUTH_CLOUD_SEARCH = 'https://www.googleapis.com/auth/cloud_search' diff --git a/generated/google/apis/cloudsearch_v1/classes.rb b/generated/google/apis/cloudsearch_v1/classes.rb index 7cca6d0e8..e56b9cd4a 100644 --- a/generated/google/apis/cloudsearch_v1/classes.rb +++ b/generated/google/apis/cloudsearch_v1/classes.rb @@ -31,9 +31,9 @@ module Google # Indicates the operator name required in the query in order to isolate the # boolean property. For example, if operatorName is *closed* and the # property's name is *isClosed*, then queries like - # *closed:<value>* will show results only where the value of the + # *closed:<value>* show results only where the value of the # property named *isClosed* matches *<value>*. By contrast, a - # search that uses the same *<value>* without an operator will return + # search that uses the same *<value>* without an operator returns # all items where *<value>* matches the value of any # String properties or text within the content field for the item. # The operator name can only contain lowercase letters (a-z). @@ -435,7 +435,7 @@ module Google # Indicates the operator name required in the query in order to isolate the # date property using the greater-than operator. For example, if # greaterThanOperatorName is *closedafter* and the property's name is - # *closeDate*, then queries like *closedafter:<value>* will + # *closeDate*, then queries like *closedafter:<value>* # show results only where the value of the property named *closeDate* is # later than *<value>*. # The operator name can only contain lowercase letters (a-z). @@ -447,7 +447,7 @@ module Google # Indicates the operator name required in the query in order to isolate the # date property using the less-than operator. For example, if # lessThanOperatorName is *closedbefore* and the property's name is - # *closeDate*, then queries like *closedbefore:<value>* will + # *closeDate*, then queries like *closedbefore:<value>* # show results only where the value of the property named *closeDate* is # earlier than *<value>*. # The operator name can only contain lowercase letters (a-z). @@ -460,9 +460,9 @@ module Google # date property. For example, suppose an issue tracking schema object # has a property named *closeDate* that specifies an operator with an # operatorName of *closedon*. For searches on that data, queries like - # *closedon:<value>* will show results only where the value of the + # *closedon:<value>* show results only where the value of the # *closeDate* property matches *<value>*. By contrast, a - # search that uses the same *<value>* without an operator will return + # search that uses the same *<value>* without an operator returns # all items where *<value>* matches the value of any String # properties or text within the content field for the indexed datasource. # The operator name can only contain lowercase letters (a-z). @@ -577,17 +577,17 @@ module Google end # A reference to a top-level property within the object that should be - # displayed in search results. The values of the chosen properties will be + # displayed in search results. The values of the chosen properties is # displayed in the search results along with the - # dislpay label + # display label # for that property if one is specified. If a display label is not specified, - # only the values will be shown. + # only the values is shown. class DisplayedProperty include Google::Apis::Core::Hashable # The name of the top-level property as defined in a property definition # for the object. If the name is not a defined property in the schema, an - # error will be given when attempting to update the schema. + # error is given when attempting to update the schema. # Corresponds to the JSON property `propertyName` # @return [String] attr_accessor :property_name @@ -765,7 +765,7 @@ module Google # optional. Search operators let users restrict the query to specific fields # relevant to the type of item being searched. For example, if you provide no # operator for a *priority* enum property with possible values *p0* and *p1*, - # a query that contains the term *p0* will return items that have *p0* as the + # a query that contains the term *p0* returns items that have *p0* as the # value of the *priority* property, as well as any items that contain the # string *p0* in other fields. If you provide an operator name for the enum, # such as *priority*, then search users can use that operator to refine @@ -777,9 +777,9 @@ module Google # Indicates the operator name required in the query in order to isolate the # enum property. For example, if operatorName is *priority* and the # property's name is *priorityVal*, then queries like - # *priority:<value>* will show results only where the value of the + # *priority:<value>* show results only where the value of the # property named *priorityVal* matches *<value>*. By contrast, a - # search that uses the same *<value>* without an operator will return + # search that uses the same *<value>* without an operator returns # all items where *<value>* matches the value of any String # properties or text within the content field for the item. # The operator name can only contain lowercase letters (a-z). @@ -813,7 +813,7 @@ module Google # optional. Search operators let users restrict the query to specific fields # relevant to the type of item being searched. For example, if you provide no # operator for a *priority* enum property with possible values *p0* and *p1*, - # a query that contains the term *p0* will return items that have *p0* as the + # a query that contains the term *p0* returns items that have *p0* as the # value of the *priority* property, as well as any items that contain the # string *p0* in other fields. If you provide an operator name for the enum, # such as *priority*, then search users can use that operator to refine @@ -1200,7 +1200,7 @@ module Google # updateTime # as the freshness indicator. # The maximum length is 256 characters. - # When a property is used to calculate fresheness, the value defaults + # When a property is used to calculate freshness, the value defaults # to 2 years from the current time. # Corresponds to the JSON property `freshnessProperty` # @return [String] @@ -1411,9 +1411,9 @@ module Google # Indicates the operator name required in the query in order to isolate the # html property. For example, if operatorName is *subject* and the # property's name is *subjectLine*, then queries like - # *subject:<value>* will show results only where the value of the + # *subject:<value>* show results only where the value of the # property named *subjectLine* matches *<value>*. By contrast, a - # search that uses the same *<value>* without an operator will return + # search that uses the same *<value>* without an operator return # all items where *<value>* matches the value of any # html properties or text within the content field for the item. # The operator name can only contain lowercase letters (a-z). @@ -1554,7 +1554,7 @@ module Google # Indicates the operator name required in the query in order to isolate the # integer property using the greater-than operator. For example, if # greaterThanOperatorName is *priorityabove* and the property's name is - # *priorityVal*, then queries like *priorityabove:<value>* will + # *priorityVal*, then queries like *priorityabove:<value>* # show results only where the value of the property named *priorityVal* is # greater than *<value>*. # The operator name can only contain lowercase letters (a-z). @@ -1566,7 +1566,7 @@ module Google # Indicates the operator name required in the query in order to isolate the # integer property using the less-than operator. For example, if # lessThanOperatorName is *prioritybelow* and the property's name is - # *priorityVal*, then queries like *prioritybelow:<value>* will + # *priorityVal*, then queries like *prioritybelow:<value>* # show results only where the value of the property named *priorityVal* is # less than *<value>*. # The operator name can only contain lowercase letters (a-z). @@ -1578,9 +1578,9 @@ module Google # Indicates the operator name required in the query in order to isolate the # integer property. For example, if operatorName is *priority* and the # property's name is *priorityVal*, then queries like - # *priority:<value>* will show results only where the value of the + # *priority:<value>* show results only where the value of the # property named *priorityVal* matches *<value>*. By contrast, a - # search that uses the same *<value>* without an operator will return + # search that uses the same *<value>* without an operator returns # all items where *<value>* matches the value of any String # properties or text within the content field for the item. # The operator name can only contain lowercase letters (a-z). @@ -2008,6 +2008,8 @@ module Google # Link to the source repository serving the data. Search results apply # this link to the title. + # Whitespace or special characters may cause Cloud Search result links to + # trigger a redirect notice; to avoid this, encode the URL. # The maximum length is 2048 characters. # Corresponds to the JSON property `sourceRepositoryUrl` # @return [String] @@ -2374,7 +2376,7 @@ module Google class Metaline include Google::Apis::Core::Hashable - # The list of displayed properties for the metaline. The maxiumum number of + # The list of displayed properties for the metaline. The maximum number of # properties is 5. # Corresponds to the JSON property `properties` # @return [Array] @@ -2533,21 +2535,21 @@ module Google class ObjectDisplayOptions include Google::Apis::Core::Hashable - # Defines the properties that will be displayed in the metalines of the - # search results. The property values will be displayed in the order given - # here. If a property holds multiple values, all of the values will be - # diplayed before the next properties. For this reason, it is a good practice - # to specify singular properties before repeated properties in this list. All - # of the properties must set + # Defines the properties that are displayed in the metalines of the + # search results. The property values are displayed in the order given + # here. If a property holds multiple values, all of the values are + # displayed before the next properties. For this reason, it is a good + # practice to specify singular properties before repeated properties in this + # list. All of the properties must set # is_returnable # to true. The maximum number of metalines is 3. # Corresponds to the JSON property `metalines` # @return [Array] attr_accessor :metalines - # The user friendly label to display in the search result to inidicate the - # type of the item. This is OPTIONAL; if not given, an object label will not - # be displayed on the context line of the search results. The maximum length + # The user friendly label to display in the search result to indicate the + # type of the item. This is OPTIONAL; if not provided, an object label isn't + # displayed on the context line of the search results. The maximum length # is 32 characters. # Corresponds to the JSON property `objectDisplayLabel` # @return [String] @@ -2983,7 +2985,7 @@ module Google # Indicates that multiple values are allowed for the property. For example, a # document only has one description but can have multiple comments. Cannot be # true for properties whose type is a boolean. - # If set to false, properties that contain more than one value will cause the + # If set to false, properties that contain more than one value cause the # indexing request for that item to be rejected. # Corresponds to the JSON property `isRepeatable` # @return [Boolean] @@ -3087,14 +3089,14 @@ module Google class PropertyDisplayOptions include Google::Apis::Core::Hashable - # The user friendly label for the property that will be used if the property - # is specified to be displayed in ObjectDisplayOptions. If given, the display - # label will be shown in front of the property values when the property is + # The user friendly label for the property that is used if the property + # is specified to be displayed in ObjectDisplayOptions. If provided, the + # display label is shown in front of the property values when the property is # part of the object display options. For example, if the property value is # '1', the value by itself may not be useful context for the user. If the - # display name given was 'priority', then the user will see 'priority : 1' in - # the search results which provides clear conext to search users. This is - # OPTIONAL; if not given, only the property values will be displayed. + # display name given was 'priority', then the user sees 'priority : 1' in + # the search results which provides clear context to search users. This is + # OPTIONAL; if not given, only the property values are displayed. # The maximum length is 32 characters. # Corresponds to the JSON property `displayLabel` # @return [String] @@ -4720,15 +4722,15 @@ module Google class TextOperatorOptions include Google::Apis::Core::Hashable - # If true, the text value will be tokenized as one atomic value in + # If true, the text value is tokenized as one atomic value in # operator searches and facet matches. For example, if the operator name is # "genre" and the value is "science-fiction" the query restrictions - # "genre:science" and "genre:fiction" will not match the item; - # "genre:science-fiction" will. Value matching is case-sensitive + # "genre:science" and "genre:fiction" doesn't match the item; + # "genre:science-fiction" does. Value matching is case-sensitive # and does not remove special characters. - # If false, the text will be tokenized. For example, if the value is - # "science-fiction" the queries "genre:science" and "genre:fiction" will - # match the item. + # If false, the text is tokenized. For example, if the value is + # "science-fiction" the queries "genre:science" and "genre:fiction" + # matches the item. # Corresponds to the JSON property `exactMatchWithOperator` # @return [Boolean] attr_accessor :exact_match_with_operator @@ -4737,9 +4739,9 @@ module Google # Indicates the operator name required in the query in order to isolate the # text property. For example, if operatorName is *subject* and the # property's name is *subjectLine*, then queries like - # *subject:<value>* will show results only where the value of the + # *subject:<value>* show results only where the value of the # property named *subjectLine* matches *<value>*. By contrast, a - # search that uses the same *<value>* without an operator will return + # search that uses the same *<value>* without an operator returns # all items where *<value>* matches the value of any # text properties or text within the content field for the item. # The operator name can only contain lowercase letters (a-z). @@ -4815,7 +4817,7 @@ module Google # Indicates the operator name required in the query in order to isolate the # timestamp property using the greater-than operator. For example, if # greaterThanOperatorName is *closedafter* and the property's name is - # *closeDate*, then queries like *closedafter:<value>* will + # *closeDate*, then queries like *closedafter:<value>* # show results only where the value of the property named *closeDate* is # later than *<value>*. # The operator name can only contain lowercase letters (a-z). @@ -4827,7 +4829,7 @@ module Google # Indicates the operator name required in the query in order to isolate the # timestamp property using the less-than operator. For example, if # lessThanOperatorName is *closedbefore* and the property's name is - # *closeDate*, then queries like *closedbefore:<value>* will + # *closeDate*, then queries like *closedbefore:<value>* # show results only where the value of the property named *closeDate* is # earlier than *<value>*. # The operator name can only contain lowercase letters (a-z). @@ -4839,9 +4841,9 @@ module Google # Indicates the operator name required in the query in order to isolate the # timestamp property. For example, if operatorName is *closedon* and the # property's name is *closeDate*, then queries like - # *closedon:<value>* will show results only where the value of the + # *closedon:<value>* show results only where the value of the # property named *closeDate* matches *<value>*. By contrast, a - # search that uses the same *<value>* without an operator will return + # search that uses the same *<value>* without an operator returns # all items where *<value>* matches the value of any String # properties or text within the content field for the item. The operator # name can only contain lowercase letters (a-z). The maximum length is 32 diff --git a/generated/google/apis/cloudshell_v1.rb b/generated/google/apis/cloudshell_v1.rb index 7fb02c019..15975f18b 100644 --- a/generated/google/apis/cloudshell_v1.rb +++ b/generated/google/apis/cloudshell_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/shell/docs/ module CloudshellV1 VERSION = 'V1' - REVISION = '20200224' + REVISION = '20200405' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudshell_v1alpha1.rb b/generated/google/apis/cloudshell_v1alpha1.rb index 42bec0b4c..f9194ead9 100644 --- a/generated/google/apis/cloudshell_v1alpha1.rb +++ b/generated/google/apis/cloudshell_v1alpha1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/shell/docs/ module CloudshellV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200224' + REVISION = '20200405' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudtasks_v2beta2.rb b/generated/google/apis/cloudtasks_v2beta2.rb index 8fada08a3..f90b22341 100644 --- a/generated/google/apis/cloudtasks_v2beta2.rb +++ b/generated/google/apis/cloudtasks_v2beta2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/tasks/ module CloudtasksV2beta2 VERSION = 'V2beta2' - REVISION = '20200210' + REVISION = '20200324' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudtasks_v2beta2/service.rb b/generated/google/apis/cloudtasks_v2beta2/service.rb index 8a16a8e8f..4d31a4b37 100644 --- a/generated/google/apis/cloudtasks_v2beta2/service.rb +++ b/generated/google/apis/cloudtasks_v2beta2/service.rb @@ -207,6 +207,10 @@ module Google # @param [String] name # Required. The resource name of the queue. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` + # @param [String] read_mask + # Optional. Read mask is used for a more granular control over what the API + # returns. By + # it includes all fields in Queue except for stats. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -224,11 +228,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_location_queue(name, fields: nil, quota_user: nil, options: nil, &block) + def get_project_location_queue(name, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta2/{+name}', options) command.response_representation = Google::Apis::CloudtasksV2beta2::Queue::Representation command.response_class = Google::Apis::CloudtasksV2beta2::Queue command.params['name'] = name unless name.nil? + command.query['readMask'] = read_mask unless read_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) diff --git a/generated/google/apis/cloudtrace_v1.rb b/generated/google/apis/cloudtrace_v1.rb index 2057191d3..dfe3f2ed5 100644 --- a/generated/google/apis/cloudtrace_v1.rb +++ b/generated/google/apis/cloudtrace_v1.rb @@ -23,13 +23,13 @@ module Google # Sends application trace data to Cloud Trace for viewing. Trace data is # collected for all App Engine applications by default. Trace data from other # applications can be provided using this API. This library is used to interact - # with the Trace API directly. If you are looking to instrument your application - # for Cloud Trace, we recommend using OpenCensus. + # with the Cloud Trace API directly. If you are looking to instrument your + # application for Cloud Trace, we recommend using OpenCensus. # # @see https://cloud.google.com/trace module CloudtraceV1 VERSION = 'V1' - REVISION = '20200225' + REVISION = '20200309' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudtrace_v1/service.rb b/generated/google/apis/cloudtrace_v1/service.rb index 9e76237e6..1b4a7952c 100644 --- a/generated/google/apis/cloudtrace_v1/service.rb +++ b/generated/google/apis/cloudtrace_v1/service.rb @@ -25,8 +25,8 @@ module Google # Sends application trace data to Cloud Trace for viewing. Trace data is # collected for all App Engine applications by default. Trace data from other # applications can be provided using this API. This library is used to interact - # with the Trace API directly. If you are looking to instrument your application - # for Cloud Trace, we recommend using OpenCensus. + # with the Cloud Trace API directly. If you are looking to instrument your + # application for Cloud Trace, we recommend using OpenCensus. # # @example # require 'google/apis/cloudtrace_v1' diff --git a/generated/google/apis/cloudtrace_v2.rb b/generated/google/apis/cloudtrace_v2.rb index 3f4a38717..49cacf882 100644 --- a/generated/google/apis/cloudtrace_v2.rb +++ b/generated/google/apis/cloudtrace_v2.rb @@ -23,13 +23,13 @@ module Google # Sends application trace data to Cloud Trace for viewing. Trace data is # collected for all App Engine applications by default. Trace data from other # applications can be provided using this API. This library is used to interact - # with the Trace API directly. If you are looking to instrument your application - # for Cloud Trace, we recommend using OpenCensus. + # with the Cloud Trace API directly. If you are looking to instrument your + # application for Cloud Trace, we recommend using OpenCensus. # # @see https://cloud.google.com/trace module CloudtraceV2 VERSION = 'V2' - REVISION = '20200225' + REVISION = '20200309' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudtrace_v2/service.rb b/generated/google/apis/cloudtrace_v2/service.rb index 46345fd95..9d3d3a32f 100644 --- a/generated/google/apis/cloudtrace_v2/service.rb +++ b/generated/google/apis/cloudtrace_v2/service.rb @@ -25,8 +25,8 @@ module Google # Sends application trace data to Cloud Trace for viewing. Trace data is # collected for all App Engine applications by default. Trace data from other # applications can be provided using this API. This library is used to interact - # with the Trace API directly. If you are looking to instrument your application - # for Cloud Trace, we recommend using OpenCensus. + # with the Cloud Trace API directly. If you are looking to instrument your + # application for Cloud Trace, we recommend using OpenCensus. # # @example # require 'google/apis/cloudtrace_v2' diff --git a/generated/google/apis/cloudtrace_v2beta1.rb b/generated/google/apis/cloudtrace_v2beta1.rb index a07e9c9ff..5b6abaf52 100644 --- a/generated/google/apis/cloudtrace_v2beta1.rb +++ b/generated/google/apis/cloudtrace_v2beta1.rb @@ -23,13 +23,13 @@ module Google # Sends application trace data to Cloud Trace for viewing. Trace data is # collected for all App Engine applications by default. Trace data from other # applications can be provided using this API. This library is used to interact - # with the Trace API directly. If you are looking to instrument your application - # for Cloud Trace, we recommend using OpenCensus. + # with the Cloud Trace API directly. If you are looking to instrument your + # application for Cloud Trace, we recommend using OpenCensus. # # @see https://cloud.google.com/trace module CloudtraceV2beta1 VERSION = 'V2beta1' - REVISION = '20200225' + REVISION = '20200330' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudtrace_v2beta1/classes.rb b/generated/google/apis/cloudtrace_v2beta1/classes.rb index afd1877b9..6f8f02bb3 100644 --- a/generated/google/apis/cloudtrace_v2beta1/classes.rb +++ b/generated/google/apis/cloudtrace_v2beta1/classes.rb @@ -120,8 +120,7 @@ module Google # granting_access_to_a_service_account_for_a_resource). # To create tables and write data this account will need the dataEditor role. # Read more about roles in the [BigQuery - # documentation](https://cloud.google.com/bigquery/docs/access-control# - # permissions_and_roles). + # documentation](https://cloud.google.com/bigquery/docs/access-control). # E.g.: # "service-00000001@00000002.iam.gserviceaccount.com" # Corresponds to the JSON property `writerIdentity` diff --git a/generated/google/apis/cloudtrace_v2beta1/service.rb b/generated/google/apis/cloudtrace_v2beta1/service.rb index 490876e83..0db861ddf 100644 --- a/generated/google/apis/cloudtrace_v2beta1/service.rb +++ b/generated/google/apis/cloudtrace_v2beta1/service.rb @@ -25,8 +25,8 @@ module Google # Sends application trace data to Cloud Trace for viewing. Trace data is # collected for all App Engine applications by default. Trace data from other # applications can be provided using this API. This library is used to interact - # with the Trace API directly. If you are looking to instrument your application - # for Cloud Trace, we recommend using OpenCensus. + # with the Cloud Trace API directly. If you are looking to instrument your + # application for Cloud Trace, we recommend using OpenCensus. # # @example # require 'google/apis/cloudtrace_v2beta1' diff --git a/generated/google/apis/composer_v1.rb b/generated/google/apis/composer_v1.rb index 711c9ad82..b66e0a924 100644 --- a/generated/google/apis/composer_v1.rb +++ b/generated/google/apis/composer_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/composer/ module ComposerV1 VERSION = 'V1' - REVISION = '20200207' + REVISION = '20200313' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/composer_v1/classes.rb b/generated/google/apis/composer_v1/classes.rb index 5c65984ea..c651bf9b8 100644 --- a/generated/google/apis/composer_v1/classes.rb +++ b/generated/google/apis/composer_v1/classes.rb @@ -145,6 +145,12 @@ module Google # @return [Fixnum] attr_accessor :node_count + # The configuration information for configuring a Private IP Cloud Composer + # environment. + # Corresponds to the JSON property `privateEnvironmentConfig` + # @return [Google::Apis::ComposerV1::PrivateEnvironmentConfig] + attr_accessor :private_environment_config + # Specifies the selection and configuration of software inside the environment. # Corresponds to the JSON property `softwareConfig` # @return [Google::Apis::ComposerV1::SoftwareConfig] @@ -161,10 +167,81 @@ module Google @gke_cluster = args[:gke_cluster] if args.key?(:gke_cluster) @node_config = args[:node_config] if args.key?(:node_config) @node_count = args[:node_count] if args.key?(:node_count) + @private_environment_config = args[:private_environment_config] if args.key?(:private_environment_config) @software_config = args[:software_config] if args.key?(:software_config) end end + # Configuration for controlling how IPs are allocated in the + # GKE cluster running the Apache Airflow software. + class IpAllocationPolicy + include Google::Apis::Core::Hashable + + # Optional. The IP address range used to allocate IP addresses to pods in + # the GKE cluster. + # This field is applicable only when `use_ip_aliases` is true. + # Set to blank to have GKE choose a range with the default size. + # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific + # netmask. + # Set to a + # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. + # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range + # to use. + # Corresponds to the JSON property `clusterIpv4CidrBlock` + # @return [String] + attr_accessor :cluster_ipv4_cidr_block + + # Optional. The name of the GKE cluster's secondary range used to allocate + # IP addresses to pods. + # This field is applicable only when `use_ip_aliases` is true. + # Corresponds to the JSON property `clusterSecondaryRangeName` + # @return [String] + attr_accessor :cluster_secondary_range_name + + # Optional. The IP address range of the services IP addresses in this + # GKE cluster. + # This field is applicable only when `use_ip_aliases` is true. + # Set to blank to have GKE choose a range with the default size. + # Set to /netmask (e.g. `/14`) to have GKE choose a range with a specific + # netmask. + # Set to a + # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) + # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. + # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range + # to use. + # Corresponds to the JSON property `servicesIpv4CidrBlock` + # @return [String] + attr_accessor :services_ipv4_cidr_block + + # Optional. The name of the services' secondary range used to allocate + # IP addresses to the GKE cluster. + # This field is applicable only when `use_ip_aliases` is true. + # Corresponds to the JSON property `servicesSecondaryRangeName` + # @return [String] + attr_accessor :services_secondary_range_name + + # Optional. Whether or not to enable Alias IPs in the GKE cluster. + # If `true`, a VPC-native cluster is created. + # Corresponds to the JSON property `useIpAliases` + # @return [Boolean] + attr_accessor :use_ip_aliases + alias_method :use_ip_aliases?, :use_ip_aliases + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cluster_ipv4_cidr_block = args[:cluster_ipv4_cidr_block] if args.key?(:cluster_ipv4_cidr_block) + @cluster_secondary_range_name = args[:cluster_secondary_range_name] if args.key?(:cluster_secondary_range_name) + @services_ipv4_cidr_block = args[:services_ipv4_cidr_block] if args.key?(:services_ipv4_cidr_block) + @services_secondary_range_name = args[:services_secondary_range_name] if args.key?(:services_secondary_range_name) + @use_ip_aliases = args[:use_ip_aliases] if args.key?(:use_ip_aliases) + end + end + # ImageVersion information class ImageVersion include Google::Apis::Core::Hashable @@ -285,6 +362,12 @@ module Google # @return [Fixnum] attr_accessor :disk_size_gb + # Configuration for controlling how IPs are allocated in the + # GKE cluster running the Apache Airflow software. + # Corresponds to the JSON property `ipAllocationPolicy` + # @return [Google::Apis::ComposerV1::IpAllocationPolicy] + attr_accessor :ip_allocation_policy + # Optional. The Compute Engine [zone](/compute/docs/regions-zones) in which # to deploy the VMs used to run the Apache Airflow software, specified as a # [relative resource @@ -379,6 +462,7 @@ module Google # Update properties of this object def update!(**args) @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb) + @ip_allocation_policy = args[:ip_allocation_policy] if args.key?(:ip_allocation_policy) @location = args[:location] if args.key?(:location) @machine_type = args[:machine_type] if args.key?(:machine_type) @network = args[:network] if args.key?(:network) @@ -504,6 +588,100 @@ module Google end end + # Configuration options for the private GKE cluster in a Cloud Composer + # environment. + class PrivateClusterConfig + include Google::Apis::Core::Hashable + + # Optional. If `true`, access to the public endpoint of the GKE cluster is + # denied. + # Corresponds to the JSON property `enablePrivateEndpoint` + # @return [Boolean] + attr_accessor :enable_private_endpoint + alias_method :enable_private_endpoint?, :enable_private_endpoint + + # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. + # If + # left blank, the default value of '172.16.0.0/23' is used. + # Corresponds to the JSON property `masterIpv4CidrBlock` + # @return [String] + attr_accessor :master_ipv4_cidr_block + + # Output only. The IP range in CIDR notation to use for the hosted master + # network. This + # range is used for assigning internal IP addresses to the GKE cluster + # master or set of masters and to the internal load balancer virtual IP. + # This range must not overlap with any other ranges in use + # within the cluster's network. + # Corresponds to the JSON property `masterIpv4ReservedRange` + # @return [String] + attr_accessor :master_ipv4_reserved_range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @enable_private_endpoint = args[:enable_private_endpoint] if args.key?(:enable_private_endpoint) + @master_ipv4_cidr_block = args[:master_ipv4_cidr_block] if args.key?(:master_ipv4_cidr_block) + @master_ipv4_reserved_range = args[:master_ipv4_reserved_range] if args.key?(:master_ipv4_reserved_range) + end + end + + # The configuration information for configuring a Private IP Cloud Composer + # environment. + class PrivateEnvironmentConfig + include Google::Apis::Core::Hashable + + # Optional. The CIDR block from which IP range in tenant project will be + # reserved for + # Cloud SQL. Needs to be disjoint from `web_server_ipv4_cidr_block`. + # Corresponds to the JSON property `cloudSqlIpv4CidrBlock` + # @return [String] + attr_accessor :cloud_sql_ipv4_cidr_block + + # Optional. If `true`, a Private IP Cloud Composer environment is created. + # If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be + # set to true. + # Corresponds to the JSON property `enablePrivateEnvironment` + # @return [Boolean] + attr_accessor :enable_private_environment + alias_method :enable_private_environment?, :enable_private_environment + + # Configuration options for the private GKE cluster in a Cloud Composer + # environment. + # Corresponds to the JSON property `privateClusterConfig` + # @return [Google::Apis::ComposerV1::PrivateClusterConfig] + attr_accessor :private_cluster_config + + # Optional. The CIDR block from which IP range for web server will be reserved. + # Needs + # to be disjoint from `private_cluster_config.master_ipv4_cidr_block` and + # `cloud_sql_ipv4_cidr_block`. + # Corresponds to the JSON property `webServerIpv4CidrBlock` + # @return [String] + attr_accessor :web_server_ipv4_cidr_block + + # Output only. The IP range reserved for the tenant project's App Engine VMs. + # Corresponds to the JSON property `webServerIpv4ReservedRange` + # @return [String] + attr_accessor :web_server_ipv4_reserved_range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cloud_sql_ipv4_cidr_block = args[:cloud_sql_ipv4_cidr_block] if args.key?(:cloud_sql_ipv4_cidr_block) + @enable_private_environment = args[:enable_private_environment] if args.key?(:enable_private_environment) + @private_cluster_config = args[:private_cluster_config] if args.key?(:private_cluster_config) + @web_server_ipv4_cidr_block = args[:web_server_ipv4_cidr_block] if args.key?(:web_server_ipv4_cidr_block) + @web_server_ipv4_reserved_range = args[:web_server_ipv4_reserved_range] if args.key?(:web_server_ipv4_reserved_range) + end + end + # Specifies the selection and configuration of software inside the environment. class SoftwareConfig include Google::Apis::Core::Hashable diff --git a/generated/google/apis/composer_v1/representations.rb b/generated/google/apis/composer_v1/representations.rb index 5e6062516..cad89b2b2 100644 --- a/generated/google/apis/composer_v1/representations.rb +++ b/generated/google/apis/composer_v1/representations.rb @@ -40,6 +40,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class IpAllocationPolicy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ImageVersion class Representation < Google::Apis::Core::JsonRepresentation; end @@ -82,6 +88,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class PrivateClusterConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PrivateEnvironmentConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SoftwareConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -123,11 +141,24 @@ module Google property :node_config, as: 'nodeConfig', class: Google::Apis::ComposerV1::NodeConfig, decorator: Google::Apis::ComposerV1::NodeConfig::Representation property :node_count, as: 'nodeCount' + property :private_environment_config, as: 'privateEnvironmentConfig', class: Google::Apis::ComposerV1::PrivateEnvironmentConfig, decorator: Google::Apis::ComposerV1::PrivateEnvironmentConfig::Representation + property :software_config, as: 'softwareConfig', class: Google::Apis::ComposerV1::SoftwareConfig, decorator: Google::Apis::ComposerV1::SoftwareConfig::Representation end end + class IpAllocationPolicy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cluster_ipv4_cidr_block, as: 'clusterIpv4CidrBlock' + property :cluster_secondary_range_name, as: 'clusterSecondaryRangeName' + property :services_ipv4_cidr_block, as: 'servicesIpv4CidrBlock' + property :services_secondary_range_name, as: 'servicesSecondaryRangeName' + property :use_ip_aliases, as: 'useIpAliases' + end + end + class ImageVersion # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -168,6 +199,8 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :disk_size_gb, as: 'diskSizeGb' + property :ip_allocation_policy, as: 'ipAllocationPolicy', class: Google::Apis::ComposerV1::IpAllocationPolicy, decorator: Google::Apis::ComposerV1::IpAllocationPolicy::Representation + property :location, as: 'location' property :machine_type, as: 'machineType' property :network, as: 'network' @@ -202,6 +235,27 @@ module Google end end + class PrivateClusterConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :enable_private_endpoint, as: 'enablePrivateEndpoint' + property :master_ipv4_cidr_block, as: 'masterIpv4CidrBlock' + property :master_ipv4_reserved_range, as: 'masterIpv4ReservedRange' + end + end + + class PrivateEnvironmentConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cloud_sql_ipv4_cidr_block, as: 'cloudSqlIpv4CidrBlock' + property :enable_private_environment, as: 'enablePrivateEnvironment' + property :private_cluster_config, as: 'privateClusterConfig', class: Google::Apis::ComposerV1::PrivateClusterConfig, decorator: Google::Apis::ComposerV1::PrivateClusterConfig::Representation + + property :web_server_ipv4_cidr_block, as: 'webServerIpv4CidrBlock' + property :web_server_ipv4_reserved_range, as: 'webServerIpv4ReservedRange' + end + end + class SoftwareConfig # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/composer_v1beta1.rb b/generated/google/apis/composer_v1beta1.rb index aa6574332..33148912b 100644 --- a/generated/google/apis/composer_v1beta1.rb +++ b/generated/google/apis/composer_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/composer/ module ComposerV1beta1 VERSION = 'V1beta1' - REVISION = '20200219' + REVISION = '20200313' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/composer_v1beta1/classes.rb b/generated/google/apis/composer_v1beta1/classes.rb index e7cf1ec8c..55fdf8801 100644 --- a/generated/google/apis/composer_v1beta1/classes.rb +++ b/generated/google/apis/composer_v1beta1/classes.rb @@ -644,16 +644,23 @@ module Google attr_accessor :enable_private_endpoint alias_method :enable_private_endpoint?, :enable_private_endpoint - # The IP range in CIDR notation to use for the hosted master network. This - # range is used for assigning internal IP addresses to the cluster - # master or set of masters and to the internal load balancer virtual IP. - # This range must not overlap with any other ranges in use - # within the cluster's network. If left blank, the default value of - # '172.16.0.0/28' is used. + # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. + # If + # left blank, the default value of '172.16.0.0/23' is used. # Corresponds to the JSON property `masterIpv4CidrBlock` # @return [String] attr_accessor :master_ipv4_cidr_block + # Output only. The IP range in CIDR notation to use for the hosted master + # network. This + # range is used for assigning internal IP addresses to the cluster + # master or set of masters and to the internal load balancer virtual IP. + # This range must not overlap with any other ranges in use + # within the cluster's network. + # Corresponds to the JSON property `masterIpv4ReservedRange` + # @return [String] + attr_accessor :master_ipv4_reserved_range + def initialize(**args) update!(**args) end @@ -662,6 +669,7 @@ module Google def update!(**args) @enable_private_endpoint = args[:enable_private_endpoint] if args.key?(:enable_private_endpoint) @master_ipv4_cidr_block = args[:master_ipv4_cidr_block] if args.key?(:master_ipv4_cidr_block) + @master_ipv4_reserved_range = args[:master_ipv4_reserved_range] if args.key?(:master_ipv4_reserved_range) end end @@ -670,6 +678,13 @@ module Google class PrivateEnvironmentConfig include Google::Apis::Core::Hashable + # Optional. The CIDR block from which IP range in tenant project will be + # reserved for + # Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block + # Corresponds to the JSON property `cloudSqlIpv4CidrBlock` + # @return [String] + attr_accessor :cloud_sql_ipv4_cidr_block + # Optional. If `true`, a Private IP Cloud Composer environment is created. # If this field is true, `use_ip_aliases` must be true. # Corresponds to the JSON property `enablePrivateEnvironment` @@ -683,14 +698,30 @@ module Google # @return [Google::Apis::ComposerV1beta1::PrivateClusterConfig] attr_accessor :private_cluster_config + # Optional. The CIDR block from which IP range for web server will be reserved. + # Needs + # to be disjoint from private_cluster_config.master_ipv4_cidr_block and + # cloud_sql_ipv4_cidr_block. + # Corresponds to the JSON property `webServerIpv4CidrBlock` + # @return [String] + attr_accessor :web_server_ipv4_cidr_block + + # Output only. The IP range reserved for the tenant project's App Engine VMs. + # Corresponds to the JSON property `webServerIpv4ReservedRange` + # @return [String] + attr_accessor :web_server_ipv4_reserved_range + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @cloud_sql_ipv4_cidr_block = args[:cloud_sql_ipv4_cidr_block] if args.key?(:cloud_sql_ipv4_cidr_block) @enable_private_environment = args[:enable_private_environment] if args.key?(:enable_private_environment) @private_cluster_config = args[:private_cluster_config] if args.key?(:private_cluster_config) + @web_server_ipv4_cidr_block = args[:web_server_ipv4_cidr_block] if args.key?(:web_server_ipv4_cidr_block) + @web_server_ipv4_reserved_range = args[:web_server_ipv4_reserved_range] if args.key?(:web_server_ipv4_reserved_range) end end diff --git a/generated/google/apis/composer_v1beta1/representations.rb b/generated/google/apis/composer_v1beta1/representations.rb index 879d742d6..6ad969af0 100644 --- a/generated/google/apis/composer_v1beta1/representations.rb +++ b/generated/google/apis/composer_v1beta1/representations.rb @@ -262,15 +262,19 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :enable_private_endpoint, as: 'enablePrivateEndpoint' property :master_ipv4_cidr_block, as: 'masterIpv4CidrBlock' + property :master_ipv4_reserved_range, as: 'masterIpv4ReservedRange' end end class PrivateEnvironmentConfig # @private class Representation < Google::Apis::Core::JsonRepresentation + property :cloud_sql_ipv4_cidr_block, as: 'cloudSqlIpv4CidrBlock' property :enable_private_environment, as: 'enablePrivateEnvironment' property :private_cluster_config, as: 'privateClusterConfig', class: Google::Apis::ComposerV1beta1::PrivateClusterConfig, decorator: Google::Apis::ComposerV1beta1::PrivateClusterConfig::Representation + property :web_server_ipv4_cidr_block, as: 'webServerIpv4CidrBlock' + property :web_server_ipv4_reserved_range, as: 'webServerIpv4ReservedRange' end end diff --git a/generated/google/apis/compute_alpha.rb b/generated/google/apis/compute_alpha.rb index 8a6e396ad..59aa3af08 100644 --- a/generated/google/apis/compute_alpha.rb +++ b/generated/google/apis/compute_alpha.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/compute/docs/reference/latest/ module ComputeAlpha VERSION = 'Alpha' - REVISION = '20200120' + REVISION = '20200311' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/compute_alpha/classes.rb b/generated/google/apis/compute_alpha/classes.rb index d80dae13e..0c87ea7a0 100644 --- a/generated/google/apis/compute_alpha/classes.rb +++ b/generated/google/apis/compute_alpha/classes.rb @@ -167,6 +167,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::AcceleratorTypeAggregatedList::Warning] @@ -183,6 +188,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -767,6 +773,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::AddressAggregatedList::Warning] @@ -783,6 +794,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -1132,6 +1144,17 @@ module Google # @return [Array] attr_accessor :local_ssds + # Compute Engine Long Term Release. When specified, VMs that have this policy + # become long term release (internal: stable fleet) VMs. + # For all VM shapes, this should result in fewer disruptions due to software + # updates and greater predictability via 1 week extended notifications. + # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/ + # stable-fleet-gpus-design for more details. + # Corresponds to the JSON property `longTermRelease` + # @return [Boolean] + attr_accessor :long_term_release + alias_method :long_term_release?, :long_term_release + # Specifies type of machine (name only) which has fixed number of vCPUs and # fixed amount of memory. This also includes specifying custom machine type # following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern. @@ -1152,6 +1175,7 @@ module Google def update!(**args) @guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators) @local_ssds = args[:local_ssds] if args.key?(:local_ssds) + @long_term_release = args[:long_term_release] if args.key?(:long_term_release) @machine_type = args[:machine_type] if args.key?(:machine_type) @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform) end @@ -1254,8 +1278,7 @@ module Google # SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and # the request will fail if you attempt to attach a persistent disk in any other # format than SCSI. Local SSDs can use either NVME or SCSI. For performance - # characteristics of SCSI over NVMe, see Local SSD performance. TODO(b/131765817) - # : Update documentation when NVME is supported. + # characteristics of SCSI over NVMe, see Local SSD performance. # Corresponds to the JSON property `interface` # @return [String] attr_accessor :interface @@ -1348,8 +1371,9 @@ module Google attr_accessor :description # Specifies the disk name. If not specified, the default is to use the name of - # the instance. If the disk with the instance name exists already in the given - # zone/region, a new name will be automatically generated. + # the instance. If a disk with the same name already exists in the given region, + # the existing disk is attached to the new instance and the new disk is not + # created. # Corresponds to the JSON property `diskName` # @return [String] attr_accessor :disk_name @@ -1562,7 +1586,8 @@ module Google end end - # The authentication settings for the backend service. + # [Deprecated] The authentication settings for the backend service. The + # authentication settings for the backend service. class AuthenticationPolicy include Google::Apis::Core::Hashable @@ -1595,7 +1620,8 @@ module Google # @return [String] attr_accessor :principal_binding - # The TLS settings for the client or server. + # [Deprecated] The TLS settings for the client or server. The TLS settings for + # the client or server. # Corresponds to the JSON property `serverTlsContext` # @return [Google::Apis::ComputeAlpha::TlsContext] attr_accessor :server_tls_context @@ -1613,8 +1639,8 @@ module Google end end - # Authorization configuration provides service-level and method-level access - # control for a service. + # [Deprecated] Authorization configuration provides service-level and method- + # level access control for a service. control for a service. class AuthorizationConfig include Google::Apis::Core::Hashable @@ -1654,8 +1680,8 @@ module Google # Represents an Autoscaler resource. # Google Compute Engine has two Autoscaler resources: - # * [Global](/compute/docs/reference/rest/latest/autoscalers) * [Regional](/ - # compute/docs/reference/rest/latest/regionAutoscalers) + # * [Global](/compute/docs/reference/rest/`$api_version`/autoscalers) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionAutoscalers) # Use autoscalers to automatically add or delete instances from a managed # instance group according to your defined autoscaling policy. For more # information, read Autoscaling Groups of Instances. @@ -1815,6 +1841,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::AutoscalerAggregatedList::Warning] @@ -1831,6 +1862,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -2233,6 +2265,13 @@ module Google # @return [Google::Apis::ComputeAlpha::AutoscalingPolicyScaleDownControl] attr_accessor :scale_down_control + # Configuration that allows for slower scale in so that even if Autoscaler + # recommends an abrupt scale in of a MIG, it will be throttled as specified by + # the parameters below. + # Corresponds to the JSON property `scaleInControl` + # @return [Google::Apis::ComputeAlpha::AutoscalingPolicyScaleInControl] + attr_accessor :scale_in_control + def initialize(**args) update!(**args) end @@ -2248,6 +2287,7 @@ module Google @mode = args[:mode] if args.key?(:mode) @queue_based_scaling = args[:queue_based_scaling] if args.key?(:queue_based_scaling) @scale_down_control = args[:scale_down_control] if args.key?(:scale_down_control) + @scale_in_control = args[:scale_in_control] if args.key?(:scale_in_control) end end @@ -2476,40 +2516,6 @@ module Google # @return [Google::Apis::ComputeAlpha::FixedOrPercent] attr_accessor :max_scaled_down_replicas - # A Duration represents a signed, fixed-length span of time represented as a - # count of seconds and fractions of seconds at nanosecond resolution. It is - # independent of any calendar and concepts like "day" or "month". It is related - # to Timestamp in that the difference between two Timestamp values is a Duration - # and it can be added or subtracted from a Timestamp. Range is approximately +- - # 10,000 years. - # # Examples - # Example 1: Compute Duration from two Timestamps in pseudo code. - # Timestamp start = ...; Timestamp end = ...; Duration duration = ...; - # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - - # start.nanos; - # if (duration.seconds 0) ` duration.seconds += 1; duration.nanos -= 1000000000; - # ` else if (duration.seconds > 0 && duration.nanos < 0) ` duration.seconds -= - # 1; duration.nanos += 1000000000; ` - # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. - # Timestamp start = ...; Duration duration = ...; Timestamp end = ...; - # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + - # duration.nanos; - # if (end.nanos = 1000000000) ` end.seconds += 1; end.nanos -= 1000000000; ` - # Example 3: Compute Duration from datetime.timedelta in Python. - # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration. - # FromTimedelta(td) - # # JSON Mapping - # In JSON format, the Duration type is encoded as a string rather than an object, - # where the string ends in the suffix "s" (indicating seconds) and is preceded - # by the number of seconds, with nanoseconds expressed as fractional seconds. - # For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as " - # 3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3. - # 000000001s", and 3 seconds and 1 microsecond should be expressed in JSON - # format as "3.000001s". - # Corresponds to the JSON property `timeWindow` - # @return [Google::Apis::ComputeAlpha::GoogleDuration] - attr_accessor :time_window - # How long back autoscaling should look when computing recommendations to # include directives regarding slower scale down, as described above. # Corresponds to the JSON property `timeWindowSec` @@ -2523,7 +2529,34 @@ module Google # Update properties of this object def update!(**args) @max_scaled_down_replicas = args[:max_scaled_down_replicas] if args.key?(:max_scaled_down_replicas) - @time_window = args[:time_window] if args.key?(:time_window) + @time_window_sec = args[:time_window_sec] if args.key?(:time_window_sec) + end + end + + # Configuration that allows for slower scale in so that even if Autoscaler + # recommends an abrupt scale in of a MIG, it will be throttled as specified by + # the parameters below. + class AutoscalingPolicyScaleInControl + include Google::Apis::Core::Hashable + + # Encapsulates numeric value that can be either absolute or relative. + # Corresponds to the JSON property `maxScaledInReplicas` + # @return [Google::Apis::ComputeAlpha::FixedOrPercent] + attr_accessor :max_scaled_in_replicas + + # How long back autoscaling should look when computing recommendations to + # include directives regarding slower scale in, as described above. + # Corresponds to the JSON property `timeWindowSec` + # @return [Fixnum] + attr_accessor :time_window_sec + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @max_scaled_in_replicas = args[:max_scaled_in_replicas] if args.key?(:max_scaled_in_replicas) @time_window_sec = args[:time_window_sec] if args.key?(:time_window_sec) end end @@ -2543,8 +2576,8 @@ module Google # service is SSL, TCP, or UDP. # If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and # TCP Proxy load balancers), you must also specify exactly one of the following - # parameters: maxConnections, maxConnectionsPerInstance, or - # maxConnectionsPerEndpoint. + # parameters: maxConnections (except for regional managed instance groups), + # maxConnectionsPerInstance, or maxConnectionsPerEndpoint. # If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/ # UDP load balancers), you cannot specify any additional parameters. # @@ -2552,10 +2585,11 @@ module Google # HTTP requests per second (RPS). # You can use the RATE balancing mode if the protocol for the backend service is # HTTP or HTTPS. You must specify exactly one of the following parameters: - # maxRate, maxRatePerInstance, or maxRatePerEndpoint. + # maxRate (except for regional managed instance groups), maxRatePerInstance, or + # maxRatePerEndpoint. # # - If the load balancing mode is UTILIZATION, the load is spread based on the - # CPU utilization of instances in an instance group. + # backend utilization of instances in an instance group. # You can use the UTILIZATION balancing mode if the loadBalancingScheme of the # backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and # the backends are instance groups. There are no restrictions on the backend @@ -2605,12 +2639,13 @@ module Google # @return [String] attr_accessor :group - # Defines a maximum target for simultaneous connections for the entire backend ( - # instance group or NEG). If the backend's balancingMode is UTILIZATION, this is - # an optional parameter. If the backend's balancingMode is CONNECTION, and - # backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, - # you must specify either this parameter, maxConnectionsPerInstance, or - # maxConnectionsPerEndpoint. + # Defines a target maximum number of simultaneous connections that the backend + # can handle. Valid for network endpoint group and instance group backends ( + # except for regional managed instance groups). If the backend's balancingMode + # is UTILIZATION, this is an optional parameter. If the backend's balancingMode + # is CONNECTION, and backend is attached to a backend service whose + # loadBalancingScheme is EXTERNAL, you must specify either this parameter, + # maxConnectionsPerInstance, or maxConnectionsPerEndpoint. # Not available if the backend's balancingMode is RATE. If the # loadBalancingScheme is INTERNAL, then maxConnections is not supported, even # though the backend requires a balancing mode of CONNECTION. @@ -2618,8 +2653,8 @@ module Google # @return [Fixnum] attr_accessor :max_connections - # Defines a maximum target for simultaneous connections for an endpoint of a NEG. - # This is multiplied by the number of endpoints in the NEG to implicitly + # Defines a target maximum number of simultaneous connections for an endpoint of + # a NEG. This is multiplied by the number of endpoints in the NEG to implicitly # calculate a maximum number of target maximum simultaneous connections for the # NEG. If the backend's balancingMode is CONNECTION, and the backend is attached # to a backend service whose loadBalancingScheme is EXTERNAL, you must specify @@ -2631,8 +2666,8 @@ module Google # @return [Fixnum] attr_accessor :max_connections_per_endpoint - # Defines a maximum target for simultaneous connections for a single VM in a - # backend instance group. This is multiplied by the number of instances in the + # Defines a target maximum number of simultaneous connections for a single VM in + # a backend instance group. This is multiplied by the number of instances in the # instance group to implicitly calculate a target maximum number of simultaneous # connections for the whole instance group. If the backend's balancingMode is # UTILIZATION, this is an optional parameter. If the backend's balancingMode is @@ -2646,10 +2681,15 @@ module Google # @return [Fixnum] attr_accessor :max_connections_per_instance - # The max requests per second (RPS) of the group. Can be used with either RATE - # or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, - # either maxRate or maxRatePerInstance must be set. - # This cannot be used for internal load balancing. + # Defines a maximum number of HTTP requests per second (RPS) that the backend + # can handle. Valid for network endpoint group and instance group backends ( + # except for regional managed instance groups). Must not be defined if the + # backend is a managed instance group that uses autoscaling based on load + # balancing. + # If the backend's balancingMode is UTILIZATION, this is an optional parameter. + # If the backend's balancingMode is RATE, you must specify maxRate, + # maxRatePerInstance, or maxRatePerEndpoint. + # Not available if the backend's balancingMode is CONNECTION. # Corresponds to the JSON property `maxRate` # @return [Fixnum] attr_accessor :max_rate @@ -2658,7 +2698,7 @@ module Google # NEG. This is multiplied by the number of endpoints in the NEG to implicitly # calculate a target maximum rate for the NEG. # If the backend's balancingMode is RATE, you must specify either this parameter, - # maxRate, or maxRatePerInstance. + # maxRate (except for regional managed instance groups), or maxRatePerInstance. # Not available if the backend's balancingMode is CONNECTION. # Corresponds to the JSON property `maxRatePerEndpoint` # @return [Float] @@ -2670,17 +2710,18 @@ module Google # instance group. # If the backend's balancingMode is UTILIZATION, this is an optional parameter. # If the backend's balancingMode is RATE, you must specify either this parameter, - # maxRate, or maxRatePerEndpoint. + # maxRate (except for regional managed instance groups), or maxRatePerEndpoint. # Not available if the backend's balancingMode is CONNECTION. # Corresponds to the JSON property `maxRatePerInstance` # @return [Float] attr_accessor :max_rate_per_instance - # Defines the maximum average CPU utilization of a backend VM in an instance + # Defines the maximum average backend utilization of a backend VM in an instance # group. The valid range is [0.0, 1.0]. This is an optional parameter if the # backend's balancingMode is UTILIZATION. # This parameter can be used in conjunction with maxRate, maxRatePerInstance, - # maxConnections, or maxConnectionsPerInstance. + # maxConnections (except for regional managed instance groups), or + # maxConnectionsPerInstance. # Corresponds to the JSON property `maxUtilization` # @return [Float] attr_accessor :max_utilization @@ -2941,8 +2982,8 @@ module Google # balancing services. # Backend services in Google Compute Engine can be either regionally or globally # scoped. - # * [Global](/compute/docs/reference/rest/latest/backendServices) * [Regional](/ - # compute/docs/reference/rest/latest/regionBackendServices) + # * [Global](/compute/docs/reference/rest/`$api_version`/backendServices) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionBackendServices) # For more information, read Backend Services. # (== resource_for `$api_version`.backendService ==) class BackendService @@ -3002,8 +3043,13 @@ module Google attr_accessor :enable_cdn alias_method :enable_cdn?, :enable_cdn - # Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at - # least one backend instance group to be defined as a backup (failover) backend. + # Applicable only to Failover for Internal TCP/UDP Load Balancing. On failover + # or failback, this field indicates whether connection draining will be honored. + # GCP has a fixed connection draining timeout of 10 minutes. A setting of true + # terminates existing TCP connections to the active pool during failover and + # failback, immediately draining traffic. A setting of false allows existing TCP + # connections to persist, even on VMs no longer in the active pool, for up to + # the duration of the connection draining timeout (10 minutes). # Corresponds to the JSON property `failoverPolicy` # @return [Google::Apis::ComputeAlpha::BackendServiceFailoverPolicy] attr_accessor :failover_policy @@ -3020,15 +3066,13 @@ module Google # @return [String] attr_accessor :fingerprint - # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for - # health checking this BackendService. Currently at most one health check can be - # specified. Health check is optional for Compute Engine backend services if - # there is no backend. A health check must not be specified when adding Internet - # Network Endpoint Group or Serverless Network Endpoint Group as backends. In - # all other cases, a health check is required for Compute Engine backend - # services. - # For internal load balancing, a URL to a HealthCheck resource must be specified - # instead. + # The list of URLs to the healthChecks, httpHealthChecks (legacy), or + # httpsHealthChecks (legacy) resource for health checking this backend service. + # Not all backend services support legacy health checks. See Load balancer + # guide. Currently at most one health check can be specified. Backend services + # with instance group or zonal NEG backends must have a health check. Backend + # services with internet NEG backends must not have a health check. A health + # check must # Corresponds to the JSON property `healthChecks` # @return [Array] attr_accessor :health_checks @@ -3127,9 +3171,9 @@ module Google # A named port on a backend instance group representing the port for # communication to the backend VMs in that group. Required when the - # loadBalancingScheme is EXTERNAL and the backends are instance groups. The - # named port must be defined on each backend instance group. This parameter has - # no meaning if the backends are NEGs. + # loadBalancingScheme is EXTERNAL, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED + # and the backends are instance groups. The named port must be defined on each + # backend instance group. This parameter has no meaning if the backends are NEGs. # Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP # Load Blaancing). # Corresponds to the JSON property `portName` @@ -3137,7 +3181,7 @@ module Google attr_accessor :port_name # The protocol this BackendService uses to communicate with backends. - # Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP, depending on the + # Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP. depending on the # chosen load balancer or Traffic Director configuration. Refer to the # documentation for the load balancer or for Traffic Director for more # information. @@ -3269,6 +3313,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::BackendServiceAggregatedList::Warning] @@ -3285,6 +3334,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -3391,7 +3441,13 @@ module Google end end - # + # Applicable only to Failover for Internal TCP/UDP Load Balancing. On failover + # or failback, this field indicates whether connection draining will be honored. + # GCP has a fixed connection draining timeout of 10 minutes. A setting of true + # terminates existing TCP connections to the active pool during failover and + # failback, immediately draining traffic. A setting of false allows existing TCP + # connections to persist, even on VMs no longer in the active pool, for up to + # the duration of the connection draining timeout (10 minutes). class BackendServiceFailoverPolicy include Google::Apis::Core::Hashable @@ -4158,6 +4214,66 @@ module Google end end + # + class BulkInsertInstanceResource + include Google::Apis::Core::Hashable + + # The maximum number of instances to create. + # Corresponds to the JSON property `count` + # @return [Fixnum] + attr_accessor :count + + # List of zones to exclude for regional requests. + # Corresponds to the JSON property `excludedZones` + # @return [Array] + attr_accessor :excluded_zones + + # Represents an Instance resource. + # An instance is a virtual machine that is hosted on Google Cloud Platform. For + # more information, read Virtual Machine Instances. (== resource_for `$ + # api_version`.instances ==) + # Corresponds to the JSON property `instance` + # @return [Google::Apis::ComputeAlpha::Instance] + attr_accessor :instance + + # The minimum number of instances to create. If no min_count is specified then + # count is used as the default value. If min_count instances cannot be created, + # then no instances will be created. + # Corresponds to the JSON property `minCount` + # @return [Fixnum] + attr_accessor :min_count + + # List of predefined names. The number of names provided must be equal to count. + # Corresponds to the JSON property `predefinedNames` + # @return [Array] + attr_accessor :predefined_names + + # Specifies the instance template from which to create the instance. This field + # is optional. This field is optional. It can be a full or partial URL. For + # example, the following are all valid URLs to an instance template: + # - https://www.googleapis.com/compute/v1/projects/project/global/ + # instanceTemplates/instanceTemplate + # - projects/project/global/instanceTemplates/instanceTemplate + # - global/instanceTemplates/instanceTemplate + # Corresponds to the JSON property `sourceInstanceTemplate` + # @return [String] + attr_accessor :source_instance_template + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @count = args[:count] if args.key?(:count) + @excluded_zones = args[:excluded_zones] if args.key?(:excluded_zones) + @instance = args[:instance] if args.key?(:instance) + @min_count = args[:min_count] if args.key?(:min_count) + @predefined_names = args[:predefined_names] if args.key?(:predefined_names) + @source_instance_template = args[:source_instance_template] if args.key?(:source_instance_template) + end + end + # class CacheInvalidationRule include Google::Apis::Core::Hashable @@ -4240,7 +4356,8 @@ module Google end end - # gRPC call credentials to access the SDS server. + # [Deprecated] gRPC call credentials to access the SDS server. gRPC call + # credentials to access the SDS server. class CallCredentials include Google::Apis::Core::Hashable @@ -4254,7 +4371,8 @@ module Google # @return [String] attr_accessor :call_credential_type - # Custom authenticator credentials. + # [Deprecated] Custom authenticator credentials. Custom authenticator + # credentials. # Corresponds to the JSON property `fromPlugin` # @return [Google::Apis::ComputeAlpha::MetadataCredentialsFromPlugin] attr_accessor :from_plugin @@ -4270,11 +4388,13 @@ module Google end end - # gRPC channel credentials to access the SDS server. + # [Deprecated] gRPC channel credentials to access the SDS server. gRPC channel + # credentials to access the SDS server. class ChannelCredentials include Google::Apis::Core::Hashable - # The paths to the mounted TLS Certificates and private key. + # [Deprecated] The paths to the mounted TLS Certificates and private key. The + # paths to the mounted TLS Certificates and private key. # Corresponds to the JSON property `certificates` # @return [Google::Apis::ComputeAlpha::TlsCertificatePaths] attr_accessor :certificates @@ -4356,12 +4476,13 @@ module Google end end - # The client side authentication settings for connection originating from the - # backend service. + # [Deprecated] The client side authentication settings for connection + # originating from the backend service. the backend service. class ClientTlsSettings include Google::Apis::Core::Hashable - # The TLS settings for the client or server. + # [Deprecated] The TLS settings for the client or server. The TLS settings for + # the client or server. # Corresponds to the JSON property `clientTlsContext` # @return [Google::Apis::ComputeAlpha::TlsContext] attr_accessor :client_tls_context @@ -4581,6 +4702,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::CommitmentAggregatedList::Warning] @@ -4597,6 +4723,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -5240,8 +5367,8 @@ module Google # Represents a Persistent Disk resource. # Google Compute Engine has two Disk resources: - # * [Global](/compute/docs/reference/rest/latest/disks) * [Regional](/compute/ - # docs/reference/rest/latest/regionDisks) + # * [Zonal](/compute/docs/reference/rest/`$api_version`/disks) * [Regional](/ + # compute/docs/reference/rest/`$api_version`/regionDisks) # Persistent disks are required for running your VM instances. Create both boot # and non-boot (data) persistent disks. For more information, read Persistent # Disks. For more storage options, read Storage options. @@ -5451,6 +5578,27 @@ module Google # @return [String] attr_accessor :source_image_id + # The source in-place snapshot used to create this disk. You can provide this as + # a partial or full URL to the resource. For example, the following are valid + # values: + # - https://www.googleapis.com/compute/v1/projects/project/global/ + # inPlaceSnapshots/inPlaceSnapshots + # - projects/project/global/inPlaceSnapshots/inPlaceSnapshots + # - global/inPlaceSnapshots/inPlaceSnapshots + # Corresponds to the JSON property `sourceInPlaceSnapshot` + # @return [String] + attr_accessor :source_in_place_snapshot + + # [Output Only] The unique ID of the in-place snapshot used to create this disk. + # This value identifies the exact in-place snapshot that was used to create this + # persistent disk. For example, if you created the persistent disk from an in- + # place snapshot that was later deleted and recreated under the same name, the + # source in-place snapshot ID would identify the exact version of the in-place + # snapshot that was used. + # Corresponds to the JSON property `sourceInPlaceSnapshotId` + # @return [String] + attr_accessor :source_in_place_snapshot_id + # The source snapshot used to create this disk. You can provide this as a # partial or full URL to the resource. For example, the following are valid # values: @@ -5550,6 +5698,8 @@ module Google @source_image = args[:source_image] if args.key?(:source_image) @source_image_encryption_key = args[:source_image_encryption_key] if args.key?(:source_image_encryption_key) @source_image_id = args[:source_image_id] if args.key?(:source_image_id) + @source_in_place_snapshot = args[:source_in_place_snapshot] if args.key?(:source_in_place_snapshot) + @source_in_place_snapshot_id = args[:source_in_place_snapshot_id] if args.key?(:source_in_place_snapshot_id) @source_snapshot = args[:source_snapshot] if args.key?(:source_snapshot) @source_snapshot_encryption_key = args[:source_snapshot_encryption_key] if args.key?(:source_snapshot_encryption_key) @source_snapshot_id = args[:source_snapshot_id] if args.key?(:source_snapshot_id) @@ -5596,6 +5746,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::DiskAggregatedList::Warning] @@ -5612,6 +5767,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -5885,8 +6041,8 @@ module Google # Represents a Disk Type resource. # Google Compute Engine has two Disk Type resources: - # * [Global](/compute/docs/reference/rest/latest/diskTypes) * [Regional](/ - # compute/docs/reference/rest/latest/regionDiskTypes) + # * [Regional](/compute/docs/reference/rest/`$api_version`/regionDiskTypes) * [ + # Zonal](/compute/docs/reference/rest/`$api_version`/diskTypes) # You can choose from a variety of disk types based on your needs. For more # information, read Storage options. # The diskTypes resource represents disk types for a zonal persistent disk. For @@ -6017,6 +6173,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::DiskTypeAggregatedList::Warning] @@ -6033,6 +6194,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -7523,8 +7685,8 @@ module Google # Represents a Forwarding Rule resource. # Forwarding rule resources in GCP can be either regional or global in scope: - # * [Global](/compute/docs/reference/rest/latest/globalForwardingRules) * [ - # Regional](/compute/docs/reference/rest/latest/forwardingRules) + # * [Global](/compute/docs/reference/rest/`$api_version`/globalForwardingRules) * + # [Regional](/compute/docs/reference/rest/`$api_version`/forwardingRules) # A forwarding rule and its corresponding IP address represent the frontend # configuration of a Google Cloud Platform load balancer. Forwarding rules can # also reference target instances and Cloud VPN Classic gateways ( @@ -7680,7 +7842,7 @@ module Google # - Internal TCP/UDP load balancers # - INTERNAL_MANAGED is used for: # - Internal HTTP(S) load balancers - # - >INTERNAL_SELF_MANAGED is used for: + # - INTERNAL_SELF_MANAGED is used for: # - Traffic Director # For more information about forwarding rules, refer to Forwarding rule concepts. # Corresponds to the JSON property `loadBalancingScheme` @@ -7725,7 +7887,7 @@ module Google attr_accessor :network # This signifies the networking tier used for configuring this load balancer and - # can only take the following values: PREMIUM , STANDARD. + # can only take the following values: PREMIUM, STANDARD. # For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For # GlobalForwardingRule, the valid value is PREMIUM. # If this field is not specified, it is assumed to be PREMIUM. If IPAddress is @@ -7897,6 +8059,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::ForwardingRuleAggregatedList::Warning] @@ -7913,6 +8080,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -8208,6 +8376,60 @@ module Google end end + # + class GrpcHealthCheck + include Google::Apis::Core::Hashable + + # The gRPC service name for the health check. This field is optional. The value + # of grpc_service_name has the following meanings by convention: + # - Empty service_name means the overall status of all services at the backend. + # - Non-empty service_name means the health of that gRPC service, as defined by + # the owner of the service. + # The grpc_service_name can only be ASCII. + # Corresponds to the JSON property `grpcServiceName` + # @return [String] + attr_accessor :grpc_service_name + + # The port number for the health check request. Must be specified if port_name + # and port_specification are not set or if port_specification is USE_FIXED_PORT. + # Valid values are 1 through 65535. + # Corresponds to the JSON property `port` + # @return [Fixnum] + attr_accessor :port + + # Port name as defined in InstanceGroup#NamedPort#name. If both port and + # port_name are defined, port takes precedence. The port_name should conform to + # RFC1035. + # Corresponds to the JSON property `portName` + # @return [String] + attr_accessor :port_name + + # Specifies how port is selected for health checking, can be one of following + # values: + # USE_FIXED_PORT: The port number in port is used for health checking. + # USE_NAMED_PORT: The portName is used for health checking. + # USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each + # network endpoint is used for health checking. For other backends, the port or + # named port specified in the Backend Service is used for health checking. + # If not specified, gRPC health check follows behavior specified in port and + # portName fields. + # Corresponds to the JSON property `portSpecification` + # @return [String] + attr_accessor :port_specification + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @grpc_service_name = args[:grpc_service_name] if args.key?(:grpc_service_name) + @port = args[:port] if args.key?(:port) + @port_name = args[:port_name] if args.key?(:port_name) + @port_specification = args[:port_specification] if args.key?(:port_specification) + end + end + # class GlobalNetworkEndpointGroupsAttachEndpointsRequest include Google::Apis::Core::Hashable @@ -8344,76 +8566,19 @@ module Google end end - # A Duration represents a signed, fixed-length span of time represented as a - # count of seconds and fractions of seconds at nanosecond resolution. It is - # independent of any calendar and concepts like "day" or "month". It is related - # to Timestamp in that the difference between two Timestamp values is a Duration - # and it can be added or subtracted from a Timestamp. Range is approximately +- - # 10,000 years. - # # Examples - # Example 1: Compute Duration from two Timestamps in pseudo code. - # Timestamp start = ...; Timestamp end = ...; Duration duration = ...; - # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - - # start.nanos; - # if (duration.seconds 0) ` duration.seconds += 1; duration.nanos -= 1000000000; - # ` else if (duration.seconds > 0 && duration.nanos < 0) ` duration.seconds -= - # 1; duration.nanos += 1000000000; ` - # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. - # Timestamp start = ...; Duration duration = ...; Timestamp end = ...; - # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + - # duration.nanos; - # if (end.nanos = 1000000000) ` end.seconds += 1; end.nanos -= 1000000000; ` - # Example 3: Compute Duration from datetime.timedelta in Python. - # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration. - # FromTimedelta(td) - # # JSON Mapping - # In JSON format, the Duration type is encoded as a string rather than an object, - # where the string ends in the suffix "s" (indicating seconds) and is preceded - # by the number of seconds, with nanoseconds expressed as fractional seconds. - # For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as " - # 3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3. - # 000000001s", and 3 seconds and 1 microsecond should be expressed in JSON - # format as "3.000001s". - class GoogleDuration - include Google::Apis::Core::Hashable - - # Signed fractions of a second at nanosecond resolution of the span of time. - # Durations less than one second are represented with a 0 `seconds` field and a - # positive or negative `nanos` field. For durations of one second or more, a non- - # zero value for the `nanos` field must be of the same sign as the `seconds` - # field. Must be from -999,999,999 to +999,999,999 inclusive. - # Corresponds to the JSON property `nanos` - # @return [Fixnum] - attr_accessor :nanos - - # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576, - # 000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/ - # hr * 24 hr/day * 365.25 days/year * 10000 years - # Corresponds to the JSON property `seconds` - # @return [Fixnum] - attr_accessor :seconds - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @nanos = args[:nanos] if args.key?(:nanos) - @seconds = args[:seconds] if args.key?(:seconds) - end - end - - # gRPC config to access the SDS server. + # [Deprecated] gRPC config to access the SDS server. gRPC config to access the + # SDS server. class GrpcServiceConfig include Google::Apis::Core::Hashable - # gRPC call credentials to access the SDS server. + # [Deprecated] gRPC call credentials to access the SDS server. gRPC call + # credentials to access the SDS server. # Corresponds to the JSON property `callCredentials` # @return [Google::Apis::ComputeAlpha::CallCredentials] attr_accessor :call_credentials - # gRPC channel credentials to access the SDS server. + # [Deprecated] gRPC channel credentials to access the SDS server. gRPC channel + # credentials to access the SDS server. # Corresponds to the JSON property `channelCredentials` # @return [Google::Apis::ComputeAlpha::ChannelCredentials] attr_accessor :channel_credentials @@ -8768,8 +8933,8 @@ module Google # Represents a Health Check resource. # Google Compute Engine has two Health Check resources: - # * [Global](/compute/docs/reference/rest/latest/healthChecks) * [Regional](/ - # compute/docs/reference/rest/latest/regionHealthChecks) + # * [Global](/compute/docs/reference/rest/`$api_version`/healthChecks) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionHealthChecks) # Internal HTTP(S) load balancers use regional health checks. All other types of # GCP load balancers and managed instance group auto-healing use global health # checks. For more information, read Health Check Concepts. @@ -8794,6 +8959,11 @@ module Google # @return [String] attr_accessor :description + # + # Corresponds to the JSON property `grpcHealthCheck` + # @return [Google::Apis::ComputeAlpha::GrpcHealthCheck] + attr_accessor :grpc_health_check + # A so-far unhealthy instance will be marked healthy after this many consecutive # successes. The default value is 2. # Corresponds to the JSON property `healthyThreshold` @@ -8902,6 +9072,7 @@ module Google @check_interval_sec = args[:check_interval_sec] if args.key?(:check_interval_sec) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) + @grpc_health_check = args[:grpc_health_check] if args.key?(:grpc_health_check) @healthy_threshold = args[:healthy_threshold] if args.key?(:healthy_threshold) @http2_health_check = args[:http2_health_check] if args.key?(:http2_health_check) @http_health_check = args[:http_health_check] if args.key?(:http_health_check) @@ -9401,6 +9572,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::HealthChecksAggregatedList::Warning] @@ -9417,6 +9593,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -9688,9 +9865,10 @@ module Google # @return [String] attr_accessor :description - # The list of host patterns to match. They must be valid hostnames, except * - # will match any string of ([a-z0-9-.]*). In that case, * must be the first - # character and must be followed in the pattern by either - or .. + # The list of host patterns to match. They must be valid hostnames with optional + # port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). + # In that case, * must be the first character and must be followed in the + # pattern by either - or .. # Corresponds to the JSON property `hosts` # @return [Array] attr_accessor :hosts @@ -9803,6 +9981,43 @@ module Google end end + # HttpFilterConfiguration supplies additional contextual settings for + # networkservices.HttpFilter resources enabled by Traffic Director. + class HttpFilterConfig + include Google::Apis::Core::Hashable + + # The configuration needed to enable the networkservices.HttpFilter resource. + # The configuration must be YAML formatted and only contain fields defined in + # the protobuf identified in configTypeUrl + # Corresponds to the JSON property `config` + # @return [String] + attr_accessor :config + + # The fully qualified versioned proto3 type url of the protobuf that the filter + # expects for its contextual settings, for example: type.googleapis.com/google. + # protobuf.Struct + # Corresponds to the JSON property `configTypeUrl` + # @return [String] + attr_accessor :config_type_url + + # Name of the networkservices.HttpFilter resource this configuration belongs to. + # This name must be known to the xDS client. Example: envoy.wasm + # Corresponds to the JSON property `filterName` + # @return [String] + attr_accessor :filter_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @config = args[:config] if args.key?(:config) + @config_type_url = args[:config_type_url] if args.key?(:config_type_url) + @filter_name = args[:filter_name] if args.key?(:filter_name) + end + end + # The request and response header transformations that take effect before the # request is passed along to the selected backendService. class HttpHeaderAction @@ -10477,6 +10692,23 @@ module Google # @return [Google::Apis::ComputeAlpha::HttpHeaderAction] attr_accessor :header_action + # Outbound route specific configuration for networkservices.HttpFilter resources + # enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers + # with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for + # more details. + # Corresponds to the JSON property `httpFilterConfigs` + # @return [Array] + attr_accessor :http_filter_configs + + # Outbound route specific metadata supplied to networkservices.HttpFilter + # resources enabled by Traffic Director. httpFilterMetadata only applies for + # Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See + # ForwardingRule for more details. + # The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct + # Corresponds to the JSON property `httpFilterMetadata` + # @return [Array] + attr_accessor :http_filter_metadata + # # Corresponds to the JSON property `matchRules` # @return [Array] @@ -10534,6 +10766,8 @@ module Google def update!(**args) @description = args[:description] if args.key?(:description) @header_action = args[:header_action] if args.key?(:header_action) + @http_filter_configs = args[:http_filter_configs] if args.key?(:http_filter_configs) + @http_filter_metadata = args[:http_filter_metadata] if args.key?(:http_filter_metadata) @match_rules = args[:match_rules] if args.key?(:match_rules) @priority = args[:priority] if args.key?(:priority) @route_action = args[:route_action] if args.key?(:route_action) @@ -11258,6 +11492,267 @@ module Google end end + # Represents a InPlaceSnapshot resource. + # You can use in-place snapshots to create disk rollback points quickly.. (== + # resource_for `$api_version`.inPlaceSnapshots ==) + class InPlaceSnapshot + include Google::Apis::Core::Hashable + + # [Output Only] Creation timestamp in RFC3339 text format. + # Corresponds to the JSON property `creationTimestamp` + # @return [String] + attr_accessor :creation_timestamp + + # An optional description of this resource. Provide this property when you + # create the resource. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # [Output Only] Size of the source disk, specified in GB. + # Corresponds to the JSON property `diskSizeGb` + # @return [Fixnum] + attr_accessor :disk_size_gb + + # Specifies to create an application consistent in-place snapshot by informing + # the OS to prepare for the snapshot process. Currently only supported on + # Windows instances using the Volume Shadow Copy Service (VSS). + # Corresponds to the JSON property `guestFlush` + # @return [Boolean] + attr_accessor :guest_flush + alias_method :guest_flush?, :guest_flush + + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # [Output Only] Type of the resource. Always compute#inPlaceSnapshot for + # InPlaceSnapshot resources. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # A fingerprint for the labels being applied to this InPlaceSnapshot, which is + # essentially a hash of the labels set used for optimistic locking. The + # fingerprint is initially generated by Compute Engine and changes after every + # request to modify or update labels. You must always provide an up-to-date + # fingerprint hash in order to update or change labels, otherwise the request + # will fail with error 412 conditionNotMet. + # To see the latest fingerprint, make a get() request to retrieve a + # InPlaceSnapshot. + # Corresponds to the JSON property `labelFingerprint` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :label_fingerprint + + # Labels to apply to this InPlaceSnapshot. These can be later modified by the + # setLabels method. Label values may be empty. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Name of the resource; provided by the client when the resource is created. The + # name must be 1-63 characters long, and comply with RFC1035. Specifically, the + # name must be 1-63 characters long and match the regular expression `[a-z]([-a- + # z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, + # and all following characters must be a dash, lowercase letter, or digit, + # except the last character, which cannot be a dash. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # [Output Only] URL of the region where the in-place snapshot resides. You must + # specify this field as part of the HTTP request URL. It is not settable as a + # field in the request body. + # Corresponds to the JSON property `region` + # @return [String] + attr_accessor :region + + # [Output Only] Server-defined URL for the resource. + # Corresponds to the JSON property `selfLink` + # @return [String] + attr_accessor :self_link + + # [Output Only] Server-defined URL for this resource's resource id. + # Corresponds to the JSON property `selfLinkWithId` + # @return [String] + attr_accessor :self_link_with_id + + # URL of the source disk used to create this in-place snapshot. Note that the + # source disk must be in the same zone/region as the in-place snapshot to be + # created. This can be a full or valid partial URL. For example, the following + # are valid values: + # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk + # - projects/project/zones/zone/disks/disk + # - zones/zone/disks/disk + # Corresponds to the JSON property `sourceDisk` + # @return [String] + attr_accessor :source_disk + + # [Output Only] The ID value of the disk used to create this InPlaceSnapshot. + # This value may be used to determine whether the InPlaceSnapshot was taken from + # the current or a previous instance of a given disk name. + # Corresponds to the JSON property `sourceDiskId` + # @return [String] + attr_accessor :source_disk_id + + # [Output Only] The status of the inPlaceSnapshot. This can be CREATING, + # DELETING, FAILED, or READY. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # [Output Only] URL of the zone where the in-place snapshot resides. You must + # specify this field as part of the HTTP request URL. It is not settable as a + # field in the request body. + # Corresponds to the JSON property `zone` + # @return [String] + attr_accessor :zone + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) + @description = args[:description] if args.key?(:description) + @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb) + @guest_flush = args[:guest_flush] if args.key?(:guest_flush) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @region = args[:region] if args.key?(:region) + @self_link = args[:self_link] if args.key?(:self_link) + @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) + @source_disk = args[:source_disk] if args.key?(:source_disk) + @source_disk_id = args[:source_disk_id] if args.key?(:source_disk_id) + @status = args[:status] if args.key?(:status) + @zone = args[:zone] if args.key?(:zone) + end + end + + # Contains a list of InPlaceSnapshot resources. + class InPlaceSnapshotList + include Google::Apis::Core::Hashable + + # [Output Only] Unique identifier for the resource; defined by the server. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # A list of InPlaceSnapshot resources. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # Type of resource. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # [Output Only] Server-defined URL for this resource. + # Corresponds to the JSON property `selfLink` + # @return [String] + attr_accessor :self_link + + # [Output Only] Informational warning message. + # Corresponds to the JSON property `warning` + # @return [Google::Apis::ComputeAlpha::InPlaceSnapshotList::Warning] + attr_accessor :warning + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @self_link = args[:self_link] if args.key?(:self_link) + @warning = args[:warning] if args.key?(:warning) + end + + # [Output Only] Informational warning message. + class Warning + include Google::Apis::Core::Hashable + + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. + # Corresponds to the JSON property `code` + # @return [String] + attr_accessor :code + + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` + # Corresponds to the JSON property `data` + # @return [Array] + attr_accessor :data + + # [Output Only] A human-readable description of the warning code. + # 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) + @data = args[:data] if args.key?(:data) + @message = args[:message] if args.key?(:message) + end + + # + class Datum + include Google::Apis::Core::Hashable + + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # [Output Only] A warning data value corresponding to the key. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @key = args[:key] if args.key?(:key) + @value = args[:value] if args.key?(:value) + end + end + end + end + # Initial State for shielded instance, these are public keys which are safe to # store in public class InitialStateConfig @@ -11486,7 +11981,7 @@ module Google # @return [Array] attr_accessor :resource_policies - # Sets the scheduling options for an Instance. NextID: 9 + # Sets the scheduling options for an Instance. NextID: 10 # Corresponds to the JSON property `scheduling` # @return [Google::Apis::ComputeAlpha::Scheduling] attr_accessor :scheduling @@ -11664,6 +12159,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::InstanceAggregatedList::Warning] @@ -11680,6 +12180,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -11904,6 +12405,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::InstanceGroupAggregatedList::Warning] @@ -11920,6 +12426,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -12445,6 +12952,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::InstanceGroupManagerAggregatedList::Warning] @@ -12461,6 +12973,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -12781,10 +13294,22 @@ module Google class InstanceGroupManagerStatusStateful include Google::Apis::Core::Hashable - # [Output Only] A bit indicating whether the managed instance group is stateful, - # i.e. has any disks in Stateful Policy or at least one per-instance config. - # This is determined based on the user intent, the group may be reported as not - # stateful even when there is still some preserved state on managed instances. + # [Output Only] A bit indicating whether the managed instance group has stateful + # configuration, that is, if you have configured any items in a stateful policy + # or in per-instance configs. The group might report that it has no stateful + # config even when there is still some preserved state on a managed instance, + # for example, if you have deleted all PICs but not yet applied those deletions. + # Corresponds to the JSON property `hasStatefulConfig` + # @return [Boolean] + attr_accessor :has_stateful_config + alias_method :has_stateful_config?, :has_stateful_config + + # [Output Only] A bit indicating whether the managed instance group has stateful + # configuration, that is, if you have configured any items in a stateful policy + # or in per-instance configs. The group might report that it has no stateful + # config even when there is still some preserved state on a managed instance, + # for example, if you have deleted all PICs but not yet applied those deletions. + # This field is deprecated in favor of has_stateful_config. # Corresponds to the JSON property `isStateful` # @return [Boolean] attr_accessor :is_stateful @@ -12796,6 +13321,7 @@ module Google # Update properties of this object def update!(**args) + @has_stateful_config = args[:has_stateful_config] if args.key?(:has_stateful_config) @is_stateful = args[:is_stateful] if args.key?(:is_stateful) end end @@ -14246,12 +14772,12 @@ module Google attr_accessor :reservation_affinity # Resource policies (names, not ULRs) applied to instances created from this - # templae. + # template. # Corresponds to the JSON property `resourcePolicies` # @return [Array] attr_accessor :resource_policies - # Sets the scheduling options for an Instance. NextID: 9 + # Sets the scheduling options for an Instance. NextID: 10 # Corresponds to the JSON property `scheduling` # @return [Google::Apis::ComputeAlpha::Scheduling] attr_accessor :scheduling @@ -15509,6 +16035,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::InterconnectAttachmentAggregatedList::Warning] @@ -15525,6 +16056,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -16884,7 +17416,8 @@ module Google end end - # JWT configuration for origin authentication. + # [Deprecated] JWT configuration for origin authentication. JWT configuration + # for origin authentication. class Jwt include Google::Apis::Core::Hashable @@ -16943,6 +17476,7 @@ module Google end end + # [Deprecated] This message specifies a header location to extract JWT token. # This message specifies a header location to extract JWT token. class JwtHeader include Google::Apis::Core::Hashable @@ -16969,7 +17503,11 @@ module Google end end - # A license resource. + # Represents a License resource. + # A License represents billing and aggregate usage data for public and + # marketplace images. Caution This resource is intended for use only by third- + # party partners who are creating Cloud Marketplace images. (== resource_for `$ + # api_version`.licenses ==) class License include Google::Apis::Core::Hashable @@ -17056,7 +17594,11 @@ module Google end end - # + # Represents a License Code resource. + # A License Code is a unique identifier used to represent a license resource. + # Caution This resource is intended for use only by third-party partners who are + # creating Cloud Marketplace images. (== resource_for `$api_version`. + # licenseCodes ==) class LicenseCode include Google::Apis::Core::Hashable @@ -17378,8 +17920,6 @@ module Google # Examples: counter ` metric: "/debug_access_count" field: "iam_principal" ` ==> # increment counter /iam/policy/debug_access_count `iam_principal=[value of # IAMContext.principal]` - # TODO(b/141846426): Consider supporting "authority" and "iam_principal" fields - # in the same counter. # Corresponds to the JSON property `counter` # @return [Google::Apis::ComputeAlpha::LogConfigCounterOptions] attr_accessor :counter @@ -17440,8 +17980,6 @@ module Google # Examples: counter ` metric: "/debug_access_count" field: "iam_principal" ` ==> # increment counter /iam/policy/debug_access_count `iam_principal=[value of # IAMContext.principal]` - # TODO(b/141846426): Consider supporting "authority" and "iam_principal" fields - # in the same counter. class LogConfigCounterOptions include Google::Apis::Core::Hashable @@ -17505,7 +18043,9 @@ module Google include Google::Apis::Core::Hashable # Whether Gin logging should happen in a fail-closed manner at the caller. This - # is relevant only in the LocalIAM implementation, for now. + # is currently supported in the LocalIAM implementation, Stubby C++, and Stubby + # Java. For Apps Framework, see go/af-audit-logging#failclosed. TODO(b/77591626): + # Add support for Stubby Go. TODO(b/129671387): Add support for Scaffolding. # Corresponds to the JSON property `logMode` # @return [String] attr_accessor :log_mode @@ -17905,6 +18445,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::MachineTypeAggregatedList::Warning] @@ -17921,6 +18466,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -18503,7 +19049,8 @@ module Google end end - # Custom authenticator credentials. + # [Deprecated] Custom authenticator credentials. Custom authenticator + # credentials. class MetadataCredentialsFromPlugin include Google::Apis::Core::Hashable @@ -18605,6 +19152,7 @@ module Google end end + # [Deprecated] Configuration for the mutual Tls mode for peer authentication. # Configuration for the mutual Tls mode for peer authentication. class MutualTls include Google::Apis::Core::Hashable @@ -18710,13 +19258,6 @@ module Google # @return [Fixnum] attr_accessor :mtu - # The multicast mode for this network. If set to ZONAL, multicast is allowed - # within a zone. If set to DISABLED, multicast is disabled for this network. The - # default is DISABLED. - # Corresponds to the JSON property `multicastMode` - # @return [String] - attr_accessor :multicast_mode - # Name of the resource. Provided by the client when the resource is created. The # name must be 1-63 characters long, and comply with RFC1035. Specifically, the # name must be 1-63 characters long and match the regular expression `[a-z]([-a- @@ -18769,7 +19310,6 @@ module Google @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @mtu = args[:mtu] if args.key?(:mtu) - @multicast_mode = args[:multicast_mode] if args.key?(:multicast_mode) @name = args[:name] if args.key?(:name) @peerings = args[:peerings] if args.key?(:peerings) @routing_config = args[:routing_config] if args.key?(:routing_config) @@ -18833,8 +19373,8 @@ module Google end # Represents a collection of network endpoints. - # For more information read Setting up network endpoint groups in load balancing. - # (== resource_for `$api_version`.networkEndpointGroups ==) Next ID: 21 + # For more information read Network endpoint groups overview. (== resource_for `$ + # api_version`.networkEndpointGroups ==) Next ID: 21 class NetworkEndpointGroup include Google::Apis::Core::Hashable @@ -18920,8 +19460,7 @@ module Google # @return [String] attr_accessor :network - # Type of network endpoints in this network endpoint group. Currently the only - # supported value is GCE_VM_IP_PORT. + # Type of network endpoints in this network endpoint group. # Corresponds to the JSON property `networkEndpointType` # @return [String] attr_accessor :network_endpoint_type @@ -19028,6 +19567,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::NetworkEndpointGroupAggregatedList::Warning] @@ -19044,6 +19588,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -20272,6 +20817,12 @@ module Google # @return [String] attr_accessor :maintenance_policy + # Time window specified for daily maintenance operations. GCE's internal + # maintenance will be performed within this window. + # Corresponds to the JSON property `maintenanceWindow` + # @return [Google::Apis::ComputeAlpha::NodeGroupMaintenanceWindow] + attr_accessor :maintenance_window + # The name of the resource, provided by the client when initially creating the # resource. The resource name must be 1-63 characters long, and comply with # RFC1035. Specifically, the name must be 1-63 characters long and match the @@ -20327,6 +20878,7 @@ module Google @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @maintenance_policy = args[:maintenance_policy] if args.key?(:maintenance_policy) + @maintenance_window = args[:maintenance_window] if args.key?(:maintenance_window) @name = args[:name] if args.key?(:name) @node_template = args[:node_template] if args.key?(:node_template) @self_link = args[:self_link] if args.key?(:self_link) @@ -20371,6 +20923,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::NodeGroupAggregatedList::Warning] @@ -20387,6 +20944,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -20604,6 +21162,35 @@ module Google end end + # Time window specified for daily maintenance operations. GCE's internal + # maintenance will be performed within this window. + class NodeGroupMaintenanceWindow + include Google::Apis::Core::Hashable + + # [Output only] A predetermined duration for the window, automatically chosen to + # be the smallest possible in the given scenario. + # Corresponds to the JSON property `duration` + # @return [String] + attr_accessor :duration + + # Start time of the window. This must be in UTC format that resolves to one of + # 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08: + # 00 are valid. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @duration = args[:duration] if args.key?(:duration) + @start_time = args[:start_time] if args.key?(:start_time) + end + end + # class NodeGroupNode include Google::Apis::Core::Hashable @@ -20613,6 +21200,11 @@ module Google # @return [Array] attr_accessor :accelerators + # CPU overcommit. + # Corresponds to the JSON property `cpuOvercommitType` + # @return [String] + attr_accessor :cpu_overcommit_type + # Local disk configurations. # Corresponds to the JSON property `disks` # @return [Array] @@ -20655,6 +21247,7 @@ module Google # Update properties of this object def update!(**args) @accelerators = args[:accelerators] if args.key?(:accelerators) + @cpu_overcommit_type = args[:cpu_overcommit_type] if args.key?(:cpu_overcommit_type) @disks = args[:disks] if args.key?(:disks) @instances = args[:instances] if args.key?(:instances) @name = args[:name] if args.key?(:name) @@ -20935,7 +21528,7 @@ module Google # Represent a sole-tenant Node Template resource. # You can use a template to define properties for nodes in a node group. For # more information, read Creating node groups and instances. (== resource_for `$ - # api_version`.nodeTemplates ==) (== NextID: 18 ==) + # api_version`.nodeTemplates ==) (== NextID: 19 ==) class NodeTemplate include Google::Apis::Core::Hashable @@ -20944,6 +21537,11 @@ module Google # @return [Array] attr_accessor :accelerators + # CPU overcommit. + # Corresponds to the JSON property `cpuOvercommitType` + # @return [String] + attr_accessor :cpu_overcommit_type + # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] @@ -21045,6 +21643,7 @@ module Google # Update properties of this object def update!(**args) @accelerators = args[:accelerators] if args.key?(:accelerators) + @cpu_overcommit_type = args[:cpu_overcommit_type] if args.key?(:cpu_overcommit_type) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @disks = args[:disks] if args.key?(:disks) @@ -21097,6 +21696,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::NodeTemplateAggregatedList::Warning] @@ -21113,6 +21717,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -21554,6 +22159,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::NodeTypeAggregatedList::Warning] @@ -21570,6 +22180,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -22094,15 +22705,15 @@ module Google # Represents an Operation resource. # Google Compute Engine has three Operation resources: - # * [Global](/compute/docs/reference/rest/latest/globalOperations) * [Regional](/ - # compute/docs/reference/rest/latest/regionOperations) * [Zonal](/compute/docs/ - # reference/rest/latest/zoneOperations) + # * [Global](/compute/docs/reference/rest/`$api_version`/globalOperations) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionOperations) * [ + # Zonal](/compute/docs/reference/rest/`$api_version`/zoneOperations) # You can use an operation resource to manage asynchronous API requests. For # more information, read Handling API responses. # Operations can be global, regional or zonal. - # - For global operations, use the globalOperations resource. - # - For regional operations, use the regionOperations resource. - # - For zonal operations, use the zonalOperations resource. + # - For global operations, use the `globalOperations` resource. + # - For regional operations, use the `regionOperations` resource. + # - For zonal operations, use the `zonalOperations` resource. # For more information, read Global, Regional, and Zonal Resources. (== # resource_for `$api_version`.globalOperations ==) (== resource_for `$ # api_version`.regionOperations ==) (== resource_for `$api_version`. @@ -22140,13 +22751,13 @@ module Google attr_accessor :error # [Output Only] If the operation fails, this field contains the HTTP error - # message that was returned, such as NOT FOUND. + # message that was returned, such as `NOT FOUND`. # Corresponds to the JSON property `httpErrorMessage` # @return [String] attr_accessor :http_error_message # [Output Only] If the operation fails, this field contains the HTTP error - # status code that was returned. For example, a 404 means the resource was not + # status code that was returned. For example, a `404` means the resource was not # found. # Corresponds to the JSON property `httpErrorStatusCode` # @return [Fixnum] @@ -22164,7 +22775,7 @@ module Google # @return [String] attr_accessor :insert_time - # [Output Only] Type of the resource. Always compute#operation for Operation + # [Output Only] Type of the resource. Always `compute#operation` for Operation # resources. # Corresponds to the JSON property `kind` # @return [String] @@ -22175,8 +22786,8 @@ module Google # @return [String] attr_accessor :name - # [Output Only] The type of operation, such as insert, update, or delete, and so - # on. + # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, + # and so on. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type @@ -22211,8 +22822,8 @@ module Google # @return [String] attr_accessor :start_time - # [Output Only] The status of the operation, which can be one of the following: - # PENDING, RUNNING, or DONE. + # [Output Only] The status of the operation, which can be one of the following: ` + # PENDING`, `RUNNING`, or `DONE`. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -22236,7 +22847,8 @@ module Google # @return [String] attr_accessor :target_link - # [Output Only] User who requested the operation, for example: user@example.com. + # [Output Only] User who requested the operation, for example: `user@example.com` + # . # Corresponds to the JSON property `user` # @return [String] attr_accessor :user @@ -22417,16 +23029,16 @@ module Google # @return [Hash] attr_accessor :items - # [Output Only] Type of resource. Always compute#operationAggregatedList for + # [Output Only] Type of resource. Always `compute#operationAggregatedList` for # aggregated lists of operations. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] This token allows you to get the next page of results for list - # requests. If the number of results is larger than maxResults, use the - # nextPageToken as a value for the query parameter pageToken in the next list - # request. Subsequent list requests will have their own nextPageToken to + # requests. If the number of results is larger than `maxResults`, use the ` + # nextPageToken` as a value for the query parameter `pageToken` in the next list + # request. Subsequent list requests will have their own `nextPageToken` to # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -22437,6 +23049,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::OperationAggregatedList::Warning] @@ -22453,6 +23070,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -22536,16 +23154,16 @@ module Google # @return [Array] attr_accessor :items - # [Output Only] Type of resource. Always compute#operations for Operations + # [Output Only] Type of resource. Always `compute#operations` for Operations # resource. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] This token allows you to get the next page of results for list - # requests. If the number of results is larger than maxResults, use the - # nextPageToken as a value for the query parameter pageToken in the next list - # request. Subsequent list requests will have their own nextPageToken to + # requests. If the number of results is larger than `maxResults`, use the ` + # nextPageToken` as a value for the query parameter `pageToken` in the next list + # request. Subsequent list requests will have their own `nextPageToken` to # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -22758,11 +23376,13 @@ module Google end end - # Configuration for the origin authentication method. + # [Deprecated] Configuration for the origin authentication method. Configuration + # for the origin authentication method. class OriginAuthenticationMethod include Google::Apis::Core::Hashable - # JWT configuration for origin authentication. + # [Deprecated] JWT configuration for origin authentication. JWT configuration + # for origin authentication. # Corresponds to the JSON property `jwt` # @return [Google::Apis::ComputeAlpha::Jwt] attr_accessor :jwt @@ -23085,6 +23705,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::PacketMirroringAggregatedList::Warning] @@ -23101,6 +23726,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -23698,10 +24324,12 @@ module Google end end - # Configuration for the peer authentication method. + # [Deprecated] Configuration for the peer authentication method. Configuration + # for the peer authentication method. class PeerAuthenticationMethod include Google::Apis::Core::Hashable + # [Deprecated] Configuration for the mutual Tls mode for peer authentication. # Configuration for the mutual Tls mode for peer authentication. # Corresponds to the JSON property `mtls` # @return [Google::Apis::ComputeAlpha::MutualTls] @@ -23721,21 +24349,21 @@ module Google class PerInstanceConfig include Google::Apis::Core::Hashable - # Fingerprint of this per-instance config. This field may be used in optimistic - # locking. It will be ignored when inserting a per-instance config. An up-to- - # date fingerprint must be provided in order to update an existing per-instance + # Fingerprint of this per-instance config. This field can be used in optimistic + # locking. It is ignored when inserting a per-instance config. An up-to-date + # fingerprint must be provided in order to update an existing per-instance # config or the field needs to be unset. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint - # The name of the per-instance config and the corresponding instance. Serves as - # a merge key during UpdatePerInstanceConfigs operation, i.e. if per-instance - # config with the same name exists then it will be updated, otherwise a new one - # will be created for the VM instance with the same name. An attempt to create a - # per-instance config for a VM instance that either doesn't exist or is not part - # of the group will result in a failure. + # The name of a per-instance config and its corresponding instance. Serves as a + # merge key during UpdatePerInstanceConfigs operations, that is, if a per- + # instance config with the same name exists then it will be updated, otherwise a + # new one will be created for the VM instance with the same name. An attempt to + # create a per-instance config for a VM instance that either doesn't exist or is + # not part of the group will result in an error. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -23757,7 +24385,7 @@ module Google end end - # All fields defined in a permission are ANDed. + # [Deprecated] All fields defined in a permission are ANDed. class Permission include Google::Apis::Core::Hashable @@ -24044,7 +24672,7 @@ module Google end end - # All fields defined in a principal are ANDed. + # [Deprecated] All fields defined in a principal are ANDed. class Principal include Google::Apis::Core::Hashable @@ -24769,6 +25397,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::PublicDelegatedPrefixAggregatedList::Warning] @@ -24785,6 +25418,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -26690,8 +27324,8 @@ module Google # Represents a URL Map resource. # Google Compute Engine has two URL Map resources: - # * [Global](/compute/docs/reference/rest/latest/urlMaps) * [Regional](/compute/ - # docs/reference/rest/latest/regionUrlMaps) + # * [Global](/compute/docs/reference/rest/`$api_version`/urlMaps) * [Regional](/ + # compute/docs/reference/rest/`$api_version`/regionUrlMaps) # A URL map resource is a component of certain types of GCP load balancers and # Traffic Director. # * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * @@ -26908,6 +27542,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::ReservationAggregatedList::Warning] @@ -26924,6 +27563,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -27370,7 +28010,10 @@ module Google end end - # + # Represents a Resource Policy resource. You can use resource policies to + # schedule actions for some Compute Engine resources. For example, you can use + # them to schedule persistent disk snapshots. + # (== resource_for `$api_version`.resourcePolicies ==) class ResourcePolicy include Google::Apis::Core::Hashable @@ -27504,6 +28147,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::ResourcePolicyAggregatedList::Warning] @@ -27521,6 +28169,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -27593,7 +28242,8 @@ module Google class ResourcePolicyDailyCycle include Google::Apis::Core::Hashable - # Defines a schedule that runs every nth day of the month. + # Defines a schedule with units measured in months. The value determines how + # many months pass between the start of each cycle. # Corresponds to the JSON property `daysInCycle` # @return [Fixnum] attr_accessor :days_in_cycle @@ -27679,7 +28329,8 @@ module Google # @return [String] attr_accessor :duration - # Allows to define schedule that runs every nth hour. + # Defines a schedule with units measured in hours. The value determines how many + # hours pass between the start of each cycle. # Corresponds to the JSON property `hoursInCycle` # @return [Fixnum] attr_accessor :hours_in_cycle @@ -28054,7 +28705,9 @@ module Google class ResourcePolicyWeeklyCycleDayOfWeek include Google::Apis::Core::Hashable - # Allows to define schedule that runs specified day of the week. + # Defines a schedule that runs on specific days of the week. Specify one or more + # days. The following options are available: MONDAY, TUESDAY, WEDNESDAY, + # THURSDAY, FRIDAY, SATURDAY, SUNDAY. # Corresponds to the JSON property `day` # @return [String] attr_accessor :day @@ -28590,6 +29243,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::RouterAggregatedList::Warning] @@ -28606,6 +29264,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -28946,15 +29605,15 @@ module Google attr_accessor :ip_range # URI of the linked Interconnect attachment. It must be in the same region as - # the router. Each interface can have one linked resource, which can be either - # be a VPN tunnel or an Interconnect attachment. + # the router. Each interface can have one linked resource, which can be a VPN + # tunnel, an Interconnect attachment, or a virtual machine instance. # Corresponds to the JSON property `linkedInterconnectAttachment` # @return [String] attr_accessor :linked_interconnect_attachment # URI of the linked VPN tunnel, which must be in the same region as the router. - # Each interface can have one linked resource, which can be either a VPN tunnel - # or an Interconnect attachment. + # Each interface can have one linked resource, which can be a VPN tunnel, an + # Interconnect attachment, or a virtual machine instance. # Corresponds to the JSON property `linkedVpnTunnel` # @return [String] attr_accessor :linked_vpn_tunnel @@ -29865,7 +30524,7 @@ module Google end end - # Sets the scheduling options for an Instance. NextID: 9 + # Sets the scheduling options for an Instance. NextID: 10 class Scheduling include Google::Apis::Core::Hashable @@ -29894,6 +30553,17 @@ module Google # @return [String] attr_accessor :location_hint + # Compute Engine Long Term Release. When specified, VMs that have this policy + # become long term release (internal: stable fleet) VMs. + # For all VM shapes, this should result in fewer disruptions due to software + # updates and greater predictability via 1 week extended notifications. + # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/ + # stable-fleet-gpus-design for more details. + # Corresponds to the JSON property `longTermRelease` + # @return [Boolean] + attr_accessor :long_term_release + alias_method :long_term_release?, :long_term_release + # The minimum number of virtual CPUs this instance will consume when running on # a sole-tenant node. # Corresponds to the JSON property `minNodeCpus` @@ -29901,7 +30571,7 @@ module Google attr_accessor :min_node_cpus # A set of node affinity and anti-affinity configurations. Refer to Configuring - # node affinity for more information. + # node affinity for more information. Overrides reservationAffinity. # Corresponds to the JSON property `nodeAffinities` # @return [Array] attr_accessor :node_affinities @@ -29931,6 +30601,7 @@ module Google @automatic_restart = args[:automatic_restart] if args.key?(:automatic_restart) @latency_tolerant = args[:latency_tolerant] if args.key?(:latency_tolerant) @location_hint = args[:location_hint] if args.key?(:location_hint) + @long_term_release = args[:long_term_release] if args.key?(:long_term_release) @min_node_cpus = args[:min_node_cpus] if args.key?(:min_node_cpus) @node_affinities = args[:node_affinities] if args.key?(:node_affinities) @on_host_maintenance = args[:on_host_maintenance] if args.key?(:on_host_maintenance) @@ -29997,11 +30668,13 @@ module Google end end - # The configuration to access the SDS server. + # [Deprecated] The configuration to access the SDS server. The configuration to + # access the SDS server. class SdsConfig include Google::Apis::Core::Hashable - # gRPC config to access the SDS server. + # [Deprecated] gRPC config to access the SDS server. gRPC config to access the + # SDS server. # Corresponds to the JSON property `grpcServiceConfig` # @return [Google::Apis::ComputeAlpha::GrpcServiceConfig] attr_accessor :grpc_service_config @@ -30717,32 +31390,57 @@ module Google class SecuritySettings include Google::Apis::Core::Hashable - # The authentication settings for the backend service. + # A URL referring to a networksecurity.Authentication resource that describes + # how clients should authenticate with this service's backends. If left blank, + # communications between services are not encrypted (i.e., the TLS policy is set + # to OPEN). When sending traffic to this service's backends, the OriginationTls + # setting of Authentication.TransportAuthentication is applied. Refer to the + # Authentication and Authentication.TransportAuthentication.OriginationTls + # resources for additional details. authentication only applies to a global + # BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. + # Corresponds to the JSON property `authentication` + # @return [String] + attr_accessor :authentication + + # [Deprecated] The authentication settings for the backend service. The + # authentication settings for the backend service. # Corresponds to the JSON property `authenticationPolicy` # @return [Google::Apis::ComputeAlpha::AuthenticationPolicy] attr_accessor :authentication_policy - # Authorization configuration provides service-level and method-level access - # control for a service. + # [Deprecated] Authorization configuration provides service-level and method- + # level access control for a service. control for a service. # Corresponds to the JSON property `authorizationConfig` # @return [Google::Apis::ComputeAlpha::AuthorizationConfig] attr_accessor :authorization_config - # The client side authentication settings for connection originating from the - # backend service. + # [Deprecated] The client side authentication settings for connection + # originating from the backend service. the backend service. # Corresponds to the JSON property `clientTlsSettings` # @return [Google::Apis::ComputeAlpha::ClientTlsSettings] attr_accessor :client_tls_settings + # Optional. A list of subject alternate names to verify the subject identity ( + # SAN) in the certificate presented by the server, to authorize the SAN list as + # identities to run the service represented by this BackendService. If specified, + # the client will verify that the server certificate's subject alt name matches + # one of the specified values. Only applies to a global BackendService with the + # loadBalancingScheme set to INTERNAL_SELF_MANAGED. + # Corresponds to the JSON property `subjectAltNames` + # @return [Array] + attr_accessor :subject_alt_names + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @authentication = args[:authentication] if args.key?(:authentication) @authentication_policy = args[:authentication_policy] if args.key?(:authentication_policy) @authorization_config = args[:authorization_config] if args.key?(:authorization_config) @client_tls_settings = args[:client_tls_settings] if args.key?(:client_tls_settings) + @subject_alt_names = args[:subject_alt_names] if args.key?(:subject_alt_names) end end @@ -30817,7 +31515,8 @@ module Google class ServerTlsSettings include Google::Apis::Core::Hashable - # The TLS settings for the client or server. + # [Deprecated] The TLS settings for the client or server. The TLS settings for + # the client or server. # Corresponds to the JSON property `proxyTlsContext` # @return [Google::Apis::ComputeAlpha::TlsContext] attr_accessor :proxy_tls_context @@ -31555,7 +32254,7 @@ module Google # @return [Array] attr_accessor :network_interfaces - # Sets the scheduling options for an Instance. NextID: 9 + # Sets the scheduling options for an Instance. NextID: 10 # Corresponds to the JSON property `scheduling` # @return [Google::Apis::ComputeAlpha::Scheduling] attr_accessor :scheduling @@ -31597,16 +32296,19 @@ module Google # Represents an SSL Certificate resource. # Google Compute Engine has two SSL Certificate resources: - # * [Global](/compute/docs/reference/rest/latest/sslCertificates) * [Regional](/ - # compute/docs/reference/rest/latest/regionSslCertificates) - # - sslCertificates are used by: - external HTTPS load balancers - SSL proxy - # load balancers - # - regionSslCertificates are used by: - internal HTTPS load balancers - # This SSL certificate resource also contains a private key. You can use SSL - # keys and certificates to secure connections to a load balancer. For more - # information, read Creating and Using SSL Certificates. (== resource_for `$ - # api_version`.sslCertificates ==) (== resource_for `$api_version`. - # regionSslCertificates ==) Next ID: 17 + # * [Global](/compute/docs/reference/rest/`$api_version`/sslCertificates) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionSslCertificates) + # The sslCertificates are used by: + # - external HTTPS load balancers + # - SSL proxy load balancers + # The regionSslCertificates are used by internal HTTPS load balancers. + # Optionally, certificate file contents that you upload can contain a set of up + # to five PEM-encoded certificates. The API call creates an object ( + # sslCertificate) that holds this data. You can use SSL keys and certificates to + # secure connections to a load balancer. For more information, read Creating + # and using SSL certificates and SSL certificates quotas and limits. (== + # resource_for `$api_version`.sslCertificates ==) (== resource_for `$api_version` + # .regionSslCertificates ==) class SslCertificate include Google::Apis::Core::Hashable @@ -31758,6 +32460,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::SslCertificateAggregatedList::Warning] @@ -31774,6 +32481,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -32693,20 +33401,13 @@ module Google # @return [String] attr_accessor :purpose - # The type of IP CIDR range to associate with this subnetwork. The default is - # RFC_1918. When creating a subnetwork in non-RFC 1918 range, this field must be - # set to NON_RFC_1918. - # Corresponds to the JSON property `rangeType` - # @return [String] - attr_accessor :range_type - # URL of the region where the Subnetwork resides. This field can be set only at # resource creation time. # Corresponds to the JSON property `region` # @return [String] attr_accessor :region - # The role of subnetwork. Currenly, this field is only used when purpose = + # The role of subnetwork. Currently, this field is only used when purpose = # INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An # ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) # Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to @@ -32771,7 +33472,6 @@ module Google @private_ipv6_google_access = args[:private_ipv6_google_access] if args.key?(:private_ipv6_google_access) @private_ipv6_google_access_service_accounts = args[:private_ipv6_google_access_service_accounts] if args.key?(:private_ipv6_google_access_service_accounts) @purpose = args[:purpose] if args.key?(:purpose) - @range_type = args[:range_type] if args.key?(:range_type) @region = args[:region] if args.key?(:region) @role = args[:role] if args.key?(:role) @secondary_ip_ranges = args[:secondary_ip_ranges] if args.key?(:secondary_ip_ranges) @@ -32815,6 +33515,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::SubnetworkAggregatedList::Warning] @@ -32831,6 +33536,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -33099,13 +33805,6 @@ module Google # @return [String] attr_accessor :range_name - # The type of IP CIDR range to associate with this subnetwork secondary range. - # The default is RFC_1918. When creating a subnetwork in non-RFC 1918 range, - # this field must be set to NON_RFC_1918. - # Corresponds to the JSON property `rangeType` - # @return [String] - attr_accessor :range_type - def initialize(**args) update!(**args) end @@ -33114,7 +33813,6 @@ module Google def update!(**args) @ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range) @range_name = args[:range_name] if args.key?(:range_name) - @range_type = args[:range_type] if args.key?(:range_type) end end @@ -33130,13 +33828,6 @@ module Google # @return [String] attr_accessor :ip_cidr_range - # The type of IP CIDR range to associate with this subnetwork. The default is - # RFC_1918. When expanding to a non-RFC 1918 range, this field must be be set to - # NON_RFC_1918. - # Corresponds to the JSON property `rangeType` - # @return [String] - attr_accessor :range_type - def initialize(**args) update!(**args) end @@ -33144,7 +33835,6 @@ module Google # Update properties of this object def update!(**args) @ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range) - @range_type = args[:range_type] if args.key?(:range_type) end end @@ -33354,6 +34044,213 @@ module Google end end + # Represents a Target gRPC Proxy resource. + # A target gRPC proxy is a component of load balancers intended for load + # balancing gRPC traffic. Global forwarding rules reference a target gRPC proxy. + # The Target gRPC Proxy references a URL map which specifies how traffic routes + # to gRPC backend services. + class TargetGrpcProxy + include Google::Apis::Core::Hashable + + # [Output Only] Creation timestamp in RFC3339 text format. + # Corresponds to the JSON property `creationTimestamp` + # @return [String] + attr_accessor :creation_timestamp + + # An optional description of this resource. Provide this property when you + # create the resource. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # [Output Only] The unique identifier for the resource type. The server + # generates this identifier. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # [Output Only] Type of the resource. Always compute#targetGrpcProxy for target + # grpc proxies. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of the resource. Provided by the client when the resource is created. The + # name must be 1-63 characters long, and comply with RFC1035. Specifically, the + # name must be 1-63 characters long and match the regular expression `[a-z]([-a- + # z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, + # and all following characters must be a dash, lowercase letter, or digit, + # except the last character, which cannot be a dash. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # [Output Only] Server-defined URL for the resource. + # Corresponds to the JSON property `selfLink` + # @return [String] + attr_accessor :self_link + + # [Output Only] Server-defined URL with id for the resource. + # Corresponds to the JSON property `selfLinkWithId` + # @return [String] + attr_accessor :self_link_with_id + + # URL to the UrlMap resource that defines the mapping from URL to the + # BackendService. The protocol field in the BackendService must be set to GRPC. + # Corresponds to the JSON property `urlMap` + # @return [String] + attr_accessor :url_map + + # If true, indicates that the BackendServices referenced by the urlMap may be + # accessed by gRPC applications without using a sidecar proxy. This will enable + # configuration checks on urlMap and its referenced BackendServices to not allow + # unsupported features. A gRPC application must use "xds-experimental:///" + # scheme in the target URI of the service it is connecting to. If false, + # indicates that the BackendServices referenced by the urlMap will be accessed + # by gRPC applications via a sidecar proxy. In this case, a gRPC application + # must not use "xds-experimental:///" scheme in the target URI of the service it + # is connecting to + # Corresponds to the JSON property `validateForProxyless` + # @return [Boolean] + attr_accessor :validate_for_proxyless + alias_method :validate_for_proxyless?, :validate_for_proxyless + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) + @description = args[:description] if args.key?(:description) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @self_link = args[:self_link] if args.key?(:self_link) + @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) + @url_map = args[:url_map] if args.key?(:url_map) + @validate_for_proxyless = args[:validate_for_proxyless] if args.key?(:validate_for_proxyless) + end + end + + # + class TargetGrpcProxyList + include Google::Apis::Core::Hashable + + # [Output Only] Unique identifier for the resource; defined by the server. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # A list of TargetGrpcProxy resources. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # [Output Only] Type of the resource. Always compute#targetGrpcProxy for target + # grpc proxies. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # [Output Only] Server-defined URL for this resource. + # Corresponds to the JSON property `selfLink` + # @return [String] + attr_accessor :self_link + + # [Output Only] Informational warning message. + # Corresponds to the JSON property `warning` + # @return [Google::Apis::ComputeAlpha::TargetGrpcProxyList::Warning] + attr_accessor :warning + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @self_link = args[:self_link] if args.key?(:self_link) + @warning = args[:warning] if args.key?(:warning) + end + + # [Output Only] Informational warning message. + class Warning + include Google::Apis::Core::Hashable + + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. + # Corresponds to the JSON property `code` + # @return [String] + attr_accessor :code + + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` + # Corresponds to the JSON property `data` + # @return [Array] + attr_accessor :data + + # [Output Only] A human-readable description of the warning code. + # 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) + @data = args[:data] if args.key?(:data) + @message = args[:message] if args.key?(:message) + end + + # + class Datum + include Google::Apis::Core::Hashable + + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # [Output Only] A warning data value corresponding to the key. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @key = args[:key] if args.key?(:key) + @value = args[:value] if args.key?(:value) + end + end + end + end + # class TargetHttpProxiesScopedList include Google::Apis::Core::Hashable @@ -33447,8 +34344,8 @@ module Google # Represents a Target HTTP Proxy resource. # Google Compute Engine has two Target HTTP Proxy resources: - # * [Global](/compute/docs/reference/rest/latest/targetHttpProxies) * [Regional]( - # /compute/docs/reference/rest/latest/regionTargetHttpProxies) + # * [Global](/compute/docs/reference/rest/`$api_version`/targetHttpProxies) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionTargetHttpProxies) # A target HTTP proxy is a component of GCP HTTP load balancers. # * targetHttpProxies are used by external HTTP load balancers and Traffic # Director. * regionTargetHttpProxies are used by internal HTTP load balancers. @@ -33470,6 +34367,21 @@ module Google # @return [String] attr_accessor :description + # Urls to networkservices.HttpFilter resources enabled for xDS clients using + # this configuration. For example, https://networkservices.googleapis.com/ + # v1alpha1/projects/project/locations/locationhttpFilters/httpFilter Only + # filters that handle outbound connection and stream events may be specified. + # These filters work in conjunction with a default set of HTTP filters that may + # already be configured by Traffic Director. Traffic Director will determine the + # final location of these filters within xDS configuration based on the name of + # the HTTP filter. If Traffic Director positions multiple filters at the same + # location, those filters will be in the same order as specified in this list. + # httpFilters only applies for loadbalancers with loadBalancingScheme set to + # INTERNAL_SELF_MANAGED. See ForwardingRule for more details. + # Corresponds to the JSON property `httpFilters` + # @return [Array] + attr_accessor :http_filters + # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` @@ -33530,6 +34442,7 @@ module Google def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) + @http_filters = args[:http_filters] if args.key?(:http_filters) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @@ -33575,6 +34488,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::TargetHttpProxyAggregatedList::Warning] @@ -33591,6 +34509,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -33909,8 +34828,8 @@ module Google # Represents a Target HTTPS Proxy resource. # Google Compute Engine has two Target HTTPS Proxy resources: - # * [Global](/compute/docs/reference/rest/latest/targetHttpsProxies) * [Regional] - # (/compute/docs/reference/rest/latest/regionTargetHttpsProxies) + # * [Global](/compute/docs/reference/rest/`$api_version`/targetHttpsProxies) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionTargetHttpsProxies) # A target HTTPS proxy is a component of GCP HTTPS load balancers. # * targetHttpsProxies are used by external HTTPS load balancers. * # regionTargetHttpsProxies are used by internal HTTPS load balancers. @@ -33921,6 +34840,38 @@ module Google class TargetHttpsProxy include Google::Apis::Core::Hashable + # A URL referring to a networksecurity.Authentication resource that describes + # how the proxy should authenticate inbound traffic. If left blank, + # communications between services are not encrypted (i.e., the TLS policy is set + # to OPEN). When terminating inbound traffic to this proxy, the TerminationTls + # setting of Authentication.TransportAuthentication is applied. + # Refer to the Authentication and Authentication.TransportAuthentication. + # TerminationTls resources for additional details. + # authentication only applies to a global TargetHttpsProxy attached to + # globalForwardingRules with the loadBalancingScheme set to + # INTERNAL_SELF_MANAGED. + # Corresponds to the JSON property `authentication` + # @return [String] + attr_accessor :authentication + + # A URL referring to a networksecurity.Authorization resource that describes how + # the proxy should authorize inbound traffic. If left blank, access will not be + # restricted by an authorization policy. + # Refer to the Authorization resource for additional details. + # authorization only applies to a global TargetHttpsProxy attached to + # globalForwardingRules with the loadBalancingScheme set to + # INTERNAL_SELF_MANAGED. + # Corresponds to the JSON property `authorization` + # @return [String] + attr_accessor :authorization + + # URL of a certificate map that identifies a certificate map associated with the + # given target proxy. This field can only be set for global target proxies. If + # set, sslCertificates will be ignored. + # Corresponds to the JSON property `certificateMap` + # @return [String] + attr_accessor :certificate_map + # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] @@ -34021,6 +34972,9 @@ module Google # Update properties of this object def update!(**args) + @authentication = args[:authentication] if args.key?(:authentication) + @authorization = args[:authorization] if args.key?(:authorization) + @certificate_map = args[:certificate_map] if args.key?(:certificate_map) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @@ -34071,6 +35025,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::TargetHttpsProxyAggregatedList::Warning] @@ -34087,6 +35046,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -34409,6 +35369,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::TargetInstanceAggregatedList::Warning] @@ -34425,6 +35390,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -34867,6 +35833,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::TargetPoolAggregatedList::Warning] @@ -34883,6 +35854,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -35358,6 +36330,13 @@ module Google class TargetSslProxy include Google::Apis::Core::Hashable + # URL of a certificate map that identifies a certificate map associated with the + # given target proxy. This field can only be set for global target proxies. If + # set, sslCertificates will be ignored. + # Corresponds to the JSON property `certificateMap` + # @return [String] + attr_accessor :certificate_map + # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] @@ -35427,6 +36406,7 @@ module Google # Update properties of this object def update!(**args) + @certificate_map = args[:certificate_map] if args.key?(:certificate_map) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @@ -35600,7 +36580,7 @@ module Google # A target TCP proxy is a component of a TCP Proxy load balancer. Global # forwarding rules reference target TCP proxy, and the target proxy then # references an external backend service. For more information, read TCP Proxy - # Load Balancing Concepts. (== resource_for `$api_version`.targetTcpProxies ==) + # Load Balancing overview. (== resource_for `$api_version`.targetTcpProxies ==) class TargetTcpProxy include Google::Apis::Core::Hashable @@ -35940,6 +36920,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::TargetVpnGatewayAggregatedList::Warning] @@ -35956,6 +36941,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -36309,11 +37295,13 @@ module Google end end + # [Deprecated] Defines the mechanism to obtain the client or server certificate. # Defines the mechanism to obtain the client or server certificate. class TlsCertificateContext include Google::Apis::Core::Hashable - # The paths to the mounted TLS Certificates and private key. + # [Deprecated] The paths to the mounted TLS Certificates and private key. The + # paths to the mounted TLS Certificates and private key. # Corresponds to the JSON property `certificatePaths` # @return [Google::Apis::ComputeAlpha::TlsCertificatePaths] attr_accessor :certificate_paths @@ -36323,7 +37311,8 @@ module Google # @return [String] attr_accessor :certificate_source - # The configuration to access the SDS server. + # [Deprecated] The configuration to access the SDS server. The configuration to + # access the SDS server. # Corresponds to the JSON property `sdsConfig` # @return [Google::Apis::ComputeAlpha::SdsConfig] attr_accessor :sds_config @@ -36340,7 +37329,8 @@ module Google end end - # The paths to the mounted TLS Certificates and private key. + # [Deprecated] The paths to the mounted TLS Certificates and private key. The + # paths to the mounted TLS Certificates and private key. class TlsCertificatePaths include Google::Apis::Core::Hashable @@ -36365,17 +37355,20 @@ module Google end end - # The TLS settings for the client or server. + # [Deprecated] The TLS settings for the client or server. The TLS settings for + # the client or server. class TlsContext include Google::Apis::Core::Hashable + # [Deprecated] Defines the mechanism to obtain the client or server certificate. # Defines the mechanism to obtain the client or server certificate. # Corresponds to the JSON property `certificateContext` # @return [Google::Apis::ComputeAlpha::TlsCertificateContext] attr_accessor :certificate_context - # Defines the mechanism to obtain the Certificate Authority certificate to - # validate the client/server certificate. + # [Deprecated] Defines the mechanism to obtain the Certificate Authority + # certificate to validate the client/server certificate. validate the client/ + # server certificate. # Corresponds to the JSON property `validationContext` # @return [Google::Apis::ComputeAlpha::TlsValidationContext] attr_accessor :validation_context @@ -36391,8 +37384,9 @@ module Google end end - # Defines the mechanism to obtain the Certificate Authority certificate to - # validate the client/server certificate. + # [Deprecated] Defines the mechanism to obtain the Certificate Authority + # certificate to validate the client/server certificate. validate the client/ + # server certificate. class TlsValidationContext include Google::Apis::Core::Hashable @@ -36402,7 +37396,8 @@ module Google # @return [String] attr_accessor :certificate_path - # The configuration to access the SDS server. + # [Deprecated] The configuration to access the SDS server. The configuration to + # access the SDS server. # Corresponds to the JSON property `sdsConfig` # @return [Google::Apis::ComputeAlpha::SdsConfig] attr_accessor :sds_config @@ -36500,8 +37495,8 @@ module Google # Represents a URL Map resource. # Google Compute Engine has two URL Map resources: - # * [Global](/compute/docs/reference/rest/latest/urlMaps) * [Regional](/compute/ - # docs/reference/rest/latest/regionUrlMaps) + # * [Global](/compute/docs/reference/rest/`$api_version`/urlMaps) * [Regional](/ + # compute/docs/reference/rest/`$api_version`/regionUrlMaps) # A URL map resource is a component of certain types of GCP load balancers and # Traffic Director. # * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * @@ -36907,6 +37902,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::UrlMapsAggregatedList::Warning] @@ -36923,6 +37923,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -37088,8 +38089,8 @@ module Google # Represents a URL Map resource. # Google Compute Engine has two URL Map resources: - # * [Global](/compute/docs/reference/rest/latest/urlMaps) * [Regional](/compute/ - # docs/reference/rest/latest/regionUrlMaps) + # * [Global](/compute/docs/reference/rest/`$api_version`/urlMaps) * [Regional](/ + # compute/docs/reference/rest/`$api_version`/regionUrlMaps) # A URL map resource is a component of certain types of GCP load balancers and # Traffic Director. # * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * @@ -37709,6 +38710,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::VpnGatewayAggregatedList::Warning] @@ -37725,6 +38731,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end @@ -38418,6 +39425,11 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Unreachable resources. + # Corresponds to the JSON property `unreachables` + # @return [Array] + attr_accessor :unreachables + # [Output Only] Informational warning message. # Corresponds to the JSON property `warning` # @return [Google::Apis::ComputeAlpha::VpnTunnelAggregatedList::Warning] @@ -38434,6 +39446,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @self_link = args[:self_link] if args.key?(:self_link) + @unreachables = args[:unreachables] if args.key?(:unreachables) @warning = args[:warning] if args.key?(:warning) end diff --git a/generated/google/apis/compute_alpha/representations.rb b/generated/google/apis/compute_alpha/representations.rb index 82279c1c8..08b88810c 100644 --- a/generated/google/apis/compute_alpha/representations.rb +++ b/generated/google/apis/compute_alpha/representations.rb @@ -328,6 +328,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class AutoscalingPolicyScaleInControl + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Backend class Representation < Google::Apis::Core::JsonRepresentation; end @@ -490,6 +496,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class BulkInsertInstanceResource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CacheInvalidationRule class Representation < Google::Apis::Core::JsonRepresentation; end @@ -994,6 +1006,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GrpcHealthCheck + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GlobalNetworkEndpointGroupsAttachEndpointsRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1018,12 +1036,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class GoogleDuration - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GrpcServiceConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1210,6 +1222,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class HttpFilterConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class HttpHeaderAction class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1342,6 +1360,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class InPlaceSnapshot + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InPlaceSnapshotList + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Warning + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Datum + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + class InitialStateConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -2620,6 +2662,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class NodeGroupMaintenanceWindow + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class NodeGroupNode class Representation < Google::Apis::Core::JsonRepresentation; end @@ -4420,6 +4468,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class TargetGrpcProxy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TargetGrpcProxyList + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Warning + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Datum + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + class TargetHttpProxiesScopedList class Representation < Google::Apis::Core::JsonRepresentation; end @@ -5330,6 +5402,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::AcceleratorTypeAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::AcceleratorTypeAggregatedList::Warning::Representation end @@ -5463,6 +5536,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::AddressAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::AddressAggregatedList::Warning::Representation end @@ -5569,6 +5643,7 @@ module Google collection :local_ssds, as: 'localSsds', class: Google::Apis::ComputeAlpha::AllocationSpecificSkuAllocationAllocatedInstancePropertiesReservedDisk, decorator: Google::Apis::ComputeAlpha::AllocationSpecificSkuAllocationAllocatedInstancePropertiesReservedDisk::Representation + property :long_term_release, as: 'longTermRelease' property :machine_type, as: 'machineType' property :min_cpu_platform, as: 'minCpuPlatform' end @@ -5710,6 +5785,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::AutoscalerAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::AutoscalerAggregatedList::Warning::Representation end @@ -5818,6 +5894,8 @@ module Google property :scale_down_control, as: 'scaleDownControl', class: Google::Apis::ComputeAlpha::AutoscalingPolicyScaleDownControl, decorator: Google::Apis::ComputeAlpha::AutoscalingPolicyScaleDownControl::Representation + property :scale_in_control, as: 'scaleInControl', class: Google::Apis::ComputeAlpha::AutoscalingPolicyScaleInControl, decorator: Google::Apis::ComputeAlpha::AutoscalingPolicyScaleInControl::Representation + end end @@ -5870,7 +5948,14 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :max_scaled_down_replicas, as: 'maxScaledDownReplicas', class: Google::Apis::ComputeAlpha::FixedOrPercent, decorator: Google::Apis::ComputeAlpha::FixedOrPercent::Representation - property :time_window, as: 'timeWindow', class: Google::Apis::ComputeAlpha::GoogleDuration, decorator: Google::Apis::ComputeAlpha::GoogleDuration::Representation + property :time_window_sec, as: 'timeWindowSec' + end + end + + class AutoscalingPolicyScaleInControl + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :max_scaled_in_replicas, as: 'maxScaledInReplicas', class: Google::Apis::ComputeAlpha::FixedOrPercent, decorator: Google::Apis::ComputeAlpha::FixedOrPercent::Representation property :time_window_sec, as: 'timeWindowSec' end @@ -6008,6 +6093,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::BackendServiceAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::BackendServiceAggregatedList::Warning::Representation end @@ -6224,6 +6310,19 @@ module Google end end + class BulkInsertInstanceResource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :count, :numeric_string => true, as: 'count' + collection :excluded_zones, as: 'excludedZones' + property :instance, as: 'instance', class: Google::Apis::ComputeAlpha::Instance, decorator: Google::Apis::ComputeAlpha::Instance::Representation + + property :min_count, :numeric_string => true, as: 'minCount' + collection :predefined_names, as: 'predefinedNames' + property :source_instance_template, as: 'sourceInstanceTemplate' + end + end + class CacheInvalidationRule # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -6321,6 +6420,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::CommitmentAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::CommitmentAggregatedList::Warning::Representation end @@ -6528,6 +6628,8 @@ module Google property :source_image_encryption_key, as: 'sourceImageEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation property :source_image_id, as: 'sourceImageId' + property :source_in_place_snapshot, as: 'sourceInPlaceSnapshot' + property :source_in_place_snapshot_id, as: 'sourceInPlaceSnapshotId' property :source_snapshot, as: 'sourceSnapshot' property :source_snapshot_encryption_key, as: 'sourceSnapshotEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation @@ -6550,6 +6652,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::DiskAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::DiskAggregatedList::Warning::Representation end @@ -6651,6 +6754,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::DiskTypeAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::DiskTypeAggregatedList::Warning::Representation end @@ -7072,6 +7176,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::ForwardingRuleAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::ForwardingRuleAggregatedList::Warning::Representation end @@ -7162,6 +7267,16 @@ module Google end end + class GrpcHealthCheck + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :grpc_service_name, as: 'grpcServiceName' + property :port, as: 'port' + property :port_name, as: 'portName' + property :port_specification, as: 'portSpecification' + end + end + class GlobalNetworkEndpointGroupsAttachEndpointsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -7197,14 +7312,6 @@ module Google end end - class GoogleDuration - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :nanos, as: 'nanos' - property :seconds, :numeric_string => true, as: 'seconds' - end - end - class GrpcServiceConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -7298,6 +7405,8 @@ module Google property :check_interval_sec, as: 'checkIntervalSec' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' + property :grpc_health_check, as: 'grpcHealthCheck', class: Google::Apis::ComputeAlpha::GrpcHealthCheck, decorator: Google::Apis::ComputeAlpha::GrpcHealthCheck::Representation + property :healthy_threshold, as: 'healthyThreshold' property :http2_health_check, as: 'http2HealthCheck', class: Google::Apis::ComputeAlpha::Http2HealthCheck, decorator: Google::Apis::ComputeAlpha::Http2HealthCheck::Representation @@ -7439,6 +7548,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::HealthChecksAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::HealthChecksAggregatedList::Warning::Representation end @@ -7552,6 +7662,15 @@ module Google end end + class HttpFilterConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :config, as: 'config' + property :config_type_url, as: 'configTypeUrl' + property :filter_name, as: 'filterName' + end + end + class HttpHeaderAction # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -7698,6 +7817,10 @@ module Google property :description, as: 'description' property :header_action, as: 'headerAction', class: Google::Apis::ComputeAlpha::HttpHeaderAction, decorator: Google::Apis::ComputeAlpha::HttpHeaderAction::Representation + collection :http_filter_configs, as: 'httpFilterConfigs', class: Google::Apis::ComputeAlpha::HttpFilterConfig, decorator: Google::Apis::ComputeAlpha::HttpFilterConfig::Representation + + collection :http_filter_metadata, as: 'httpFilterMetadata', class: Google::Apis::ComputeAlpha::HttpFilterConfig, decorator: Google::Apis::ComputeAlpha::HttpFilterConfig::Representation + collection :match_rules, as: 'matchRules', class: Google::Apis::ComputeAlpha::HttpRouteRuleMatch, decorator: Google::Apis::ComputeAlpha::HttpRouteRuleMatch::Representation property :priority, as: 'priority' @@ -7863,6 +7986,60 @@ module Google end end + class InPlaceSnapshot + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :creation_timestamp, as: 'creationTimestamp' + property :description, as: 'description' + property :disk_size_gb, :numeric_string => true, as: 'diskSizeGb' + property :guest_flush, as: 'guestFlush' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :label_fingerprint, :base64 => true, as: 'labelFingerprint' + hash :labels, as: 'labels' + property :name, as: 'name' + property :region, as: 'region' + property :self_link, as: 'selfLink' + property :self_link_with_id, as: 'selfLinkWithId' + property :source_disk, as: 'sourceDisk' + property :source_disk_id, as: 'sourceDiskId' + property :status, as: 'status' + property :zone, as: 'zone' + end + end + + class InPlaceSnapshotList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + collection :items, as: 'items', class: Google::Apis::ComputeAlpha::InPlaceSnapshot, decorator: Google::Apis::ComputeAlpha::InPlaceSnapshot::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + property :self_link, as: 'selfLink' + property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InPlaceSnapshotList::Warning, decorator: Google::Apis::ComputeAlpha::InPlaceSnapshotList::Warning::Representation + + end + + class Warning + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :data, as: 'data', class: Google::Apis::ComputeAlpha::InPlaceSnapshotList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::InPlaceSnapshotList::Warning::Datum::Representation + + property :message, as: 'message' + end + + class Datum + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + end + end + class InitialStateConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -7952,6 +8129,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InstanceAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::InstanceAggregatedList::Warning::Representation end @@ -8005,6 +8183,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InstanceGroupAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::InstanceGroupAggregatedList::Warning::Representation end @@ -8125,6 +8304,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InstanceGroupManagerAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagerAggregatedList::Warning::Representation end @@ -8215,6 +8395,7 @@ module Google class InstanceGroupManagerStatusStateful # @private class Representation < Google::Apis::Core::JsonRepresentation + property :has_stateful_config, as: 'hasStatefulConfig' property :is_stateful, as: 'isStateful' end end @@ -8931,6 +9112,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::InterconnectAttachmentAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::InterconnectAttachmentAggregatedList::Warning::Representation end @@ -9544,6 +9726,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::MachineTypeAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::MachineTypeAggregatedList::Warning::Representation end @@ -9760,7 +9943,6 @@ module Google property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :mtu, as: 'mtu' - property :multicast_mode, as: 'multicastMode' property :name, as: 'name' collection :peerings, as: 'peerings', class: Google::Apis::ComputeAlpha::NetworkPeering, decorator: Google::Apis::ComputeAlpha::NetworkPeering::Representation @@ -9822,6 +10004,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::NetworkEndpointGroupAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::NetworkEndpointGroupAggregatedList::Warning::Representation end @@ -10147,6 +10330,8 @@ module Google property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :maintenance_policy, as: 'maintenancePolicy' + property :maintenance_window, as: 'maintenanceWindow', class: Google::Apis::ComputeAlpha::NodeGroupMaintenanceWindow, decorator: Google::Apis::ComputeAlpha::NodeGroupMaintenanceWindow::Representation + property :name, as: 'name' property :node_template, as: 'nodeTemplate' property :self_link, as: 'selfLink' @@ -10166,6 +10351,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::NodeGroupAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::NodeGroupAggregatedList::Warning::Representation end @@ -10230,11 +10416,20 @@ module Google end end + class NodeGroupMaintenanceWindow + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :duration, as: 'duration' + property :start_time, as: 'startTime' + end + end + class NodeGroupNode # @private class Representation < Google::Apis::Core::JsonRepresentation collection :accelerators, as: 'accelerators', class: Google::Apis::ComputeAlpha::AcceleratorConfig, decorator: Google::Apis::ComputeAlpha::AcceleratorConfig::Representation + property :cpu_overcommit_type, as: 'cpuOvercommitType' collection :disks, as: 'disks', class: Google::Apis::ComputeAlpha::LocalDisk, decorator: Google::Apis::ComputeAlpha::LocalDisk::Representation collection :instances, as: 'instances' @@ -10333,6 +10528,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :accelerators, as: 'accelerators', class: Google::Apis::ComputeAlpha::AcceleratorConfig, decorator: Google::Apis::ComputeAlpha::AcceleratorConfig::Representation + property :cpu_overcommit_type, as: 'cpuOvercommitType' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' collection :disks, as: 'disks', class: Google::Apis::ComputeAlpha::LocalDisk, decorator: Google::Apis::ComputeAlpha::LocalDisk::Representation @@ -10363,6 +10559,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::NodeTemplateAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::NodeTemplateAggregatedList::Warning::Representation end @@ -10484,6 +10681,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::NodeTypeAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::NodeTypeAggregatedList::Warning::Representation end @@ -10702,6 +10900,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::OperationAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::OperationAggregatedList::Warning::Representation end @@ -10866,6 +11065,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::PacketMirroringAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::PacketMirroringAggregatedList::Warning::Representation end @@ -11289,6 +11489,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::PublicDelegatedPrefixAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::PublicDelegatedPrefixAggregatedList::Warning::Representation end @@ -11883,6 +12084,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::ReservationAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::ReservationAggregatedList::Warning::Representation end @@ -12048,6 +12250,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::ResourcePolicyAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::ResourcePolicyAggregatedList::Warning::Representation end @@ -12334,6 +12537,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::RouterAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::RouterAggregatedList::Warning::Representation end @@ -12632,6 +12836,7 @@ module Google property :automatic_restart, as: 'automaticRestart' property :latency_tolerant, as: 'latencyTolerant' property :location_hint, as: 'locationHint' + property :long_term_release, as: 'longTermRelease' property :min_node_cpus, as: 'minNodeCpus' collection :node_affinities, as: 'nodeAffinities', class: Google::Apis::ComputeAlpha::SchedulingNodeAffinity, decorator: Google::Apis::ComputeAlpha::SchedulingNodeAffinity::Representation @@ -12835,12 +13040,14 @@ module Google class SecuritySettings # @private class Representation < Google::Apis::Core::JsonRepresentation + property :authentication, as: 'authentication' property :authentication_policy, as: 'authenticationPolicy', class: Google::Apis::ComputeAlpha::AuthenticationPolicy, decorator: Google::Apis::ComputeAlpha::AuthenticationPolicy::Representation property :authorization_config, as: 'authorizationConfig', class: Google::Apis::ComputeAlpha::AuthorizationConfig, decorator: Google::Apis::ComputeAlpha::AuthorizationConfig::Representation property :client_tls_settings, as: 'clientTlsSettings', class: Google::Apis::ComputeAlpha::ClientTlsSettings, decorator: Google::Apis::ComputeAlpha::ClientTlsSettings::Representation + collection :subject_alt_names, as: 'subjectAltNames' end end @@ -13097,6 +13304,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::SslCertificateAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::SslCertificateAggregatedList::Warning::Representation end @@ -13331,7 +13539,6 @@ module Google property :private_ipv6_google_access, as: 'privateIpv6GoogleAccess' collection :private_ipv6_google_access_service_accounts, as: 'privateIpv6GoogleAccessServiceAccounts' property :purpose, as: 'purpose' - property :range_type, as: 'rangeType' property :region, as: 'region' property :role, as: 'role' collection :secondary_ip_ranges, as: 'secondaryIpRanges', class: Google::Apis::ComputeAlpha::SubnetworkSecondaryRange, decorator: Google::Apis::ComputeAlpha::SubnetworkSecondaryRange::Representation @@ -13351,6 +13558,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::SubnetworkAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::SubnetworkAggregatedList::Warning::Representation end @@ -13423,7 +13631,6 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :ip_cidr_range, as: 'ipCidrRange' property :range_name, as: 'rangeName' - property :range_type, as: 'rangeType' end end @@ -13431,7 +13638,6 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :ip_cidr_range, as: 'ipCidrRange' - property :range_type, as: 'rangeType' end end @@ -13490,6 +13696,53 @@ module Google end end + class TargetGrpcProxy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :creation_timestamp, as: 'creationTimestamp' + property :description, as: 'description' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :self_link, as: 'selfLink' + property :self_link_with_id, as: 'selfLinkWithId' + property :url_map, as: 'urlMap' + property :validate_for_proxyless, as: 'validateForProxyless' + end + end + + class TargetGrpcProxyList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + collection :items, as: 'items', class: Google::Apis::ComputeAlpha::TargetGrpcProxy, decorator: Google::Apis::ComputeAlpha::TargetGrpcProxy::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + property :self_link, as: 'selfLink' + property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetGrpcProxyList::Warning, decorator: Google::Apis::ComputeAlpha::TargetGrpcProxyList::Warning::Representation + + end + + class Warning + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :data, as: 'data', class: Google::Apis::ComputeAlpha::TargetGrpcProxyList::Warning::Datum, decorator: Google::Apis::ComputeAlpha::TargetGrpcProxyList::Warning::Datum::Representation + + property :message, as: 'message' + end + + class Datum + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + end + end + class TargetHttpProxiesScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -13523,6 +13776,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' + collection :http_filters, as: 'httpFilters' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' @@ -13543,6 +13797,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetHttpProxyAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::TargetHttpProxyAggregatedList::Warning::Representation end @@ -13643,6 +13898,9 @@ module Google class TargetHttpsProxy # @private class Representation < Google::Apis::Core::JsonRepresentation + property :authentication, as: 'authentication' + property :authorization, as: 'authorization' + property :certificate_map, as: 'certificateMap' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' @@ -13668,6 +13926,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetHttpsProxyAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::TargetHttpsProxyAggregatedList::Warning::Representation end @@ -13749,6 +14008,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetInstanceAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::TargetInstanceAggregatedList::Warning::Representation end @@ -13860,6 +14120,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetPoolAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::TargetPoolAggregatedList::Warning::Representation end @@ -14015,6 +14276,7 @@ module Google class TargetSslProxy # @private class Representation < Google::Apis::Core::JsonRepresentation + property :certificate_map, as: 'certificateMap' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' @@ -14148,6 +14410,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::TargetVpnGatewayAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::TargetVpnGatewayAggregatedList::Warning::Representation end @@ -14411,6 +14674,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::UrlMapsAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::UrlMapsAggregatedList::Warning::Representation end @@ -14625,6 +14889,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::VpnGatewayAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::VpnGatewayAggregatedList::Warning::Representation end @@ -14800,6 +15065,7 @@ module Google property :kind, as: 'kind' property :next_page_token, as: 'nextPageToken' property :self_link, as: 'selfLink' + collection :unreachables, as: 'unreachables' property :warning, as: 'warning', class: Google::Apis::ComputeAlpha::VpnTunnelAggregatedList::Warning, decorator: Google::Apis::ComputeAlpha::VpnTunnelAggregatedList::Warning::Representation end diff --git a/generated/google/apis/compute_alpha/service.rb b/generated/google/apis/compute_alpha/service.rb index f0ff3641c..ad41ab57d 100644 --- a/generated/google/apis/compute_alpha/service.rb +++ b/generated/google/apis/compute_alpha/service.rb @@ -58,19 +58,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -80,21 +80,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -114,7 +117,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_accelerator_type_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_accelerator_type_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/acceleratorTypes', options) command.response_representation = Google::Apis::ComputeAlpha::AcceleratorTypeAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::AcceleratorTypeAggregatedList @@ -124,6 +127,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -178,36 +182,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -227,7 +234,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_accelerator_types(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_accelerator_types(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/acceleratorTypes', options) command.response_representation = Google::Apis::ComputeAlpha::AcceleratorTypeList::Representation command.response_class = Google::Apis::ComputeAlpha::AcceleratorTypeList @@ -237,6 +244,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -250,19 +258,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -272,21 +280,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -306,7 +317,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_address_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_address_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/addresses', options) command.response_representation = Google::Apis::ComputeAlpha::AddressAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::AddressAggregatedList @@ -316,6 +327,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -473,36 +485,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -522,7 +537,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_addresses(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_addresses(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/addresses', options) command.response_representation = Google::Apis::ComputeAlpha::AddressList::Representation command.response_class = Google::Apis::ComputeAlpha::AddressList @@ -532,6 +547,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -642,19 +658,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -664,21 +680,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -698,7 +717,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_autoscaler_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_autoscaler_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/autoscalers', options) command.response_representation = Google::Apis::ComputeAlpha::AutoscalerAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::AutoscalerAggregatedList @@ -708,6 +727,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -866,36 +886,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -915,7 +938,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_autoscalers(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_autoscalers(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/autoscalers', options) command.response_representation = Google::Apis::ComputeAlpha::AutoscalerList::Representation command.response_class = Google::Apis::ComputeAlpha::AutoscalerList @@ -925,6 +948,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -1370,36 +1394,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1419,7 +1446,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_backend_buckets(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_backend_buckets(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/backendBuckets', options) command.response_representation = Google::Apis::ComputeAlpha::BackendBucketList::Representation command.response_class = Google::Apis::ComputeAlpha::BackendBucketList @@ -1428,6 +1455,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -1678,19 +1706,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -1700,21 +1728,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1734,7 +1765,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_backend_service_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_backend_service_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/backendServices', options) command.response_representation = Google::Apis::ComputeAlpha::BackendServiceAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::BackendServiceAggregatedList @@ -1744,6 +1775,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -1928,8 +1960,8 @@ module Google # Creates a BackendService resource in the specified project using the data # included in the request. There are several restrictions and guidelines to keep - # in mind when creating a backend service. Read Restrictions and Guidelines for - # more information. + # in mind when creating a backend service. Read Understanding backend services + # for more information. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::BackendService] backend_service_object @@ -1985,36 +2017,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2034,7 +2069,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_backend_services(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_backend_services(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/backendServices', options) command.response_representation = Google::Apis::ComputeAlpha::BackendServiceList::Representation command.response_class = Google::Apis::ComputeAlpha::BackendServiceList @@ -2043,6 +2078,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -2050,8 +2086,8 @@ module Google end # Patches the specified BackendService resource with the data included in the - # request. There are several restrictions and guidelines to keep in mind when - # updating a backend service. Read Restrictions and Guidelines for more + # request. There are several Understanding backend services to keep in mind when + # updating a backend service. Read Understanding backend services for more # information. This method supports PATCH semantics and uses the JSON merge # patch format and processing rules. # @param [String] project @@ -2196,8 +2232,8 @@ module Google end # Updates the specified BackendService resource with the data included in the - # request. There are several restrictions and guidelines to keep in mind when - # updating a backend service. Read Restrictions and Guidelines for more + # request. There are several Understanding backend services to keep in mind when + # updating a backend service. Read Understanding backend services for more # information. # @param [String] project # Project ID for this request. @@ -2256,19 +2292,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -2278,21 +2314,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2312,7 +2351,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_disk_type_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_disk_type_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/diskTypes', options) command.response_representation = Google::Apis::ComputeAlpha::DiskTypeAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::DiskTypeAggregatedList @@ -2322,6 +2361,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -2377,36 +2417,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2426,7 +2469,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_disk_types(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_disk_types(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/diskTypes', options) command.response_representation = Google::Apis::ComputeAlpha::DiskTypeList::Representation command.response_class = Google::Apis::ComputeAlpha::DiskTypeList @@ -2436,6 +2479,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -2504,19 +2548,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -2526,21 +2570,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2560,7 +2607,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_disk_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_disk_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/disks', options) command.response_representation = Google::Apis::ComputeAlpha::DiskAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::DiskAggregatedList @@ -2570,6 +2617,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -2837,36 +2885,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2886,7 +2937,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_disks(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_disks(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/disks', options) command.response_representation = Google::Apis::ComputeAlpha::DiskList::Representation command.response_class = Google::Apis::ComputeAlpha::DiskList @@ -2896,6 +2947,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -3292,36 +3344,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3341,7 +3396,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_external_vpn_gateways(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_external_vpn_gateways(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/externalVpnGateways', options) command.response_representation = Google::Apis::ComputeAlpha::ExternalVpnGatewayList::Representation command.response_class = Google::Apis::ComputeAlpha::ExternalVpnGatewayList @@ -3350,6 +3405,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -3575,36 +3631,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3624,7 +3683,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_firewalls(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_firewalls(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/firewalls', options) command.response_representation = Google::Apis::ComputeAlpha::FirewallList::Representation command.response_class = Google::Apis::ComputeAlpha::FirewallList @@ -3633,6 +3692,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -3791,19 +3851,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -3813,21 +3873,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3847,7 +3910,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_forwarding_rule_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_forwarding_rule_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/forwardingRules', options) command.response_representation = Google::Apis::ComputeAlpha::ForwardingRuleAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::ForwardingRuleAggregatedList @@ -3857,6 +3920,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -4015,36 +4079,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4064,7 +4131,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_forwarding_rules(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_forwarding_rules(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/forwardingRules', options) command.response_representation = Google::Apis::ComputeAlpha::ForwardingRuleList::Representation command.response_class = Google::Apis::ComputeAlpha::ForwardingRuleList @@ -4074,6 +4141,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -4429,36 +4497,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4478,7 +4549,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_global_addresses(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_global_addresses(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/addresses', options) command.response_representation = Google::Apis::ComputeAlpha::AddressList::Representation command.response_class = Google::Apis::ComputeAlpha::AddressList @@ -4487,6 +4558,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -4714,36 +4786,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4763,7 +4838,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_global_forwarding_rules(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_global_forwarding_rules(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/forwardingRules', options) command.response_representation = Google::Apis::ComputeAlpha::ForwardingRuleList::Representation command.response_class = Google::Apis::ComputeAlpha::ForwardingRuleList @@ -4772,6 +4847,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -5210,36 +5286,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5259,7 +5338,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_global_network_endpoint_groups(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_global_network_endpoint_groups(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/networkEndpointGroups', options) command.response_representation = Google::Apis::ComputeAlpha::NetworkEndpointGroupList::Representation command.response_class = Google::Apis::ComputeAlpha::NetworkEndpointGroupList @@ -5268,6 +5347,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -5284,36 +5364,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5333,7 +5416,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_global_network_endpoint_group_network_endpoints(project, network_endpoint_group, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_global_network_endpoint_group_network_endpoints(project, network_endpoint_group, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints', options) command.response_representation = Google::Apis::ComputeAlpha::NetworkEndpointGroupsListNetworkEndpoints::Representation command.response_class = Google::Apis::ComputeAlpha::NetworkEndpointGroupsListNetworkEndpoints @@ -5343,6 +5426,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -5356,19 +5440,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -5378,21 +5462,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5412,7 +5499,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_global_operation_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_global_operation_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/operations', options) command.response_representation = Google::Apis::ComputeAlpha::OperationAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::OperationAggregatedList @@ -5422,6 +5509,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -5463,7 +5551,7 @@ module Google end # Retrieves the specified Operations resource. Gets a list of operations by - # making a list() request. + # making a `list()` request. # @param [String] project # Project ID for this request. # @param [String] operation @@ -5506,36 +5594,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5555,7 +5646,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_global_operations(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_global_operations(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/operations', options) command.response_representation = Google::Apis::ComputeAlpha::OperationList::Representation command.response_class = Google::Apis::ComputeAlpha::OperationList @@ -5564,23 +5655,24 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Waits for the specified Operation resource to return as DONE or for the + # Waits for the specified Operation resource to return as `DONE` or for the # request to approach the 2 minute deadline, and retrieves the specified - # Operation resource. This method differs from the GET method in that it waits + # Operation resource. This method differs from the `GET` method in that it waits # for no more than the default deadline (2 minutes) and then returns the current - # state of the operation, which might be DONE or still in progress. + # state of the operation, which might be `DONE` or still in progress. # This method is called on a best-effort basis. Specifically: # - In uncommon cases, when the server is overloaded, the request might return # before the default deadline is reached, or might return after zero seconds. # - If the default deadline is reached, there is no guarantee that the operation # is actually done when the method returns. Be prepared to retry if the - # operation is not DONE. + # operation is not `DONE`. # @param [String] project # Project ID for this request. # @param [String] operation @@ -5651,7 +5743,7 @@ module Google end # Retrieves the specified Operations resource. Gets a list of operations by - # making a list() request. + # making a `list()` request. # @param [String] operation # Name of the Operations resource to return. # @param [String] parent_id @@ -5693,38 +5785,41 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] parent_id # Parent ID for this request. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5744,7 +5839,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_global_organization_operations(filter: nil, max_results: nil, order_by: nil, page_token: nil, parent_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_global_organization_operations(filter: nil, max_results: nil, order_by: nil, page_token: nil, parent_id: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'locations/global/operations', options) command.response_representation = Google::Apis::ComputeAlpha::OperationList::Representation command.response_class = Google::Apis::ComputeAlpha::OperationList @@ -5753,52 +5848,7 @@ module Google command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['parentId'] = parent_id unless parent_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Waits for the specified Operation resource to return as DONE or for the - # request to approach the 2 minute deadline, and retrieves the specified - # Operation resource. This method differs from the GET method in that it waits - # for no more than the default deadline (2 minutes) and then returns the current - # state of the operation, which might be DONE or still in progress. - # This method is called on a best-effort basis. Specifically: - # - In uncommon cases, when the server is overloaded, the request might return - # before the default deadline is reached, or might return after zero seconds. - # - If the default deadline is reached, there is no guarantee that the operation - # is actually done when the method returns. Be prepared to retry if the - # operation is not DONE. - # @param [String] operation - # Name of the Operations resource to return. - # @param [String] parent_id - # Parent ID for this request. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ComputeAlpha::Operation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ComputeAlpha::Operation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def wait_global_organization_operation(operation, parent_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'locations/global/operations/{operation}/wait', options) - command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation - command.response_class = Google::Apis::ComputeAlpha::Operation - command.params['operation'] = operation unless operation.nil? - command.query['parentId'] = parent_id unless parent_id.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -5945,36 +5995,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5994,7 +6047,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_global_public_delegated_prefixes(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_global_public_delegated_prefixes(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/publicDelegatedPrefixes', options) command.response_representation = Google::Apis::ComputeAlpha::PublicDelegatedPrefixList::Representation command.response_class = Google::Apis::ComputeAlpha::PublicDelegatedPrefixList @@ -6003,6 +6056,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -6070,19 +6124,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -6092,21 +6146,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6126,7 +6183,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_health_check_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_health_check_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/healthChecks', options) command.response_representation = Google::Apis::ComputeAlpha::HealthChecksAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::HealthChecksAggregatedList @@ -6136,6 +6193,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -6283,36 +6341,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6332,7 +6393,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_health_checks(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_health_checks(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/healthChecks', options) command.response_representation = Google::Apis::ComputeAlpha::HealthCheckList::Representation command.response_class = Google::Apis::ComputeAlpha::HealthCheckList @@ -6341,6 +6402,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -6633,36 +6695,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6682,7 +6747,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_http_health_checks(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_http_health_checks(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/httpHealthChecks', options) command.response_representation = Google::Apis::ComputeAlpha::HttpHealthCheckList::Representation command.response_class = Google::Apis::ComputeAlpha::HttpHealthCheckList @@ -6691,6 +6756,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -6983,36 +7049,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7032,7 +7101,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_https_health_checks(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_https_health_checks(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/httpsHealthChecks', options) command.response_representation = Google::Apis::ComputeAlpha::HttpsHealthCheckList::Representation command.response_class = Google::Apis::ComputeAlpha::HttpsHealthCheckList @@ -7041,6 +7110,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -7468,36 +7538,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7517,7 +7590,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_images(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_images(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/images', options) command.response_representation = Google::Apis::ComputeAlpha::ImageList::Representation command.response_class = Google::Apis::ComputeAlpha::ImageList @@ -7526,6 +7599,59 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Patches the specified image with the data included in the request. Only the + # following fields can be modified: family, description, deprecation status. + # @param [String] project + # Project ID for this request. + # @param [String] image + # Name of the image resource to patch. + # @param [Google::Apis::ComputeAlpha::Image] image_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_image(project, image, image_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, '{project}/global/images/{image}', options) + command.request_representation = Google::Apis::ComputeAlpha::Image::Representation + command.request_object = image_object + command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation + command.response_class = Google::Apis::ComputeAlpha::Operation + command.params['project'] = project unless project.nil? + command.params['image'] = image unless image.nil? + command.query['requestId'] = request_id unless request_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -7723,19 +7849,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -7745,21 +7871,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7779,7 +7908,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_instance_group_manager_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_instance_group_manager_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/instanceGroupManagers', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceGroupManagerAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceGroupManagerAggregatedList @@ -7789,14 +7918,15 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Apply changes to selected instances on the managed instance group. This method - # can be used to apply new overrides and/or new versions. + # Applies changes to selected instances on the managed instance group. This + # method can be used to apply new overrides and/or new versions. # @param [String] project # Project ID for this request. # @param [String] zone @@ -8166,36 +8296,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -8215,7 +8348,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_instance_group_managers(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_instance_group_managers(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/instanceGroupManagers', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceGroupManagerList::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceGroupManagerList @@ -8225,6 +8358,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -8246,36 +8380,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -8295,7 +8432,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_instance_group_manager_errors(project, zone, instance_group_manager, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_instance_group_manager_errors(project, zone, instance_group_manager, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceGroupManagersListErrorsResponse::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceGroupManagersListErrorsResponse @@ -8306,6 +8443,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -8327,36 +8465,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -8385,7 +8523,7 @@ module Google command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.nil? - command.query['order_by'] = order_by unless order_by.nil? + command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? @@ -8405,36 +8543,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -8454,7 +8595,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_instance_group_manager_per_instance_configs(project, zone, instance_group_manager, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_instance_group_manager_per_instance_configs(project, zone, instance_group_manager, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceGroupManagersListPerInstanceConfigsResp::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceGroupManagersListPerInstanceConfigsResp @@ -8465,6 +8606,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -8530,9 +8672,9 @@ module Google execute_or_queue_command(command, &block) end - # Insert or patch (for the ones that already exist) per-instance configs for the - # managed instance group. perInstanceConfig.instance serves as a key used to - # distinguish whether to perform insert or patch. + # Inserts or patches per-instance configs for the managed instance group. + # perInstanceConfig.name serves as a key used to distinguish whether to perform + # insert or patch. # @param [String] project # Project ID for this request. # @param [String] zone @@ -9056,9 +9198,9 @@ module Google execute_or_queue_command(command, &block) end - # Insert or update (for the ones that already exist) per-instance configs for - # the managed instance group. perInstanceConfig.instance serves as a key used to - # distinguish whether to perform insert or patch. + # Inserts or updates per-instance configs for the managed instance group. + # perInstanceConfig.name serves as a key used to distinguish whether to perform + # insert or patch. # @param [String] project # Project ID for this request. # @param [String] zone @@ -9176,19 +9318,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -9198,21 +9340,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -9232,7 +9377,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_instance_group_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_instance_group_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/instanceGroups', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceGroupAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceGroupAggregatedList @@ -9242,6 +9387,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -9403,36 +9549,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -9452,7 +9601,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_instance_groups(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_instance_groups(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/instanceGroups', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceGroupList::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceGroupList @@ -9462,6 +9611,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -9481,36 +9631,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -9530,7 +9683,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_instance_group_instances(project, zone, instance_group, instance_groups_list_instances_request_object = nil, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_instance_group_instances(project, zone, instance_group, instance_groups_list_instances_request_object = nil, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances', options) command.request_representation = Google::Apis::ComputeAlpha::InstanceGroupsListInstancesRequest::Representation command.request_object = instance_groups_list_instances_request_object @@ -9543,6 +9696,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -9889,36 +10043,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -9938,7 +10095,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_instance_templates(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_instance_templates(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/instanceTemplates', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceTemplateList::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceTemplateList @@ -9947,6 +10104,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -10153,19 +10311,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -10175,21 +10333,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -10209,7 +10370,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_instance_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_instance_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/instances', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceAggregatedList @@ -10219,6 +10380,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -10286,6 +10448,57 @@ module Google execute_or_queue_command(command, &block) end + # Creates multiple instances. Count specifies the number of instances to create. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [Google::Apis::ComputeAlpha::BulkInsertInstanceResource] bulk_insert_instance_resource_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def bulk_instance_insert(project, zone, bulk_insert_instance_resource_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/zones/{zone}/instances/bulkInsert', options) + command.request_representation = Google::Apis::ComputeAlpha::BulkInsertInstanceResource::Representation + command.request_object = bulk_insert_instance_resource_object + command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation + command.response_class = Google::Apis::ComputeAlpha::Operation + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Deletes the specified Instance resource. For more information, see Stopping or # Deleting an Instance. # @param [String] project @@ -10864,36 +11077,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -10913,7 +11129,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_instances(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_instances(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/instances', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceList::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceList @@ -10923,6 +11139,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -10942,36 +11159,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -10991,7 +11211,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_instance_referrers(project, zone, instance, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_instance_referrers(project, zone, instance, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/instances/{instance}/referrers', options) command.response_representation = Google::Apis::ComputeAlpha::InstanceListReferrers::Representation command.response_class = Google::Apis::ComputeAlpha::InstanceListReferrers @@ -11002,6 +11222,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -12235,7 +12456,9 @@ module Google execute_or_queue_command(command, &block) end - # Updates an instance. + # Updates an instance only if the necessary resources are available. This method + # can update only a specific set of instance properties. See Updating a running + # instance for a list of updatable instance properties. # @param [String] project # Project ID for this request. # @param [String] zone @@ -12244,13 +12467,14 @@ module Google # Name of the instance resource to update. # @param [Google::Apis::ComputeAlpha::Instance] instance_object # @param [String] minimal_action - # If specified, this action or higher level action is performed on the instance - # irrespective of what action is required for the update to take effect. If not - # specified, then Compute Engine acts based on the minimum action required. + # Specifies the action to take when updating an instance even if the updated + # properties do not require it. If not specified, then Compute Engine acts based + # on the minimum action that the updated properties require. # @param [String] most_disruptive_allowed_action - # If specified, Compute Engine returns an error if the update requires a higher - # action to be applied to the instance. If not specified, the default will be - # REFRESH. + # Specifies the most disruptive action that can be taken on the instance as part + # of the update. Compute Engine returns an error if the instance properties + # require a more disruptive action as part of the instance update. Valid options + # from lowest to highest are NO_EFFECT, REFRESH, and RESTART. # @param [String] request_id # An optional request ID to identify requests. Specify a unique request ID so # that if you must retry your request, the server will know to ignore the @@ -12590,19 +12814,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -12612,21 +12836,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -12646,7 +12873,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_interconnect_attachment_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_interconnect_attachment_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/interconnectAttachments', options) command.response_representation = Google::Apis::ComputeAlpha::InterconnectAttachmentAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::InterconnectAttachmentAggregatedList @@ -12656,6 +12883,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -12860,36 +13088,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -12909,7 +13140,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_interconnect_attachments(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_interconnect_attachments(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/interconnectAttachments', options) command.response_representation = Google::Apis::ComputeAlpha::InterconnectAttachmentList::Representation command.response_class = Google::Apis::ComputeAlpha::InterconnectAttachmentList @@ -12919,6 +13150,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -13166,36 +13398,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -13215,7 +13450,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_interconnect_locations(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_interconnect_locations(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/interconnectLocations', options) command.response_representation = Google::Apis::ComputeAlpha::InterconnectLocationList::Representation command.response_class = Google::Apis::ComputeAlpha::InterconnectLocationList @@ -13224,6 +13459,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -13486,36 +13722,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -13535,7 +13774,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_interconnects(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_interconnects(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/interconnects', options) command.response_representation = Google::Apis::ComputeAlpha::InterconnectList::Representation command.response_class = Google::Apis::ComputeAlpha::InterconnectList @@ -13544,6 +13783,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -13723,7 +13963,9 @@ module Google end # Return a specified license code. License codes are mirrored across all - # projects that have permissions to read the License Code. + # projects that have permissions to read the License Code. Caution This + # resource is intended for use only by third-party partners who are creating + # Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] license_code @@ -13760,7 +14002,8 @@ module Google end # Gets the access control policy for a resource. May be empty if no such policy - # or resource exists. + # or resource exists. Caution This resource is intended for use only by third- + # party partners who are creating Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] resource @@ -13800,7 +14043,8 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. + # existing policy. Caution This resource is intended for use only by third- + # party partners who are creating Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] resource @@ -13839,7 +14083,9 @@ module Google execute_or_queue_command(command, &block) end - # Returns permissions that a caller has on the specified resource. + # Returns permissions that a caller has on the specified resource. Caution This + # resource is intended for use only by third-party partners who are creating + # Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] resource @@ -13878,7 +14124,8 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified license. + # Deletes the specified license. Caution This resource is intended for use only + # by third-party partners who are creating Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] license @@ -13926,7 +14173,8 @@ module Google execute_or_queue_command(command, &block) end - # Returns the specified License resource. + # Returns the specified License resource. Caution This resource is intended for + # use only by third-party partners who are creating Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] license @@ -13963,7 +14211,8 @@ module Google end # Gets the access control policy for a resource. May be empty if no such policy - # or resource exists. + # or resource exists. Caution This resource is intended for use only by third- + # party partners who are creating Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] resource @@ -14002,7 +14251,9 @@ module Google execute_or_queue_command(command, &block) end - # Create a License resource in the specified project. + # Create a License resource in the specified project. Caution This resource is + # intended for use only by third-party partners who are creating Cloud + # Marketplace images. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeAlpha::License] license_object @@ -14054,43 +14305,48 @@ module Google # does not get any licenses that belong to other projects, including licenses # attached to publicly-available images, like Debian 9. If you want to get a # list of publicly-available licenses, use this method to make a request to the - # respective image project, such as debian-cloud or windows-cloud. + # respective image project, such as debian-cloud or windows-cloud. Caution This + # resource is intended for use only by third-party partners who are creating + # Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] filter # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -14110,7 +14366,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_licenses(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_licenses(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/licenses', options) command.response_representation = Google::Apis::ComputeAlpha::LicensesListResponse::Representation command.response_class = Google::Apis::ComputeAlpha::LicensesListResponse @@ -14119,6 +14375,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -14126,7 +14383,8 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. + # existing policy. Caution This resource is intended for use only by third- + # party partners who are creating Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] resource @@ -14165,7 +14423,9 @@ module Google execute_or_queue_command(command, &block) end - # Returns permissions that a caller has on the specified resource. + # Returns permissions that a caller has on the specified resource. Caution This + # resource is intended for use only by third-party partners who are creating + # Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] resource @@ -14392,36 +14652,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -14441,7 +14704,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_machine_images(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_machine_images(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/machineImages', options) command.response_representation = Google::Apis::ComputeAlpha::MachineImageList::Representation command.response_class = Google::Apis::ComputeAlpha::MachineImageList @@ -14450,6 +14713,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -14542,19 +14806,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -14564,21 +14828,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -14598,7 +14865,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_machine_type_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_machine_type_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/machineTypes', options) command.response_representation = Google::Apis::ComputeAlpha::MachineTypeAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::MachineTypeAggregatedList @@ -14608,6 +14875,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -14663,36 +14931,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -14712,7 +14983,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_machine_types(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_machine_types(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/machineTypes', options) command.response_representation = Google::Apis::ComputeAlpha::MachineTypeList::Representation command.response_class = Google::Apis::ComputeAlpha::MachineTypeList @@ -14722,6 +14993,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -14735,19 +15007,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -14757,21 +15029,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -14791,7 +15066,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_network_endpoint_group_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_network_endpoint_group_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/networkEndpointGroups', options) command.response_representation = Google::Apis::ComputeAlpha::NetworkEndpointGroupAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::NetworkEndpointGroupAggregatedList @@ -14801,6 +15076,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -15080,36 +15356,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -15129,7 +15408,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_network_endpoint_groups(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_network_endpoint_groups(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/networkEndpointGroups', options) command.response_representation = Google::Apis::ComputeAlpha::NetworkEndpointGroupList::Representation command.response_class = Google::Apis::ComputeAlpha::NetworkEndpointGroupList @@ -15139,6 +15418,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -15159,36 +15439,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -15208,7 +15491,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_network_endpoint_group_network_endpoints(project, zone, network_endpoint_group, network_endpoint_groups_list_endpoints_request_object = nil, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_network_endpoint_group_network_endpoints(project, zone, network_endpoint_group, network_endpoint_groups_list_endpoints_request_object = nil, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints', options) command.request_representation = Google::Apis::ComputeAlpha::NetworkEndpointGroupsListEndpointsRequest::Representation command.request_object = network_endpoint_groups_list_endpoints_request_object @@ -15221,6 +15504,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -15497,36 +15781,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -15546,7 +15833,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_networks(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_networks(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/networks', options) command.response_representation = Google::Apis::ComputeAlpha::NetworkList::Representation command.response_class = Google::Apis::ComputeAlpha::NetworkList @@ -15555,6 +15842,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -15570,36 +15858,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] types # (Optional) types filter separate by comma, valid values are: SUBNETWORK, # RESERVED, PEER_USED, PEER_RESERVED, REMOTE_USED, REMOTE_RESERVED. @@ -15622,7 +15913,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_network_ip_addresses(project, network, filter: nil, max_results: nil, order_by: nil, page_token: nil, types: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_network_ip_addresses(project, network, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, types: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/networks/{network}/listIpAddresses', options) command.response_representation = Google::Apis::ComputeAlpha::IpAddressesList::Representation command.response_class = Google::Apis::ComputeAlpha::IpAddressesList @@ -15632,6 +15923,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['types'] = types unless types.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? @@ -15648,42 +15940,45 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [String] ip_cidr_range # (Optional) IP CIDR range filter, example: "10.128.10.0/30". # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] owner_projects # (Optional) Project IDs filter, example: "project-1,project-2". # @param [String] owner_types # (Optional) Owner types filter, example: "instance,forwardingRule". # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] subnet_name # (Optional) Subnetwork name filter. # @param [String] subnet_region @@ -15707,7 +16002,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_network_ip_owners(project, network, filter: nil, ip_cidr_range: nil, max_results: nil, order_by: nil, owner_projects: nil, owner_types: nil, page_token: nil, subnet_name: nil, subnet_region: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_network_ip_owners(project, network, filter: nil, ip_cidr_range: nil, max_results: nil, order_by: nil, owner_projects: nil, owner_types: nil, page_token: nil, return_partial_success: nil, subnet_name: nil, subnet_region: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/networks/{network}/listIpOwners', options) command.response_representation = Google::Apis::ComputeAlpha::IpOwnerList::Representation command.response_class = Google::Apis::ComputeAlpha::IpOwnerList @@ -15720,6 +16015,7 @@ module Google command.query['ownerProjects'] = owner_projects unless owner_projects.nil? command.query['ownerTypes'] = owner_types unless owner_types.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['subnetName'] = subnet_name unless subnet_name.nil? command.query['subnetRegion'] = subnet_region unless subnet_region.nil? command.query['fields'] = fields unless fields.nil? @@ -15739,41 +16035,44 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] peering_name # The response will show routes exchanged over the given peering connection. # @param [String] region # The region of the request. The response will include all subnet routes, static # routes and dynamic routes in the region. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -15793,7 +16092,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_network_peering_routes(project, network, direction: nil, filter: nil, max_results: nil, order_by: nil, page_token: nil, peering_name: nil, region: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_network_peering_routes(project, network, direction: nil, filter: nil, max_results: nil, order_by: nil, page_token: nil, peering_name: nil, region: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/networks/{network}/listPeeringRoutes', options) command.response_representation = Google::Apis::ComputeAlpha::ExchangedPeeringRoutesList::Representation command.response_class = Google::Apis::ComputeAlpha::ExchangedPeeringRoutesList @@ -15806,6 +16105,7 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['peeringName'] = peering_name unless peering_name.nil? command.query['region'] = region unless region.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -16117,19 +16417,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -16139,21 +16439,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -16173,7 +16476,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_node_group_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_node_group_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/nodeGroups', options) command.response_representation = Google::Apis::ComputeAlpha::NodeGroupAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::NodeGroupAggregatedList @@ -16183,6 +16486,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -16443,36 +16747,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -16492,7 +16799,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_node_groups(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_node_groups(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/nodeGroups', options) command.response_representation = Google::Apis::ComputeAlpha::NodeGroupList::Representation command.response_class = Google::Apis::ComputeAlpha::NodeGroupList @@ -16502,6 +16809,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -16519,36 +16827,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -16568,7 +16879,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_node_group_nodes(project, zone, node_group, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_node_group_nodes(project, zone, node_group, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes', options) command.response_representation = Google::Apis::ComputeAlpha::NodeGroupsListNodes::Representation command.response_class = Google::Apis::ComputeAlpha::NodeGroupsListNodes @@ -16579,6 +16890,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -16785,19 +17097,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -16807,21 +17119,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -16841,7 +17156,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_node_template_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_node_template_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/nodeTemplates', options) command.response_representation = Google::Apis::ComputeAlpha::NodeTemplateAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::NodeTemplateAggregatedList @@ -16851,6 +17166,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -17052,36 +17368,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -17101,7 +17420,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_node_templates(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_node_templates(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/nodeTemplates', options) command.response_representation = Google::Apis::ComputeAlpha::NodeTemplateList::Representation command.response_class = Google::Apis::ComputeAlpha::NodeTemplateList @@ -17111,6 +17430,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -17209,19 +17529,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -17231,21 +17551,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -17265,7 +17588,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_node_type_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_node_type_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/nodeTypes', options) command.response_representation = Google::Apis::ComputeAlpha::NodeTypeAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::NodeTypeAggregatedList @@ -17275,6 +17598,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -17330,36 +17654,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -17379,7 +17706,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_node_types(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_node_types(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/nodeTypes', options) command.response_representation = Google::Apis::ComputeAlpha::NodeTypeList::Representation command.response_class = Google::Apis::ComputeAlpha::NodeTypeList @@ -17389,6 +17716,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -17748,38 +18076,41 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] parent_id # Parent ID for this request. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -17799,7 +18130,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_organization_security_policies(filter: nil, max_results: nil, order_by: nil, page_token: nil, parent_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_organization_security_policies(filter: nil, max_results: nil, order_by: nil, page_token: nil, parent_id: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'locations/global/securityPolicies', options) command.response_representation = Google::Apis::ComputeAlpha::SecurityPolicyList::Representation command.response_class = Google::Apis::ComputeAlpha::SecurityPolicyList @@ -17808,6 +18139,7 @@ module Google command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['parentId'] = parent_id unless parent_id.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -18097,19 +18429,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -18119,21 +18451,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -18153,7 +18488,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_packet_mirroring_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_packet_mirroring_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/packetMirrorings', options) command.response_representation = Google::Apis::ComputeAlpha::PacketMirroringAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::PacketMirroringAggregatedList @@ -18163,6 +18498,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -18321,36 +18657,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -18370,7 +18709,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_packet_mirrorings(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_packet_mirrorings(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/packetMirrorings', options) command.response_representation = Google::Apis::ComputeAlpha::PacketMirroringList::Representation command.response_class = Google::Apis::ComputeAlpha::PacketMirroringList @@ -18380,6 +18719,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -18747,36 +19087,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -18803,7 +19143,7 @@ module Google command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.nil? - command.query['order_by'] = order_by unless order_by.nil? + command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? @@ -18819,36 +19159,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -18877,7 +19217,7 @@ module Google command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.nil? - command.query['order_by'] = order_by unless order_by.nil? + command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? @@ -19320,36 +19660,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -19369,7 +19712,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_public_advertised_prefixes(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_public_advertised_prefixes(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/publicAdvertisedPrefixes', options) command.response_representation = Google::Apis::ComputeAlpha::PublicAdvertisedPrefixList::Representation command.response_class = Google::Apis::ComputeAlpha::PublicAdvertisedPrefixList @@ -19378,6 +19721,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -19445,19 +19789,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -19467,21 +19811,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -19501,7 +19848,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_public_delegated_prefix_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_public_delegated_prefix_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/publicDelegatedPrefixes', options) command.response_representation = Google::Apis::ComputeAlpha::PublicDelegatedPrefixAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::PublicDelegatedPrefixAggregatedList @@ -19511,6 +19858,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -19668,36 +20016,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -19717,7 +20068,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_public_delegated_prefixes(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_public_delegated_prefixes(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/publicDelegatedPrefixes', options) command.response_representation = Google::Apis::ComputeAlpha::PublicDelegatedPrefixList::Representation command.response_class = Google::Apis::ComputeAlpha::PublicDelegatedPrefixList @@ -19727,6 +20078,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -19940,36 +20292,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -19989,7 +20344,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_autoscalers(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_autoscalers(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/autoscalers', options) command.response_representation = Google::Apis::ComputeAlpha::RegionAutoscalerList::Representation command.response_class = Google::Apis::ComputeAlpha::RegionAutoscalerList @@ -19999,6 +20354,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -20291,8 +20647,8 @@ module Google # Creates a regional BackendService resource in the specified project using the # data included in the request. There are several restrictions and guidelines to - # keep in mind when creating a regional backend service. Read Restrictions and - # Guidelines for more information. + # keep in mind when creating a regional backend service. Read Understanding + # backend services for more information. # @param [String] project # Project ID for this request. # @param [String] region @@ -20353,36 +20709,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -20402,7 +20761,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_backend_services(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_backend_services(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/backendServices', options) command.response_representation = Google::Apis::ComputeAlpha::BackendServiceList::Representation command.response_class = Google::Apis::ComputeAlpha::BackendServiceList @@ -20412,6 +20771,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -20419,9 +20779,9 @@ module Google end # Updates the specified regional BackendService resource with the data included - # in the request. There are several restrictions and guidelines to keep in mind - # when updating a backend service. Read Restrictions and Guidelines for more - # information. This method supports PATCH semantics and uses the JSON merge + # in the request. There are several Understanding backend services to keep in + # mind when updating a backend service. Read Understanding backend services for + # more information. This method supports PATCH semantics and uses the JSON merge # patch format and processing rules. # @param [String] project # Project ID for this request. @@ -20519,9 +20879,9 @@ module Google end # Updates the specified regional BackendService resource with the data included - # in the request. There are several restrictions and guidelines to keep in mind - # when updating a backend service. Read Restrictions and Guidelines for more - # information. + # in the request. There are several Understanding backend services to keep in + # mind when updating a backend service. Read Understanding backend services for + # more information. # @param [String] project # Project ID for this request. # @param [String] region @@ -20582,19 +20942,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -20604,21 +20964,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -20638,7 +21001,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_region_commitment_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_region_commitment_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/commitments', options) command.response_representation = Google::Apis::ComputeAlpha::CommitmentAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::CommitmentAggregatedList @@ -20648,6 +21011,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -20755,36 +21119,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -20804,7 +21171,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_commitments(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_commitments(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/commitments', options) command.response_representation = Google::Apis::ComputeAlpha::CommitmentList::Representation command.response_class = Google::Apis::ComputeAlpha::CommitmentList @@ -20814,6 +21181,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -20965,36 +21333,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -21014,7 +21385,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_disk_types(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_disk_types(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/diskTypes', options) command.response_representation = Google::Apis::ComputeAlpha::RegionDiskTypeList::Representation command.response_class = Google::Apis::ComputeAlpha::RegionDiskTypeList @@ -21024,6 +21395,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -21344,36 +21716,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -21393,7 +21768,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_disks(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_disks(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/disks', options) command.response_representation = Google::Apis::ComputeAlpha::DiskList::Representation command.response_class = Google::Apis::ComputeAlpha::DiskList @@ -21403,6 +21778,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -21810,36 +22186,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -21859,7 +22238,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_health_check_services(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_health_check_services(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/healthCheckServices', options) command.response_representation = Google::Apis::ComputeAlpha::HealthCheckServicesList::Representation command.response_class = Google::Apis::ComputeAlpha::HealthCheckServicesList @@ -21869,6 +22248,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -22126,36 +22506,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -22175,7 +22558,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_health_checks(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_health_checks(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/healthChecks', options) command.response_representation = Google::Apis::ComputeAlpha::HealthCheckList::Representation command.response_class = Google::Apis::ComputeAlpha::HealthCheckList @@ -22185,6 +22568,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -22344,6 +22728,414 @@ module Google execute_or_queue_command(command, &block) end + # Deletes the specified InPlaceSnapshot resource. Keep in mind that deleting a + # single inPlaceSnapshot might not necessarily delete all the data on that + # inPlaceSnapshot. If any data on the inPlaceSnapshot that is marked for + # deletion is needed for subsequent inPlaceSnapshots, the data will be moved to + # the next corresponding inPlaceSnapshot. + # For more information, see Deleting inPlaceSnapshots. + # @param [String] project + # Project ID for this request. + # @param [String] region + # The name of the region for this request. + # @param [String] in_place_snapshot + # Name of the InPlaceSnapshot resource to delete. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_region_in_place_snapshot(project, region, in_place_snapshot, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, '{project}/regions/{region}/inPlaceSnapshots/{inPlaceSnapshot}', options) + command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation + command.response_class = Google::Apis::ComputeAlpha::Operation + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.params['inPlaceSnapshot'] = in_place_snapshot unless in_place_snapshot.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Returns the specified InPlaceSnapshot resource in the specified region. + # @param [String] project + # Project ID for this request. + # @param [String] region + # The name of the region for this request. + # @param [String] in_place_snapshot + # Name of the InPlaceSnapshot resource to return. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::InPlaceSnapshot] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::InPlaceSnapshot] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_region_in_place_snapshot(project, region, in_place_snapshot, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/regions/{region}/inPlaceSnapshots/{inPlaceSnapshot}', options) + command.response_representation = Google::Apis::ComputeAlpha::InPlaceSnapshot::Representation + command.response_class = Google::Apis::ComputeAlpha::InPlaceSnapshot + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.params['inPlaceSnapshot'] = in_place_snapshot unless in_place_snapshot.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. May be empty if no such policy + # or resource exists. + # @param [String] project + # Project ID for this request. + # @param [String] region + # The name of the region for this request. + # @param [String] resource + # Name or id of the resource for this request. + # @param [Fixnum] options_requested_policy_version + # Requested IAM Policy version. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_region_in_place_snapshot_iam_policy(project, region, resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/regions/{region}/inPlaceSnapshots/{resource}/getIamPolicy', options) + command.response_representation = Google::Apis::ComputeAlpha::Policy::Representation + command.response_class = Google::Apis::ComputeAlpha::Policy + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.params['resource'] = resource unless resource.nil? + command.query['optionsRequestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Creates an in-place snapshot in the specified region. + # @param [String] project + # Project ID for this request. + # @param [String] region + # Name of the region for this request. + # @param [Google::Apis::ComputeAlpha::InPlaceSnapshot] in_place_snapshot_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_region_in_place_snapshot(project, region, in_place_snapshot_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/regions/{region}/inPlaceSnapshots', options) + command.request_representation = Google::Apis::ComputeAlpha::InPlaceSnapshot::Representation + command.request_object = in_place_snapshot_object + command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation + command.response_class = Google::Apis::ComputeAlpha::Operation + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the list of InPlaceSnapshot resources contained within the specified + # region. + # @param [String] project + # Project ID for this request. + # @param [String] region + # The name of the region for this request. + # @param [String] filter + # A filter expression that filters resources listed in the response. The + # expression must specify the field name, a comparison operator, and the value + # that you want to use for filtering. The value must be a string, a number, or a + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. + # For example, if you are filtering Compute Engine instances, you can exclude + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled + # for automatic restarts. You can use filtering on nested fields to filter based + # on resource labels. + # To filter on multiple expressions, provide each separate expression within + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Fixnum] max_results + # The maximum number of results per page that should be returned. If the number + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + # @param [String] order_by + # Sorts list results by a certain order. By default, results are returned in + # alphanumerical order based on the resource name. + # You can also sort results in descending order based on the creation timestamp + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). + # Use this to sort resources like operations so that the newest operation is + # returned first. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. + # @param [String] page_token + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::InPlaceSnapshotList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::InPlaceSnapshotList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_region_in_place_snapshots(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/regions/{region}/inPlaceSnapshots', options) + command.response_representation = Google::Apis::ComputeAlpha::InPlaceSnapshotList::Representation + command.response_class = Google::Apis::ComputeAlpha::InPlaceSnapshotList + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.query['filter'] = filter unless filter.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. + # @param [String] project + # Project ID for this request. + # @param [String] region + # The name of the region for this request. + # @param [String] resource + # Name or id of the resource for this request. + # @param [Google::Apis::ComputeAlpha::RegionSetPolicyRequest] region_set_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_region_in_place_snapshot_iam_policy(project, region, resource, region_set_policy_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/regions/{region}/inPlaceSnapshots/{resource}/setIamPolicy', options) + command.request_representation = Google::Apis::ComputeAlpha::RegionSetPolicyRequest::Representation + command.request_object = region_set_policy_request_object + command.response_representation = Google::Apis::ComputeAlpha::Policy::Representation + command.response_class = Google::Apis::ComputeAlpha::Policy + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Sets the labels on a inPlaceSnapshot in the given region. To learn more about + # labels, read the Labeling Resources documentation. + # @param [String] project + # Project ID for this request. + # @param [String] region + # The region for this request. + # @param [String] resource + # Name or id of the resource for this request. + # @param [Google::Apis::ComputeAlpha::RegionSetLabelsRequest] region_set_labels_request_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_region_in_place_snapshot_labels(project, region, resource, region_set_labels_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/regions/{region}/inPlaceSnapshots/{resource}/setLabels', options) + command.request_representation = Google::Apis::ComputeAlpha::RegionSetLabelsRequest::Representation + command.request_object = region_set_labels_request_object + command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation + command.response_class = Google::Apis::ComputeAlpha::Operation + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.params['resource'] = resource unless resource.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Returns permissions that a caller has on the specified resource. + # @param [String] project + # Project ID for this request. + # @param [String] region + # The name of the region for this request. + # @param [String] resource + # Name or id of the resource for this request. + # @param [Google::Apis::ComputeAlpha::TestPermissionsRequest] test_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::TestPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::TestPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_region_in_place_snapshot_iam_permissions(project, region, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/regions/{region}/inPlaceSnapshots/{resource}/testIamPermissions', options) + command.request_representation = Google::Apis::ComputeAlpha::TestPermissionsRequest::Representation + command.request_object = test_permissions_request_object + command.response_representation = Google::Apis::ComputeAlpha::TestPermissionsResponse::Representation + command.response_class = Google::Apis::ComputeAlpha::TestPermissionsResponse + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Flags the specified instances to be immediately removed from the managed # instance group. Abandoning an instance does not delete the instance, but it # does remove the instance from any target pools that are applied by the managed @@ -22774,36 +23566,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -22823,7 +23618,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_instance_group_managers(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_instance_group_managers(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/instanceGroupManagers', options) command.response_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupManagerList::Representation command.response_class = Google::Apis::ComputeAlpha::RegionInstanceGroupManagerList @@ -22833,6 +23628,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -22853,36 +23649,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -22902,7 +23701,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_instance_group_manager_errors(project, region, instance_group_manager, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_instance_group_manager_errors(project, region, instance_group_manager, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors', options) command.response_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupManagersListErrorsResponse::Representation command.response_class = Google::Apis::ComputeAlpha::RegionInstanceGroupManagersListErrorsResponse @@ -22913,6 +23712,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -22932,36 +23732,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -22990,7 +23790,7 @@ module Google command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.nil? - command.query['order_by'] = order_by unless order_by.nil? + command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? @@ -23009,36 +23809,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -23058,7 +23861,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_instance_group_manager_per_instance_configs(project, region, instance_group_manager, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_instance_group_manager_per_instance_configs(project, region, instance_group_manager, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs', options) command.response_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupManagersListInstanceConfigsResp::Representation command.response_class = Google::Apis::ComputeAlpha::RegionInstanceGroupManagersListInstanceConfigsResp @@ -23069,6 +23872,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -23685,36 +24489,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -23734,7 +24541,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_instance_groups(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_instance_groups(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/instanceGroups', options) command.response_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupList::Representation command.response_class = Google::Apis::ComputeAlpha::RegionInstanceGroupList @@ -23744,6 +24551,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -23764,36 +24572,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -23813,7 +24624,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_instance_group_instances(project, region, instance_group, region_instance_groups_list_instances_request_object = nil, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_instance_group_instances(project, region, instance_group, region_instance_groups_list_instances_request_object = nil, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances', options) command.request_representation = Google::Apis::ComputeAlpha::RegionInstanceGroupsListInstancesRequest::Representation command.request_object = region_instance_groups_list_instances_request_object @@ -23826,6 +24637,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -23928,6 +24740,58 @@ module Google execute_or_queue_command(command, &block) end + # Creates multiple instances in a given region. Count specifies the number of + # instances to create. + # @param [String] project + # Project ID for this request. + # @param [String] region + # The name of the region for this request. + # @param [Google::Apis::ComputeAlpha::BulkInsertInstanceResource] bulk_insert_instance_resource_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def bulk_region_instance_insert(project, region, bulk_insert_instance_resource_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/regions/{region}/instances/bulkInsert', options) + command.request_representation = Google::Apis::ComputeAlpha::BulkInsertInstanceResource::Representation + command.request_object = bulk_insert_instance_resource_object + command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation + command.response_class = Google::Apis::ComputeAlpha::Operation + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Deletes the specified network endpoint group. Note that the NEG cannot be # deleted if it is configured as a backend of a backend service. # @param [String] project @@ -24087,36 +24951,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -24136,7 +25003,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_network_endpoint_groups(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_network_endpoint_groups(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/networkEndpointGroups', options) command.response_representation = Google::Apis::ComputeAlpha::NetworkEndpointGroupList::Representation command.response_class = Google::Apis::ComputeAlpha::NetworkEndpointGroupList @@ -24146,6 +25013,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -24303,36 +25171,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -24352,7 +25223,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_notification_endpoints(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_notification_endpoints(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/notificationEndpoints', options) command.response_representation = Google::Apis::ComputeAlpha::NotificationEndpointList::Representation command.response_class = Google::Apis::ComputeAlpha::NotificationEndpointList @@ -24362,6 +25233,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -24495,36 +25367,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -24544,7 +25419,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_operations(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_operations(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/operations', options) command.response_representation = Google::Apis::ComputeAlpha::OperationList::Representation command.response_class = Google::Apis::ComputeAlpha::OperationList @@ -24554,23 +25429,24 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Waits for the specified Operation resource to return as DONE or for the + # Waits for the specified Operation resource to return as `DONE` or for the # request to approach the 2 minute deadline, and retrieves the specified - # Operation resource. This method differs from the GET method in that it waits + # Operation resource. This method differs from the `GET` method in that it waits # for no more than the default deadline (2 minutes) and then returns the current - # state of the operation, which might be DONE or still in progress. + # state of the operation, which might be `DONE` or still in progress. # This method is called on a best-effort basis. Specifically: # - In uncommon cases, when the server is overloaded, the request might return # before the default deadline is reached, or might return after zero seconds. # - If the default deadline is reached, there is no guarantee that the operation # is actually done when the method returns. Be prepared to retry if the - # operation is not DONE. + # operation is not `DONE`. # @param [String] project # Project ID for this request. # @param [String] region @@ -24762,36 +25638,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -24811,7 +25690,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_ssl_certificates(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_ssl_certificates(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/sslCertificates', options) command.response_representation = Google::Apis::ComputeAlpha::SslCertificateList::Representation command.response_class = Google::Apis::ComputeAlpha::SslCertificateList @@ -24821,6 +25700,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -25022,36 +25902,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -25071,7 +25954,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_target_http_proxies(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_target_http_proxies(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/targetHttpProxies', options) command.response_representation = Google::Apis::ComputeAlpha::TargetHttpProxyList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetHttpProxyList @@ -25081,6 +25964,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -25336,36 +26220,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -25385,7 +26272,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_target_https_proxies(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_target_https_proxies(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/targetHttpsProxies', options) command.response_representation = Google::Apis::ComputeAlpha::TargetHttpsProxyList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetHttpsProxyList @@ -25395,6 +26282,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -25732,36 +26620,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -25781,7 +26672,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_region_url_maps(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_region_url_maps(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/urlMaps', options) command.response_representation = Google::Apis::ComputeAlpha::UrlMapList::Representation command.response_class = Google::Apis::ComputeAlpha::UrlMapList @@ -25791,6 +26682,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -26018,36 +26910,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -26067,7 +26962,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_regions(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_regions(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions', options) command.response_representation = Google::Apis::ComputeAlpha::RegionList::Representation command.response_class = Google::Apis::ComputeAlpha::RegionList @@ -26076,6 +26971,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -26089,19 +26985,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -26111,21 +27007,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -26145,7 +27044,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_reservation_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_reservation_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/reservations', options) command.response_representation = Google::Apis::ComputeAlpha::ReservationAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::ReservationAggregatedList @@ -26155,6 +27054,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -26356,36 +27256,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -26405,7 +27308,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_reservations(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_reservations(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/reservations', options) command.response_representation = Google::Apis::ComputeAlpha::ReservationList::Representation command.response_class = Google::Apis::ComputeAlpha::ReservationList @@ -26415,6 +27318,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -26568,19 +27472,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -26590,21 +27494,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -26624,7 +27531,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_resource_policy_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_resource_policy_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/resourcePolicies', options) command.response_representation = Google::Apis::ComputeAlpha::ResourcePolicyAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::ResourcePolicyAggregatedList @@ -26634,6 +27541,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -26834,36 +27742,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -26883,7 +27794,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_resource_policies(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_resource_policies(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/resourcePolicies', options) command.response_representation = Google::Apis::ComputeAlpha::ResourcePolicyList::Representation command.response_class = Google::Apis::ComputeAlpha::ResourcePolicyList @@ -26893,6 +27804,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -26991,19 +27903,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -27013,21 +27925,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -27047,7 +27962,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_router_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_router_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/routers', options) command.response_representation = Google::Apis::ComputeAlpha::RouterAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::RouterAggregatedList @@ -27057,6 +27972,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -27166,24 +28082,24 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] nat_name # Name of the nat service to filter the Nat Mapping information. If it is # omitted, all nats for this router will be returned. Name should conform to @@ -27192,14 +28108,17 @@ module Google # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -27219,7 +28138,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_router_nat_mapping_info(project, region, router, filter: nil, max_results: nil, nat_name: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def get_router_nat_mapping_info(project, region, router, filter: nil, max_results: nil, nat_name: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/routers/{router}/getNatMappingInfo', options) command.response_representation = Google::Apis::ComputeAlpha::VmEndpointNatMappingsList::Representation command.response_class = Google::Apis::ComputeAlpha::VmEndpointNatMappingsList @@ -27231,6 +28150,7 @@ module Google command.query['natName'] = nat_name unless nat_name.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -27337,36 +28257,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -27386,7 +28309,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_routers(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_routers(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/routers', options) command.response_representation = Google::Apis::ComputeAlpha::RouterList::Representation command.response_class = Google::Apis::ComputeAlpha::RouterList @@ -27396,6 +28319,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -27741,36 +28665,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -27790,7 +28717,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_routes(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_routes(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/routes', options) command.response_representation = Google::Apis::ComputeAlpha::RouteList::Representation command.response_class = Google::Apis::ComputeAlpha::RouteList @@ -27799,6 +28726,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -28068,36 +28996,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -28117,7 +29048,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_security_policies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_security_policies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/securityPolicies', options) command.response_representation = Google::Apis::ComputeAlpha::SecurityPolicyList::Representation command.response_class = Google::Apis::ComputeAlpha::SecurityPolicyList @@ -28126,6 +29057,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -28140,36 +29072,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -28189,7 +29124,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_security_policy_preconfigured_expression_sets(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_security_policy_preconfigured_expression_sets(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/securityPolicies/listPreconfiguredExpressionSets', options) command.response_representation = Google::Apis::ComputeAlpha::SecurityPoliciesListPreconfiguredExpressionSetsResponse::Representation command.response_class = Google::Apis::ComputeAlpha::SecurityPoliciesListPreconfiguredExpressionSetsResponse @@ -28198,6 +29133,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -28555,36 +29491,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -28604,7 +29543,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_snapshots(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_snapshots(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/snapshots', options) command.response_representation = Google::Apis::ComputeAlpha::SnapshotList::Representation command.response_class = Google::Apis::ComputeAlpha::SnapshotList @@ -28613,6 +29552,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -28746,19 +29686,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -28768,21 +29708,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -28802,7 +29745,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_ssl_certificate_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_ssl_certificate_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/sslCertificates', options) command.response_representation = Google::Apis::ComputeAlpha::SslCertificateAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::SslCertificateAggregatedList @@ -28812,6 +29755,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -28960,36 +29904,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -29009,7 +29956,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_ssl_certificates(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_ssl_certificates(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/sslCertificates', options) command.response_representation = Google::Apis::ComputeAlpha::SslCertificateList::Representation command.response_class = Google::Apis::ComputeAlpha::SslCertificateList @@ -29018,6 +29965,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -29206,36 +30154,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -29255,7 +30206,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_ssl_policies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_ssl_policies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/sslPolicies', options) command.response_representation = Google::Apis::ComputeAlpha::SslPoliciesList::Representation command.response_class = Google::Apis::ComputeAlpha::SslPoliciesList @@ -29264,6 +30215,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -29278,36 +30230,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -29327,7 +30282,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_ssl_policy_available_features(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_ssl_policy_available_features(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/sslPolicies/listAvailableFeatures', options) command.response_representation = Google::Apis::ComputeAlpha::SslPoliciesListAvailableFeaturesResponse::Representation command.response_class = Google::Apis::ComputeAlpha::SslPoliciesListAvailableFeaturesResponse @@ -29336,6 +30291,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -29440,19 +30396,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -29462,21 +30418,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -29496,7 +30455,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_subnetwork_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_subnetwork_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/subnetworks', options) command.response_representation = Google::Apis::ComputeAlpha::SubnetworkAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::SubnetworkAggregatedList @@ -29506,6 +30465,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -29761,36 +30721,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -29810,7 +30773,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_subnetworks(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_subnetworks(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/subnetworks', options) command.response_representation = Google::Apis::ComputeAlpha::SubnetworkList::Representation command.response_class = Google::Apis::ComputeAlpha::SubnetworkList @@ -29820,6 +30783,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -29835,36 +30799,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -29884,7 +30851,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_subnetwork_usable(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_subnetwork_usable(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/subnetworks/listUsable', options) command.response_representation = Google::Apis::ComputeAlpha::UsableSubnetworksAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::UsableSubnetworksAggregatedList @@ -29893,6 +30860,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -29901,7 +30869,7 @@ module Google # Patches the specified subnetwork with the data included in the request. Only # certain fields can up updated with a patch request as indicated in the field - # descriptions. You must specify the current fingeprint of the subnetwork + # descriptions. You must specify the current fingerprint of the subnetwork # resource being patched. # @param [String] project # Project ID for this request. @@ -30105,6 +31073,253 @@ module Google execute_or_queue_command(command, &block) end + # Deletes the specified TargetGrpcProxy in the given scope + # @param [String] project + # Project ID for this request. + # @param [String] target_grpc_proxy + # Name of the TargetGrpcProxy resource to delete. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_target_grpc_proxy(project, target_grpc_proxy, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, '{project}/global/targetGrpcProxies/{targetGrpcProxy}', options) + command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation + command.response_class = Google::Apis::ComputeAlpha::Operation + command.params['project'] = project unless project.nil? + command.params['targetGrpcProxy'] = target_grpc_proxy unless target_grpc_proxy.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Returns the specified TargetGrpcProxy resource in the given scope. + # @param [String] project + # Project ID for this request. + # @param [String] target_grpc_proxy + # Name of the TargetGrpcProxy resource to return. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::TargetGrpcProxy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::TargetGrpcProxy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_target_grpc_proxy(project, target_grpc_proxy, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/global/targetGrpcProxies/{targetGrpcProxy}', options) + command.response_representation = Google::Apis::ComputeAlpha::TargetGrpcProxy::Representation + command.response_class = Google::Apis::ComputeAlpha::TargetGrpcProxy + command.params['project'] = project unless project.nil? + command.params['targetGrpcProxy'] = target_grpc_proxy unless target_grpc_proxy.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Creates a TargetGrpcProxy in the specified project in the given scope using + # the parameters that are included in the request. + # @param [String] project + # Project ID for this request. + # @param [Google::Apis::ComputeAlpha::TargetGrpcProxy] target_grpc_proxy_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_target_grpc_proxy(project, target_grpc_proxy_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/global/targetGrpcProxies', options) + command.request_representation = Google::Apis::ComputeAlpha::TargetGrpcProxy::Representation + command.request_object = target_grpc_proxy_object + command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation + command.response_class = Google::Apis::ComputeAlpha::Operation + command.params['project'] = project unless project.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Lists the TargetGrpcProxies for a project in the given scope. + # @param [String] project + # Project ID for this request. + # @param [String] filter + # A filter expression that filters resources listed in the response. The + # expression must specify the field name, a comparison operator, and the value + # that you want to use for filtering. The value must be a string, a number, or a + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. + # For example, if you are filtering Compute Engine instances, you can exclude + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled + # for automatic restarts. You can use filtering on nested fields to filter based + # on resource labels. + # To filter on multiple expressions, provide each separate expression within + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Fixnum] max_results + # The maximum number of results per page that should be returned. If the number + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + # @param [String] order_by + # Sorts list results by a certain order. By default, results are returned in + # alphanumerical order based on the resource name. + # You can also sort results in descending order based on the creation timestamp + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). + # Use this to sort resources like operations so that the newest operation is + # returned first. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. + # @param [String] page_token + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::TargetGrpcProxyList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::TargetGrpcProxyList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_target_grpc_proxies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/global/targetGrpcProxies', options) + command.response_representation = Google::Apis::ComputeAlpha::TargetGrpcProxyList::Representation + command.response_class = Google::Apis::ComputeAlpha::TargetGrpcProxyList + command.params['project'] = project unless project.nil? + command.query['filter'] = filter unless filter.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Returns permissions that a caller has on the specified resource. + # @param [String] project + # Project ID for this request. + # @param [String] resource + # Name or id of the resource for this request. + # @param [Google::Apis::ComputeAlpha::TestPermissionsRequest] test_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::TestPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::TestPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_target_grpc_proxy_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/global/targetGrpcProxies/{resource}/testIamPermissions', options) + command.request_representation = Google::Apis::ComputeAlpha::TestPermissionsRequest::Representation + command.request_object = test_permissions_request_object + command.response_representation = Google::Apis::ComputeAlpha::TestPermissionsResponse::Representation + command.response_class = Google::Apis::ComputeAlpha::TestPermissionsResponse + command.params['project'] = project unless project.nil? + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Retrieves the list of all TargetHttpProxy resources, regional and global, # available to the specified project. # @param [String] project @@ -30113,19 +31328,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -30135,21 +31350,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -30169,7 +31387,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_target_http_proxy_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_target_http_proxy_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/targetHttpProxies', options) command.response_representation = Google::Apis::ComputeAlpha::TargetHttpProxyAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetHttpProxyAggregatedList @@ -30179,6 +31397,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -30327,36 +31546,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -30376,7 +31598,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_target_http_proxies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_target_http_proxies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/targetHttpProxies', options) command.response_representation = Google::Apis::ComputeAlpha::TargetHttpProxyList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetHttpProxyList @@ -30385,6 +31607,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -30489,19 +31712,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -30511,21 +31734,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -30545,7 +31771,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_target_https_proxy_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_target_https_proxy_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/targetHttpsProxies', options) command.response_representation = Google::Apis::ComputeAlpha::TargetHttpsProxyAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetHttpsProxyAggregatedList @@ -30555,6 +31781,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -30703,36 +31930,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -30752,7 +31982,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_target_https_proxies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_target_https_proxies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/targetHttpsProxies', options) command.response_representation = Google::Apis::ComputeAlpha::TargetHttpsProxyList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetHttpsProxyList @@ -30761,6 +31991,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -31022,19 +32253,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -31044,21 +32275,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -31078,7 +32312,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_target_instance_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_target_instance_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/targetInstances', options) command.response_representation = Google::Apis::ComputeAlpha::TargetInstanceAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetInstanceAggregatedList @@ -31088,6 +32322,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -31247,36 +32482,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -31296,7 +32534,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_target_instances(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_target_instances(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/targetInstances', options) command.response_representation = Google::Apis::ComputeAlpha::TargetInstanceList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetInstanceList @@ -31306,6 +32544,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -31469,19 +32708,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -31491,21 +32730,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -31525,7 +32767,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_target_pool_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_target_pool_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/targetPools', options) command.response_representation = Google::Apis::ComputeAlpha::TargetPoolAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetPoolAggregatedList @@ -31535,6 +32777,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -31736,36 +32979,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -31785,7 +33031,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_target_pools(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_target_pools(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/targetPools', options) command.response_representation = Google::Apis::ComputeAlpha::TargetPoolList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetPoolList @@ -31795,6 +33041,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -32150,36 +33397,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -32199,7 +33449,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_target_ssl_proxies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_target_ssl_proxies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/targetSslProxies', options) command.response_representation = Google::Apis::ComputeAlpha::TargetSslProxyList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetSslProxyList @@ -32208,6 +33458,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -32603,36 +33854,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -32652,7 +33906,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_target_tcp_proxies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_target_tcp_proxies(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/targetTcpProxies', options) command.response_representation = Google::Apis::ComputeAlpha::TargetTcpProxyList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetTcpProxyList @@ -32661,6 +33915,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -32815,19 +34070,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -32837,21 +34092,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -32871,7 +34129,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_target_vpn_gateway_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_target_vpn_gateway_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/targetVpnGateways', options) command.response_representation = Google::Apis::ComputeAlpha::TargetVpnGatewayAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetVpnGatewayAggregatedList @@ -32881,6 +34139,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -33040,36 +34299,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -33089,7 +34351,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_target_vpn_gateways(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_target_vpn_gateways(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/targetVpnGateways', options) command.response_representation = Google::Apis::ComputeAlpha::TargetVpnGatewayList::Representation command.response_class = Google::Apis::ComputeAlpha::TargetVpnGatewayList @@ -33099,6 +34361,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -33210,19 +34473,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -33232,21 +34495,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -33266,7 +34532,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_url_map_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_url_map_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/urlMaps', options) command.response_representation = Google::Apis::ComputeAlpha::UrlMapsAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::UrlMapsAggregatedList @@ -33276,6 +34542,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -33475,36 +34742,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -33524,7 +34794,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_url_maps(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_url_maps(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/urlMaps', options) command.response_representation = Google::Apis::ComputeAlpha::UrlMapList::Representation command.response_class = Google::Apis::ComputeAlpha::UrlMapList @@ -33533,6 +34803,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -33729,19 +35000,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -33751,21 +35022,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -33785,7 +35059,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_vpn_gateway_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_vpn_gateway_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/vpnGateways', options) command.response_representation = Google::Apis::ComputeAlpha::VpnGatewayAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::VpnGatewayAggregatedList @@ -33795,6 +35069,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -33992,36 +35267,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -34041,7 +35319,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_vpn_gateways(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_vpn_gateways(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/vpnGateways', options) command.response_representation = Google::Apis::ComputeAlpha::VpnGatewayList::Representation command.response_class = Google::Apis::ComputeAlpha::VpnGatewayList @@ -34051,6 +35329,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -34161,19 +35440,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -34183,21 +35462,24 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -34217,7 +35499,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_vpn_tunnel_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_vpn_tunnel_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/vpnTunnels', options) command.response_representation = Google::Apis::ComputeAlpha::VpnTunnelAggregatedList::Representation command.response_class = Google::Apis::ComputeAlpha::VpnTunnelAggregatedList @@ -34227,6 +35509,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -34386,36 +35669,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -34435,7 +35721,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_vpn_tunnels(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_vpn_tunnels(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/regions/{region}/vpnTunnels', options) command.response_representation = Google::Apis::ComputeAlpha::VpnTunnelList::Representation command.response_class = Google::Apis::ComputeAlpha::VpnTunnelList @@ -34445,6 +35731,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -34548,6 +35835,414 @@ module Google execute_or_queue_command(command, &block) end + # Deletes the specified InPlaceSnapshot resource. Keep in mind that deleting a + # single inPlaceSnapshot might not necessarily delete all the data on that + # inPlaceSnapshot. If any data on the inPlaceSnapshot that is marked for + # deletion is needed for subsequent inPlaceSnapshots, the data will be moved to + # the next corresponding inPlaceSnapshot. + # For more information, see Deleting inPlaceSnapshots. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] in_place_snapshot + # Name of the InPlaceSnapshot resource to delete. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_zone_in_place_snapshot(project, zone, in_place_snapshot, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, '{project}/zones/{zone}/inPlaceSnapshots/{inPlaceSnapshot}', options) + command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation + command.response_class = Google::Apis::ComputeAlpha::Operation + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['inPlaceSnapshot'] = in_place_snapshot unless in_place_snapshot.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Returns the specified InPlaceSnapshot resource in the specified zone. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] in_place_snapshot + # Name of the InPlaceSnapshot resource to return. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::InPlaceSnapshot] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::InPlaceSnapshot] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_zone_in_place_snapshot(project, zone, in_place_snapshot, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/zones/{zone}/inPlaceSnapshots/{inPlaceSnapshot}', options) + command.response_representation = Google::Apis::ComputeAlpha::InPlaceSnapshot::Representation + command.response_class = Google::Apis::ComputeAlpha::InPlaceSnapshot + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['inPlaceSnapshot'] = in_place_snapshot unless in_place_snapshot.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. May be empty if no such policy + # or resource exists. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] resource + # Name or id of the resource for this request. + # @param [Fixnum] options_requested_policy_version + # Requested IAM Policy version. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_zone_in_place_snapshot_iam_policy(project, zone, resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/zones/{zone}/inPlaceSnapshots/{resource}/getIamPolicy', options) + command.response_representation = Google::Apis::ComputeAlpha::Policy::Representation + command.response_class = Google::Apis::ComputeAlpha::Policy + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['resource'] = resource unless resource.nil? + command.query['optionsRequestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Creates an in-place snapshot in the specified zone. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # Name of the zone for this request. + # @param [Google::Apis::ComputeAlpha::InPlaceSnapshot] in_place_snapshot_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_zone_in_place_snapshot(project, zone, in_place_snapshot_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/zones/{zone}/inPlaceSnapshots', options) + command.request_representation = Google::Apis::ComputeAlpha::InPlaceSnapshot::Representation + command.request_object = in_place_snapshot_object + command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation + command.response_class = Google::Apis::ComputeAlpha::Operation + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the list of InPlaceSnapshot resources contained within the specified + # zone. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] filter + # A filter expression that filters resources listed in the response. The + # expression must specify the field name, a comparison operator, and the value + # that you want to use for filtering. The value must be a string, a number, or a + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. + # For example, if you are filtering Compute Engine instances, you can exclude + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled + # for automatic restarts. You can use filtering on nested fields to filter based + # on resource labels. + # To filter on multiple expressions, provide each separate expression within + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Fixnum] max_results + # The maximum number of results per page that should be returned. If the number + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + # @param [String] order_by + # Sorts list results by a certain order. By default, results are returned in + # alphanumerical order based on the resource name. + # You can also sort results in descending order based on the creation timestamp + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). + # Use this to sort resources like operations so that the newest operation is + # returned first. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. + # @param [String] page_token + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::InPlaceSnapshotList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::InPlaceSnapshotList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_zone_in_place_snapshots(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/zones/{zone}/inPlaceSnapshots', options) + command.response_representation = Google::Apis::ComputeAlpha::InPlaceSnapshotList::Representation + command.response_class = Google::Apis::ComputeAlpha::InPlaceSnapshotList + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.query['filter'] = filter unless filter.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] resource + # Name or id of the resource for this request. + # @param [Google::Apis::ComputeAlpha::ZoneSetPolicyRequest] zone_set_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_zone_in_place_snapshot_iam_policy(project, zone, resource, zone_set_policy_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/zones/{zone}/inPlaceSnapshots/{resource}/setIamPolicy', options) + command.request_representation = Google::Apis::ComputeAlpha::ZoneSetPolicyRequest::Representation + command.request_object = zone_set_policy_request_object + command.response_representation = Google::Apis::ComputeAlpha::Policy::Representation + command.response_class = Google::Apis::ComputeAlpha::Policy + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Sets the labels on a inPlaceSnapshot in the given zone. To learn more about + # labels, read the Labeling Resources documentation. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] resource + # Name or id of the resource for this request. + # @param [Google::Apis::ComputeAlpha::ZoneSetLabelsRequest] zone_set_labels_request_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_zone_in_place_snapshot_labels(project, zone, resource, zone_set_labels_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/zones/{zone}/inPlaceSnapshots/{resource}/setLabels', options) + command.request_representation = Google::Apis::ComputeAlpha::ZoneSetLabelsRequest::Representation + command.request_object = zone_set_labels_request_object + command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation + command.response_class = Google::Apis::ComputeAlpha::Operation + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['resource'] = resource unless resource.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Returns permissions that a caller has on the specified resource. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] resource + # Name or id of the resource for this request. + # @param [Google::Apis::ComputeAlpha::TestPermissionsRequest] test_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::TestPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::TestPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_zone_in_place_snapshot_iam_permissions(project, zone, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/zones/{zone}/inPlaceSnapshots/{resource}/testIamPermissions', options) + command.request_representation = Google::Apis::ComputeAlpha::TestPermissionsRequest::Representation + command.request_object = test_permissions_request_object + command.response_representation = Google::Apis::ComputeAlpha::TestPermissionsResponse::Representation + command.response_class = Google::Apis::ComputeAlpha::TestPermissionsResponse + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Deletes the specified zone-specific Operations resource. # @param [String] project # Project ID for this request. @@ -34633,36 +36328,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -34682,7 +36380,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_zone_operations(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_zone_operations(project, zone, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones/{zone}/operations', options) command.response_representation = Google::Apis::ComputeAlpha::OperationList::Representation command.response_class = Google::Apis::ComputeAlpha::OperationList @@ -34692,23 +36390,24 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Waits for the specified Operation resource to return as DONE or for the + # Waits for the specified Operation resource to return as `DONE` or for the # request to approach the 2 minute deadline, and retrieves the specified - # Operation resource. This method differs from the GET method in that it waits + # Operation resource. This method differs from the `GET` method in that it waits # for no more than the default deadline (2 minutes) and then returns the current - # state of the operation, which might be DONE or still in progress. + # state of the operation, which might be `DONE` or still in progress. # This method is called on a best-effort basis. Specifically: # - In uncommon cases, when the server is overloaded, the request might return # before the default deadline is reached, or might return after zero seconds. # - If the default deadline is reached, there is no guarantee that the operation # is actually done when the method returns. Be prepared to retry if the - # operation is not DONE. + # operation is not `DONE`. # @param [String] project # Project ID for this request. # @param [String] zone @@ -34791,36 +36490,39 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [Boolean] return_partial_success + # Opt-in for partial success behavior which provides partial results in case of + # failure. The default value is false and the logic is the same as today. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -34840,7 +36542,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_zones(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_zones(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/zones', options) command.response_representation = Google::Apis::ComputeAlpha::ZoneList::Representation command.response_class = Google::Apis::ComputeAlpha::ZoneList @@ -34849,6 +36551,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? diff --git a/generated/google/apis/compute_beta.rb b/generated/google/apis/compute_beta.rb index b43b00141..eab109cd1 100644 --- a/generated/google/apis/compute_beta.rb +++ b/generated/google/apis/compute_beta.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/compute/docs/reference/latest/ module ComputeBeta VERSION = 'Beta' - REVISION = '20200120' + REVISION = '20200311' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/compute_beta/classes.rb b/generated/google/apis/compute_beta/classes.rb index 4c592938a..d3cd11795 100644 --- a/generated/google/apis/compute_beta/classes.rb +++ b/generated/google/apis/compute_beta/classes.rb @@ -1228,8 +1228,7 @@ module Google # SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and # the request will fail if you attempt to attach a persistent disk in any other # format than SCSI. Local SSDs can use either NVME or SCSI. For performance - # characteristics of SCSI over NVMe, see Local SSD performance. TODO(b/131765817) - # : Update documentation when NVME is supported. + # characteristics of SCSI over NVMe, see Local SSD performance. # Corresponds to the JSON property `interface` # @return [String] attr_accessor :interface @@ -1251,6 +1250,12 @@ module Google # @return [String] attr_accessor :mode + # Initial State for shielded instance, these are public keys which are safe to + # store in public + # Corresponds to the JSON property `shieldedInstanceInitialState` + # @return [Google::Apis::ComputeBeta::InitialStateConfig] + attr_accessor :shielded_instance_initial_state + # Specifies a valid partial or full URL to an existing Persistent Disk resource. # When creating a new instance, one of initializeParams.sourceImage or # initializeParams.sourceSnapshot or disks.source is required except for local @@ -1287,6 +1292,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @licenses = args[:licenses] if args.key?(:licenses) @mode = args[:mode] if args.key?(:mode) + @shielded_instance_initial_state = args[:shielded_instance_initial_state] if args.key?(:shielded_instance_initial_state) @source = args[:source] if args.key?(:source) @type = args[:type] if args.key?(:type) end @@ -1306,8 +1312,9 @@ module Google attr_accessor :description # Specifies the disk name. If not specified, the default is to use the name of - # the instance. If the disk with the instance name exists already in the given - # zone/region, a new name will be automatically generated. + # the instance. If a disk with the same name already exists in the given region, + # the existing disk is attached to the new instance and the new disk is not + # created. # Corresponds to the JSON property `diskName` # @return [String] attr_accessor :disk_name @@ -1351,6 +1358,12 @@ module Google # @return [Hash] attr_accessor :labels + # Specifies which action to take on instance update with this disk. Default is + # to use the existing disk. + # Corresponds to the JSON property `onUpdateAction` + # @return [String] + attr_accessor :on_update_action + # Resource policies applied to this disk for automatic snapshot creations. # Specified using the full or partial URL. For instance template, specify only # the resource policy name. @@ -1412,6 +1425,7 @@ module Google @disk_type = args[:disk_type] if args.key?(:disk_type) @guest_os_features = args[:guest_os_features] if args.key?(:guest_os_features) @labels = args[:labels] if args.key?(:labels) + @on_update_action = args[:on_update_action] if args.key?(:on_update_action) @resource_policies = args[:resource_policies] if args.key?(:resource_policies) @source_image = args[:source_image] if args.key?(:source_image) @source_image_encryption_key = args[:source_image_encryption_key] if args.key?(:source_image_encryption_key) @@ -1527,8 +1541,8 @@ module Google # Represents an Autoscaler resource. # Google Compute Engine has two Autoscaler resources: - # * [Global](/compute/docs/reference/rest/latest/autoscalers) * [Regional](/ - # compute/docs/reference/rest/latest/regionAutoscalers) + # * [Global](/compute/docs/reference/rest/`$api_version`/autoscalers) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionAutoscalers) # Use autoscalers to automatically add or delete instances from a managed # instance group according to your defined autoscaling policy. For more # information, read Autoscaling Groups of Instances. @@ -2257,39 +2271,11 @@ module Google # @return [Google::Apis::ComputeBeta::FixedOrPercent] attr_accessor :max_scaled_down_replicas - # A Duration represents a signed, fixed-length span of time represented as a - # count of seconds and fractions of seconds at nanosecond resolution. It is - # independent of any calendar and concepts like "day" or "month". It is related - # to Timestamp in that the difference between two Timestamp values is a Duration - # and it can be added or subtracted from a Timestamp. Range is approximately +- - # 10,000 years. - # # Examples - # Example 1: Compute Duration from two Timestamps in pseudo code. - # Timestamp start = ...; Timestamp end = ...; Duration duration = ...; - # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - - # start.nanos; - # if (duration.seconds 0) ` duration.seconds += 1; duration.nanos -= 1000000000; - # ` else if (duration.seconds > 0 && duration.nanos < 0) ` duration.seconds -= - # 1; duration.nanos += 1000000000; ` - # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. - # Timestamp start = ...; Duration duration = ...; Timestamp end = ...; - # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + - # duration.nanos; - # if (end.nanos = 1000000000) ` end.seconds += 1; end.nanos -= 1000000000; ` - # Example 3: Compute Duration from datetime.timedelta in Python. - # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration. - # FromTimedelta(td) - # # JSON Mapping - # In JSON format, the Duration type is encoded as a string rather than an object, - # where the string ends in the suffix "s" (indicating seconds) and is preceded - # by the number of seconds, with nanoseconds expressed as fractional seconds. - # For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as " - # 3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3. - # 000000001s", and 3 seconds and 1 microsecond should be expressed in JSON - # format as "3.000001s". - # Corresponds to the JSON property `timeWindow` - # @return [Google::Apis::ComputeBeta::GoogleDuration] - attr_accessor :time_window + # How long back autoscaling should look when computing recommendations to + # include directives regarding slower scale down, as described above. + # Corresponds to the JSON property `timeWindowSec` + # @return [Fixnum] + attr_accessor :time_window_sec def initialize(**args) update!(**args) @@ -2298,7 +2284,7 @@ module Google # Update properties of this object def update!(**args) @max_scaled_down_replicas = args[:max_scaled_down_replicas] if args.key?(:max_scaled_down_replicas) - @time_window = args[:time_window] if args.key?(:time_window) + @time_window_sec = args[:time_window_sec] if args.key?(:time_window_sec) end end @@ -2317,8 +2303,8 @@ module Google # service is SSL, TCP, or UDP. # If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and # TCP Proxy load balancers), you must also specify exactly one of the following - # parameters: maxConnections, maxConnectionsPerInstance, or - # maxConnectionsPerEndpoint. + # parameters: maxConnections (except for regional managed instance groups), + # maxConnectionsPerInstance, or maxConnectionsPerEndpoint. # If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/ # UDP load balancers), you cannot specify any additional parameters. # @@ -2326,10 +2312,11 @@ module Google # HTTP requests per second (RPS). # You can use the RATE balancing mode if the protocol for the backend service is # HTTP or HTTPS. You must specify exactly one of the following parameters: - # maxRate, maxRatePerInstance, or maxRatePerEndpoint. + # maxRate (except for regional managed instance groups), maxRatePerInstance, or + # maxRatePerEndpoint. # # - If the load balancing mode is UTILIZATION, the load is spread based on the - # CPU utilization of instances in an instance group. + # backend utilization of instances in an instance group. # You can use the UTILIZATION balancing mode if the loadBalancingScheme of the # backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and # the backends are instance groups. There are no restrictions on the backend @@ -2379,12 +2366,13 @@ module Google # @return [String] attr_accessor :group - # Defines a maximum target for simultaneous connections for the entire backend ( - # instance group or NEG). If the backend's balancingMode is UTILIZATION, this is - # an optional parameter. If the backend's balancingMode is CONNECTION, and - # backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, - # you must specify either this parameter, maxConnectionsPerInstance, or - # maxConnectionsPerEndpoint. + # Defines a target maximum number of simultaneous connections that the backend + # can handle. Valid for network endpoint group and instance group backends ( + # except for regional managed instance groups). If the backend's balancingMode + # is UTILIZATION, this is an optional parameter. If the backend's balancingMode + # is CONNECTION, and backend is attached to a backend service whose + # loadBalancingScheme is EXTERNAL, you must specify either this parameter, + # maxConnectionsPerInstance, or maxConnectionsPerEndpoint. # Not available if the backend's balancingMode is RATE. If the # loadBalancingScheme is INTERNAL, then maxConnections is not supported, even # though the backend requires a balancing mode of CONNECTION. @@ -2392,8 +2380,8 @@ module Google # @return [Fixnum] attr_accessor :max_connections - # Defines a maximum target for simultaneous connections for an endpoint of a NEG. - # This is multiplied by the number of endpoints in the NEG to implicitly + # Defines a target maximum number of simultaneous connections for an endpoint of + # a NEG. This is multiplied by the number of endpoints in the NEG to implicitly # calculate a maximum number of target maximum simultaneous connections for the # NEG. If the backend's balancingMode is CONNECTION, and the backend is attached # to a backend service whose loadBalancingScheme is EXTERNAL, you must specify @@ -2405,8 +2393,8 @@ module Google # @return [Fixnum] attr_accessor :max_connections_per_endpoint - # Defines a maximum target for simultaneous connections for a single VM in a - # backend instance group. This is multiplied by the number of instances in the + # Defines a target maximum number of simultaneous connections for a single VM in + # a backend instance group. This is multiplied by the number of instances in the # instance group to implicitly calculate a target maximum number of simultaneous # connections for the whole instance group. If the backend's balancingMode is # UTILIZATION, this is an optional parameter. If the backend's balancingMode is @@ -2420,10 +2408,15 @@ module Google # @return [Fixnum] attr_accessor :max_connections_per_instance - # The max requests per second (RPS) of the group. Can be used with either RATE - # or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, - # either maxRate or maxRatePerInstance must be set. - # This cannot be used for internal load balancing. + # Defines a maximum number of HTTP requests per second (RPS) that the backend + # can handle. Valid for network endpoint group and instance group backends ( + # except for regional managed instance groups). Must not be defined if the + # backend is a managed instance group that uses autoscaling based on load + # balancing. + # If the backend's balancingMode is UTILIZATION, this is an optional parameter. + # If the backend's balancingMode is RATE, you must specify maxRate, + # maxRatePerInstance, or maxRatePerEndpoint. + # Not available if the backend's balancingMode is CONNECTION. # Corresponds to the JSON property `maxRate` # @return [Fixnum] attr_accessor :max_rate @@ -2432,7 +2425,7 @@ module Google # NEG. This is multiplied by the number of endpoints in the NEG to implicitly # calculate a target maximum rate for the NEG. # If the backend's balancingMode is RATE, you must specify either this parameter, - # maxRate, or maxRatePerInstance. + # maxRate (except for regional managed instance groups), or maxRatePerInstance. # Not available if the backend's balancingMode is CONNECTION. # Corresponds to the JSON property `maxRatePerEndpoint` # @return [Float] @@ -2444,17 +2437,18 @@ module Google # instance group. # If the backend's balancingMode is UTILIZATION, this is an optional parameter. # If the backend's balancingMode is RATE, you must specify either this parameter, - # maxRate, or maxRatePerEndpoint. + # maxRate (except for regional managed instance groups), or maxRatePerEndpoint. # Not available if the backend's balancingMode is CONNECTION. # Corresponds to the JSON property `maxRatePerInstance` # @return [Float] attr_accessor :max_rate_per_instance - # Defines the maximum average CPU utilization of a backend VM in an instance + # Defines the maximum average backend utilization of a backend VM in an instance # group. The valid range is [0.0, 1.0]. This is an optional parameter if the # backend's balancingMode is UTILIZATION. # This parameter can be used in conjunction with maxRate, maxRatePerInstance, - # maxConnections, or maxConnectionsPerInstance. + # maxConnections (except for regional managed instance groups), or + # maxConnectionsPerInstance. # Corresponds to the JSON property `maxUtilization` # @return [Float] attr_accessor :max_utilization @@ -2709,8 +2703,8 @@ module Google # balancing services. # Backend services in Google Compute Engine can be either regionally or globally # scoped. - # * [Global](/compute/docs/reference/rest/latest/backendServices) * [Regional](/ - # compute/docs/reference/rest/latest/regionBackendServices) + # * [Global](/compute/docs/reference/rest/`$api_version`/backendServices) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionBackendServices) # For more information, read Backend Services. # (== resource_for `$api_version`.backendService ==) class BackendService @@ -2770,8 +2764,13 @@ module Google attr_accessor :enable_cdn alias_method :enable_cdn?, :enable_cdn - # Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at - # least one backend instance group to be defined as a backup (failover) backend. + # Applicable only to Failover for Internal TCP/UDP Load Balancing. On failover + # or failback, this field indicates whether connection draining will be honored. + # GCP has a fixed connection draining timeout of 10 minutes. A setting of true + # terminates existing TCP connections to the active pool during failover and + # failback, immediately draining traffic. A setting of false allows existing TCP + # connections to persist, even on VMs no longer in the active pool, for up to + # the duration of the connection draining timeout (10 minutes). # Corresponds to the JSON property `failoverPolicy` # @return [Google::Apis::ComputeBeta::BackendServiceFailoverPolicy] attr_accessor :failover_policy @@ -2788,15 +2787,13 @@ module Google # @return [String] attr_accessor :fingerprint - # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for - # health checking this BackendService. Currently at most one health check can be - # specified. Health check is optional for Compute Engine backend services if - # there is no backend. A health check must not be specified when adding Internet - # Network Endpoint Group or Serverless Network Endpoint Group as backends. In - # all other cases, a health check is required for Compute Engine backend - # services. - # For internal load balancing, a URL to a HealthCheck resource must be specified - # instead. + # The list of URLs to the healthChecks, httpHealthChecks (legacy), or + # httpsHealthChecks (legacy) resource for health checking this backend service. + # Not all backend services support legacy health checks. See Load balancer + # guide. Currently at most one health check can be specified. Backend services + # with instance group or zonal NEG backends must have a health check. Backend + # services with internet NEG backends must not have a health check. A health + # check must # Corresponds to the JSON property `healthChecks` # @return [Array] attr_accessor :health_checks @@ -2895,9 +2892,9 @@ module Google # A named port on a backend instance group representing the port for # communication to the backend VMs in that group. Required when the - # loadBalancingScheme is EXTERNAL and the backends are instance groups. The - # named port must be defined on each backend instance group. This parameter has - # no meaning if the backends are NEGs. + # loadBalancingScheme is EXTERNAL, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED + # and the backends are instance groups. The named port must be defined on each + # backend instance group. This parameter has no meaning if the backends are NEGs. # Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP # Load Blaancing). # Corresponds to the JSON property `portName` @@ -2905,7 +2902,7 @@ module Google attr_accessor :port_name # The protocol this BackendService uses to communicate with backends. - # Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP, depending on the + # Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP. depending on the # chosen load balancer or Traffic Director configuration. Refer to the # documentation for the load balancer or for Traffic Director for more # information. @@ -2927,6 +2924,11 @@ module Google # @return [String] attr_accessor :security_policy + # The authentication and authorization settings for a BackendService. + # Corresponds to the JSON property `securitySettings` + # @return [Google::Apis::ComputeBeta::SecuritySettings] + attr_accessor :security_settings + # [Output Only] Server-defined URL for the resource. # Corresponds to the JSON property `selfLink` # @return [String] @@ -2986,6 +2988,7 @@ module Google @protocol = args[:protocol] if args.key?(:protocol) @region = args[:region] if args.key?(:region) @security_policy = args[:security_policy] if args.key?(:security_policy) + @security_settings = args[:security_settings] if args.key?(:security_settings) @self_link = args[:self_link] if args.key?(:self_link) @session_affinity = args[:session_affinity] if args.key?(:session_affinity) @timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec) @@ -3147,7 +3150,13 @@ module Google end end - # + # Applicable only to Failover for Internal TCP/UDP Load Balancing. On failover + # or failback, this field indicates whether connection draining will be honored. + # GCP has a fixed connection draining timeout of 10 minutes. A setting of true + # terminates existing TCP connections to the active pool during failover and + # failback, immediately draining traffic. A setting of false allows existing TCP + # connections to persist, even on VMs no longer in the active pool, for up to + # the duration of the connection draining timeout (10 minutes). class BackendServiceFailoverPolicy include Google::Apis::Core::Hashable @@ -4786,8 +4795,8 @@ module Google # Represents a Persistent Disk resource. # Google Compute Engine has two Disk resources: - # * [Global](/compute/docs/reference/rest/latest/disks) * [Regional](/compute/ - # docs/reference/rest/latest/regionDisks) + # * [Zonal](/compute/docs/reference/rest/`$api_version`/disks) * [Regional](/ + # compute/docs/reference/rest/`$api_version`/regionDisks) # Persistent disks are required for running your VM instances. Create both boot # and non-boot (data) persistent disks. For more information, read Persistent # Disks. For more storage options, read Storage options. @@ -5388,8 +5397,8 @@ module Google # Represents a Disk Type resource. # Google Compute Engine has two Disk Type resources: - # * [Global](/compute/docs/reference/rest/latest/diskTypes) * [Regional](/ - # compute/docs/reference/rest/latest/regionDiskTypes) + # * [Regional](/compute/docs/reference/rest/`$api_version`/regionDiskTypes) * [ + # Zonal](/compute/docs/reference/rest/`$api_version`/diskTypes) # You can choose from a variety of disk types based on your needs. For more # information, read Storage options. # The diskTypes resource represents disk types for a zonal persistent disk. For @@ -6522,6 +6531,32 @@ module Google end end + # + class FileContentBuffer + include Google::Apis::Core::Hashable + + # The raw content in the secure keys file. + # Corresponds to the JSON property `content` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :content + + # + # Corresponds to the JSON property `fileType` + # @return [String] + attr_accessor :file_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content = args[:content] if args.key?(:content) + @file_type = args[:file_type] if args.key?(:file_type) + end + end + # Represents a Firewall Rule resource. # Firewall rules allow or deny ingress traffic to, and egress traffic from your # instances. For more information, read Firewall rules. @@ -6976,8 +7011,8 @@ module Google # Represents a Forwarding Rule resource. # Forwarding rule resources in GCP can be either regional or global in scope: - # * [Global](/compute/docs/reference/rest/latest/globalForwardingRules) * [ - # Regional](/compute/docs/reference/rest/latest/forwardingRules) + # * [Global](/compute/docs/reference/rest/`$api_version`/globalForwardingRules) * + # [Regional](/compute/docs/reference/rest/`$api_version`/forwardingRules) # A forwarding rule and its corresponding IP address represent the frontend # configuration of a Google Cloud Platform load balancer. Forwarding rules can # also reference target instances and Cloud VPN Classic gateways ( @@ -7133,7 +7168,7 @@ module Google # - Internal TCP/UDP load balancers # - INTERNAL_MANAGED is used for: # - Internal HTTP(S) load balancers - # - >INTERNAL_SELF_MANAGED is used for: + # - INTERNAL_SELF_MANAGED is used for: # - Traffic Director # For more information about forwarding rules, refer to Forwarding rule concepts. # Corresponds to the JSON property `loadBalancingScheme` @@ -7178,7 +7213,7 @@ module Google attr_accessor :network # This signifies the networking tier used for configuring this load balancer and - # can only take the following values: PREMIUM , STANDARD. + # can only take the following values: PREMIUM, STANDARD. # For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For # GlobalForwardingRule, the valid value is PREMIUM. # If this field is not specified, it is assumed to be PREMIUM. If IPAddress is @@ -7791,66 +7826,6 @@ module Google end end - # A Duration represents a signed, fixed-length span of time represented as a - # count of seconds and fractions of seconds at nanosecond resolution. It is - # independent of any calendar and concepts like "day" or "month". It is related - # to Timestamp in that the difference between two Timestamp values is a Duration - # and it can be added or subtracted from a Timestamp. Range is approximately +- - # 10,000 years. - # # Examples - # Example 1: Compute Duration from two Timestamps in pseudo code. - # Timestamp start = ...; Timestamp end = ...; Duration duration = ...; - # duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - - # start.nanos; - # if (duration.seconds 0) ` duration.seconds += 1; duration.nanos -= 1000000000; - # ` else if (duration.seconds > 0 && duration.nanos < 0) ` duration.seconds -= - # 1; duration.nanos += 1000000000; ` - # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. - # Timestamp start = ...; Duration duration = ...; Timestamp end = ...; - # end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + - # duration.nanos; - # if (end.nanos = 1000000000) ` end.seconds += 1; end.nanos -= 1000000000; ` - # Example 3: Compute Duration from datetime.timedelta in Python. - # td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration. - # FromTimedelta(td) - # # JSON Mapping - # In JSON format, the Duration type is encoded as a string rather than an object, - # where the string ends in the suffix "s" (indicating seconds) and is preceded - # by the number of seconds, with nanoseconds expressed as fractional seconds. - # For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as " - # 3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3. - # 000000001s", and 3 seconds and 1 microsecond should be expressed in JSON - # format as "3.000001s". - class GoogleDuration - include Google::Apis::Core::Hashable - - # Signed fractions of a second at nanosecond resolution of the span of time. - # Durations less than one second are represented with a 0 `seconds` field and a - # positive or negative `nanos` field. For durations of one second or more, a non- - # zero value for the `nanos` field must be of the same sign as the `seconds` - # field. Must be from -999,999,999 to +999,999,999 inclusive. - # Corresponds to the JSON property `nanos` - # @return [Fixnum] - attr_accessor :nanos - - # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576, - # 000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/ - # hr * 24 hr/day * 365.25 days/year * 10000 years - # Corresponds to the JSON property `seconds` - # @return [Fixnum] - attr_accessor :seconds - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @nanos = args[:nanos] if args.key?(:nanos) - @seconds = args[:seconds] if args.key?(:seconds) - end - end - # A guest attributes entry. class GuestAttributes include Google::Apis::Core::Hashable @@ -8184,8 +8159,8 @@ module Google # Represents a Health Check resource. # Google Compute Engine has two Health Check resources: - # * [Global](/compute/docs/reference/rest/latest/healthChecks) * [Regional](/ - # compute/docs/reference/rest/latest/regionHealthChecks) + # * [Global](/compute/docs/reference/rest/`$api_version`/healthChecks) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionHealthChecks) # Internal HTTP(S) load balancers use regional health checks. All other types of # GCP load balancers and managed instance group auto-healing use global health # checks. For more information, read Health Check Concepts. @@ -8623,6 +8598,31 @@ module Google end end + # A full or valid partial URL to a health check service. For example, the + # following are valid URLs: + # - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/ + # healthCheckServices/health-check-service + # - projects/project-id/regions/us-west1/healthCheckServices/health-check- + # service + # - regions/us-west1/healthCheckServices/health-check-service + class HealthCheckServiceReference + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `healthCheckService` + # @return [String] + attr_accessor :health_check_service + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @health_check_service = args[:health_check_service] if args.key?(:health_check_service) + end + end + # class HealthCheckServicesList include Google::Apis::Core::Hashable @@ -9019,6 +9019,17 @@ module Google # @return [Google::Apis::ComputeBeta::HealthCheckReference] attr_accessor :health_check + # A full or valid partial URL to a health check service. For example, the + # following are valid URLs: + # - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/ + # healthCheckServices/health-check-service + # - projects/project-id/regions/us-west1/healthCheckServices/health-check- + # service + # - regions/us-west1/healthCheckServices/health-check-service + # Corresponds to the JSON property `healthCheckService` + # @return [Google::Apis::ComputeBeta::HealthCheckServiceReference] + attr_accessor :health_check_service + # Health state of the network endpoint determined based on the health checks # configured. # Corresponds to the JSON property `healthState` @@ -9034,6 +9045,7 @@ module Google @backend_service = args[:backend_service] if args.key?(:backend_service) @forwarding_rule = args[:forwarding_rule] if args.key?(:forwarding_rule) @health_check = args[:health_check] if args.key?(:health_check) + @health_check_service = args[:health_check_service] if args.key?(:health_check_service) @health_state = args[:health_state] if args.key?(:health_state) end end @@ -9049,9 +9061,10 @@ module Google # @return [String] attr_accessor :description - # The list of host patterns to match. They must be valid hostnames, except * - # will match any string of ([a-z0-9-.]*). In that case, * must be the first - # character and must be followed in the pattern by either - or .. + # The list of host patterns to match. They must be valid hostnames with optional + # port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). + # In that case, * must be the first character and must be followed in the + # pattern by either - or .. # Corresponds to the JSON property `hosts` # @return [Array] attr_accessor :hosts @@ -10318,6 +10331,12 @@ module Google # @return [String] attr_accessor :self_link + # Initial State for shielded instance, these are public keys which are safe to + # store in public + # Corresponds to the JSON property `shieldedInstanceInitialState` + # @return [Google::Apis::ComputeBeta::InitialStateConfig] + attr_accessor :shielded_instance_initial_state + # URL of the source disk used to create this image. This can be a full or valid # partial URL. You must provide either this property or the rawDisk.source # property but not both to create an image. For example, the following are valid @@ -10427,6 +10446,7 @@ module Google @name = args[:name] if args.key?(:name) @raw_disk = args[:raw_disk] if args.key?(:raw_disk) @self_link = args[:self_link] if args.key?(:self_link) + @shielded_instance_initial_state = args[:shielded_instance_initial_state] if args.key?(:shielded_instance_initial_state) @source_disk = args[:source_disk] if args.key?(:source_disk) @source_disk_encryption_key = args[:source_disk_encryption_key] if args.key?(:source_disk_encryption_key) @source_disk_id = args[:source_disk_id] if args.key?(:source_disk_id) @@ -10594,6 +10614,44 @@ module Google end end + # Initial State for shielded instance, these are public keys which are safe to + # store in public + class InitialStateConfig + include Google::Apis::Core::Hashable + + # The Key Database (db). + # Corresponds to the JSON property `dbs` + # @return [Array] + attr_accessor :dbs + + # The forbidden key database (dbx). + # Corresponds to the JSON property `dbxs` + # @return [Array] + attr_accessor :dbxs + + # The Key Exchange Key (KEK). + # Corresponds to the JSON property `keks` + # @return [Array] + attr_accessor :keks + + # The Platform Key (PK). + # Corresponds to the JSON property `pk` + # @return [Google::Apis::ComputeBeta::FileContentBuffer] + attr_accessor :pk + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dbs = args[:dbs] if args.key?(:dbs) + @dbxs = args[:dbxs] if args.key?(:dbxs) + @keks = args[:keks] if args.key?(:keks) + @pk = args[:pk] if args.key?(:pk) + end + end + # Represents an Instance resource. # An instance is a virtual machine that is hosted on Google Cloud Platform. For # more information, read Virtual Machine Instances. (== resource_for `$ @@ -10649,6 +10707,17 @@ module Google attr_accessor :erase_windows_vss_signature alias_method :erase_windows_vss_signature?, :erase_windows_vss_signature + # Specifies a fingerprint for this resource, which is essentially a hash of the + # instance's contents and used for optimistic locking. The fingerprint is + # initially generated by Compute Engine and changes after every request to + # modify or update the instance. You must always provide an up-to-date + # fingerprint hash in order to update the instance. + # To see the latest fingerprint, make get() request to the instance. + # Corresponds to the JSON property `fingerprint` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :fingerprint + # A list of the type and count of accelerator cards attached to the instance. # Corresponds to the JSON property `guestAccelerators` # @return [Array] @@ -10737,6 +10806,12 @@ module Google # @return [Array] attr_accessor :network_interfaces + # The private IPv6 google access type for the VM. If not specified, use + # INHERIT_FROM_SUBNETWORK as default. + # Corresponds to the JSON property `privateIpv6GoogleAccess` + # @return [String] + attr_accessor :private_ipv6_google_access + # Specifies the reservations that this instance can consume from. # Corresponds to the JSON property `reservationAffinity` # @return [Google::Apis::ComputeBeta::ReservationAffinity] @@ -10747,7 +10822,7 @@ module Google # @return [Array] attr_accessor :resource_policies - # Sets the scheduling options for an Instance. NextID: 9 + # Sets the scheduling options for an Instance. NextID: 10 # Corresponds to the JSON property `scheduling` # @return [Google::Apis::ComputeBeta::Scheduling] attr_accessor :scheduling @@ -10843,6 +10918,7 @@ module Google @disks = args[:disks] if args.key?(:disks) @display_device = args[:display_device] if args.key?(:display_device) @erase_windows_vss_signature = args[:erase_windows_vss_signature] if args.key?(:erase_windows_vss_signature) + @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators) @hostname = args[:hostname] if args.key?(:hostname) @id = args[:id] if args.key?(:id) @@ -10854,6 +10930,7 @@ module Google @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform) @name = args[:name] if args.key?(:name) @network_interfaces = args[:network_interfaces] if args.key?(:network_interfaces) + @private_ipv6_google_access = args[:private_ipv6_google_access] if args.key?(:private_ipv6_google_access) @reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity) @resource_policies = args[:resource_policies] if args.key?(:resource_policies) @scheduling = args[:scheduling] if args.key?(:scheduling) @@ -12006,10 +12083,22 @@ module Google class InstanceGroupManagerStatusStateful include Google::Apis::Core::Hashable - # [Output Only] A bit indicating whether the managed instance group is stateful, - # i.e. has any disks in Stateful Policy or at least one per-instance config. - # This is determined based on the user intent, the group may be reported as not - # stateful even when there is still some preserved state on managed instances. + # [Output Only] A bit indicating whether the managed instance group has stateful + # configuration, that is, if you have configured any items in a stateful policy + # or in per-instance configs. The group might report that it has no stateful + # config even when there is still some preserved state on a managed instance, + # for example, if you have deleted all PICs but not yet applied those deletions. + # Corresponds to the JSON property `hasStatefulConfig` + # @return [Boolean] + attr_accessor :has_stateful_config + alias_method :has_stateful_config?, :has_stateful_config + + # [Output Only] A bit indicating whether the managed instance group has stateful + # configuration, that is, if you have configured any items in a stateful policy + # or in per-instance configs. The group might report that it has no stateful + # config even when there is still some preserved state on a managed instance, + # for example, if you have deleted all PICs but not yet applied those deletions. + # This field is deprecated in favor of has_stateful_config. # Corresponds to the JSON property `isStateful` # @return [Boolean] attr_accessor :is_stateful @@ -12021,6 +12110,7 @@ module Google # Update properties of this object def update!(**args) + @has_stateful_config = args[:has_stateful_config] if args.key?(:has_stateful_config) @is_stateful = args[:is_stateful] if args.key?(:is_stateful) end end @@ -13435,18 +13525,24 @@ module Google # @return [Array] attr_accessor :network_interfaces + # The private IPv6 google access type for the VM. If not specified, use + # INHERIT_FROM_SUBNETWORK as default. + # Corresponds to the JSON property `privateIpv6GoogleAccess` + # @return [String] + attr_accessor :private_ipv6_google_access + # Specifies the reservations that this instance can consume from. # Corresponds to the JSON property `reservationAffinity` # @return [Google::Apis::ComputeBeta::ReservationAffinity] attr_accessor :reservation_affinity # Resource policies (names, not ULRs) applied to instances created from this - # templae. + # template. # Corresponds to the JSON property `resourcePolicies` # @return [Array] attr_accessor :resource_policies - # Sets the scheduling options for an Instance. NextID: 9 + # Sets the scheduling options for an Instance. NextID: 10 # Corresponds to the JSON property `scheduling` # @return [Google::Apis::ComputeBeta::Scheduling] attr_accessor :scheduling @@ -13489,6 +13585,7 @@ module Google @metadata = args[:metadata] if args.key?(:metadata) @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform) @network_interfaces = args[:network_interfaces] if args.key?(:network_interfaces) + @private_ipv6_google_access = args[:private_ipv6_google_access] if args.key?(:private_ipv6_google_access) @reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity) @resource_policies = args[:resource_policies] if args.key?(:resource_policies) @scheduling = args[:scheduling] if args.key?(:scheduling) @@ -13752,6 +13849,95 @@ module Google end end + # + class InstancesAddResourcePoliciesRequest + include Google::Apis::Core::Hashable + + # Resource policies to be added to this instance. + # Corresponds to the JSON property `resourcePolicies` + # @return [Array] + attr_accessor :resource_policies + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_policies = args[:resource_policies] if args.key?(:resource_policies) + end + end + + # + class InstancesGetEffectiveFirewallsResponse + include Google::Apis::Core::Hashable + + # Effective firewalls on the instance. + # Corresponds to the JSON property `firewalls` + # @return [Array] + attr_accessor :firewalls + + # Effective firewalls from organization policies. + # Corresponds to the JSON property `organizationFirewalls` + # @return [Array] + attr_accessor :organization_firewalls + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @firewalls = args[:firewalls] if args.key?(:firewalls) + @organization_firewalls = args[:organization_firewalls] if args.key?(:organization_firewalls) + end + end + + # A pruned SecurityPolicy containing ID and any applicable firewall rules. + class InstancesGetEffectiveFirewallsResponseOrganizationFirewallPolicy + include Google::Apis::Core::Hashable + + # The unique identifier for the security policy. This identifier is defined by + # the server. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # The rules that apply to the network. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @rules = args[:rules] if args.key?(:rules) + end + end + + # + class InstancesRemoveResourcePoliciesRequest + include Google::Apis::Core::Hashable + + # Resource policies to be removed from this instance. + # Corresponds to the JSON property `resourcePolicies` + # @return [Array] + attr_accessor :resource_policies + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_policies = args[:resource_policies] if args.key?(:resource_policies) + end + end + # class InstancesResumeRequest include Google::Apis::Core::Hashable @@ -15612,7 +15798,11 @@ module Google end end - # A license resource. + # Represents a License resource. + # A License represents billing and aggregate usage data for public and + # marketplace images. Caution This resource is intended for use only by third- + # party partners who are creating Cloud Marketplace images. (== resource_for `$ + # api_version`.licenses ==) class License include Google::Apis::Core::Hashable @@ -15693,7 +15883,11 @@ module Google end end - # + # Represents a License Code resource. + # A License Code is a unique identifier used to represent a license resource. + # Caution This resource is intended for use only by third-party partners who are + # creating Cloud Marketplace images. (== resource_for `$api_version`. + # licenseCodes ==) class LicenseCode include Google::Apis::Core::Hashable @@ -15951,8 +16145,6 @@ module Google # Examples: counter ` metric: "/debug_access_count" field: "iam_principal" ` ==> # increment counter /iam/policy/debug_access_count `iam_principal=[value of # IAMContext.principal]` - # TODO(b/141846426): Consider supporting "authority" and "iam_principal" fields - # in the same counter. # Corresponds to the JSON property `counter` # @return [Google::Apis::ComputeBeta::LogConfigCounterOptions] attr_accessor :counter @@ -16013,8 +16205,6 @@ module Google # Examples: counter ` metric: "/debug_access_count" field: "iam_principal" ` ==> # increment counter /iam/policy/debug_access_count `iam_principal=[value of # IAMContext.principal]` - # TODO(b/141846426): Consider supporting "authority" and "iam_principal" fields - # in the same counter. class LogConfigCounterOptions include Google::Apis::Core::Hashable @@ -16078,7 +16268,9 @@ module Google include Google::Apis::Core::Hashable # Whether Gin logging should happen in a fail-closed manner at the caller. This - # is relevant only in the LocalIAM implementation, for now. + # is currently supported in the LocalIAM implementation, Stubby C++, and Stubby + # Java. For Apps Framework, see go/af-audit-logging#failclosed. TODO(b/77591626): + # Add support for Stubby Go. TODO(b/129671387): Add support for Scaffolding. # Corresponds to the JSON property `logMode` # @return [String] attr_accessor :log_mode @@ -17304,8 +17496,8 @@ module Google end # Represents a collection of network endpoints. - # For more information read Setting up network endpoint groups in load balancing. - # (== resource_for `$api_version`.networkEndpointGroups ==) Next ID: 21 + # For more information read Network endpoint groups overview. (== resource_for `$ + # api_version`.networkEndpointGroups ==) Next ID: 21 class NetworkEndpointGroup include Google::Apis::Core::Hashable @@ -17364,8 +17556,7 @@ module Google # @return [String] attr_accessor :network - # Type of network endpoints in this network endpoint group. Currently the only - # supported value is GCE_VM_IP_PORT. + # Type of network endpoints in this network endpoint group. # Corresponds to the JSON property `networkEndpointType` # @return [String] attr_accessor :network_endpoint_type @@ -18368,6 +18559,57 @@ module Google end end + # + class NetworksGetEffectiveFirewallsResponse + include Google::Apis::Core::Hashable + + # Effective firewalls on the network. + # Corresponds to the JSON property `firewalls` + # @return [Array] + attr_accessor :firewalls + + # Effective firewalls from organization policies. + # Corresponds to the JSON property `organizationFirewalls` + # @return [Array] + attr_accessor :organization_firewalls + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @firewalls = args[:firewalls] if args.key?(:firewalls) + @organization_firewalls = args[:organization_firewalls] if args.key?(:organization_firewalls) + end + end + + # A pruned SecurityPolicy containing ID and any applicable firewall rules. + class NetworksGetEffectiveFirewallsResponseOrganizationFirewallPolicy + include Google::Apis::Core::Hashable + + # [Output Only] The unique identifier for the security policy. This identifier + # is defined by the server. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # The rules that apply to the network. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @rules = args[:rules] if args.key?(:rules) + end + end + # class NetworksRemovePeeringRequest include Google::Apis::Core::Hashable @@ -18787,6 +19029,11 @@ module Google class NodeGroupNode include Google::Apis::Core::Hashable + # CPU overcommit. + # Corresponds to the JSON property `cpuOvercommitType` + # @return [String] + attr_accessor :cpu_overcommit_type + # Instances scheduled on this node. # Corresponds to the JSON property `instances` # @return [Array] @@ -18823,6 +19070,7 @@ module Google # Update properties of this object def update!(**args) + @cpu_overcommit_type = args[:cpu_overcommit_type] if args.key?(:cpu_overcommit_type) @instances = args[:instances] if args.key?(:instances) @name = args[:name] if args.key?(:name) @node_type = args[:node_type] if args.key?(:node_type) @@ -19102,10 +19350,15 @@ module Google # Represent a sole-tenant Node Template resource. # You can use a template to define properties for nodes in a node group. For # more information, read Creating node groups and instances. (== resource_for `$ - # api_version`.nodeTemplates ==) (== NextID: 18 ==) + # api_version`.nodeTemplates ==) (== NextID: 19 ==) class NodeTemplate include Google::Apis::Core::Hashable + # CPU overcommit. + # Corresponds to the JSON property `cpuOvercommitType` + # @return [String] + attr_accessor :cpu_overcommit_type + # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] @@ -19196,6 +19449,7 @@ module Google # Update properties of this object def update!(**args) + @cpu_overcommit_type = args[:cpu_overcommit_type] if args.key?(:cpu_overcommit_type) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @@ -20237,15 +20491,15 @@ module Google # Represents an Operation resource. # Google Compute Engine has three Operation resources: - # * [Global](/compute/docs/reference/rest/latest/globalOperations) * [Regional](/ - # compute/docs/reference/rest/latest/regionOperations) * [Zonal](/compute/docs/ - # reference/rest/latest/zoneOperations) + # * [Global](/compute/docs/reference/rest/`$api_version`/globalOperations) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionOperations) * [ + # Zonal](/compute/docs/reference/rest/`$api_version`/zoneOperations) # You can use an operation resource to manage asynchronous API requests. For # more information, read Handling API responses. # Operations can be global, regional or zonal. - # - For global operations, use the globalOperations resource. - # - For regional operations, use the regionOperations resource. - # - For zonal operations, use the zonalOperations resource. + # - For global operations, use the `globalOperations` resource. + # - For regional operations, use the `regionOperations` resource. + # - For zonal operations, use the `zonalOperations` resource. # For more information, read Global, Regional, and Zonal Resources. (== # resource_for `$api_version`.globalOperations ==) (== resource_for `$ # api_version`.regionOperations ==) (== resource_for `$api_version`. @@ -20283,13 +20537,13 @@ module Google attr_accessor :error # [Output Only] If the operation fails, this field contains the HTTP error - # message that was returned, such as NOT FOUND. + # message that was returned, such as `NOT FOUND`. # Corresponds to the JSON property `httpErrorMessage` # @return [String] attr_accessor :http_error_message # [Output Only] If the operation fails, this field contains the HTTP error - # status code that was returned. For example, a 404 means the resource was not + # status code that was returned. For example, a `404` means the resource was not # found. # Corresponds to the JSON property `httpErrorStatusCode` # @return [Fixnum] @@ -20307,7 +20561,7 @@ module Google # @return [String] attr_accessor :insert_time - # [Output Only] Type of the resource. Always compute#operation for Operation + # [Output Only] Type of the resource. Always `compute#operation` for Operation # resources. # Corresponds to the JSON property `kind` # @return [String] @@ -20318,8 +20572,8 @@ module Google # @return [String] attr_accessor :name - # [Output Only] The type of operation, such as insert, update, or delete, and so - # on. + # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, + # and so on. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type @@ -20349,8 +20603,8 @@ module Google # @return [String] attr_accessor :start_time - # [Output Only] The status of the operation, which can be one of the following: - # PENDING, RUNNING, or DONE. + # [Output Only] The status of the operation, which can be one of the following: ` + # PENDING`, `RUNNING`, or `DONE`. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -20374,7 +20628,8 @@ module Google # @return [String] attr_accessor :target_link - # [Output Only] User who requested the operation, for example: user@example.com. + # [Output Only] User who requested the operation, for example: `user@example.com` + # . # Corresponds to the JSON property `user` # @return [String] attr_accessor :user @@ -20554,16 +20809,16 @@ module Google # @return [Hash] attr_accessor :items - # [Output Only] Type of resource. Always compute#operationAggregatedList for + # [Output Only] Type of resource. Always `compute#operationAggregatedList` for # aggregated lists of operations. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] This token allows you to get the next page of results for list - # requests. If the number of results is larger than maxResults, use the - # nextPageToken as a value for the query parameter pageToken in the next list - # request. Subsequent list requests will have their own nextPageToken to + # requests. If the number of results is larger than `maxResults`, use the ` + # nextPageToken` as a value for the query parameter `pageToken` in the next list + # request. Subsequent list requests will have their own `nextPageToken` to # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -20673,16 +20928,16 @@ module Google # @return [Array] attr_accessor :items - # [Output Only] Type of resource. Always compute#operations for Operations + # [Output Only] Type of resource. Always `compute#operations` for Operations # resource. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] This token allows you to get the next page of results for list - # requests. If the number of results is larger than maxResults, use the - # nextPageToken as a value for the query parameter pageToken in the next list - # request. Subsequent list requests will have their own nextPageToken to + # requests. If the number of results is larger than `maxResults`, use the ` + # nextPageToken` as a value for the query parameter `pageToken` in the next list + # request. Subsequent list requests will have their own `nextPageToken` to # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -20868,6 +21123,33 @@ module Google end end + # + class OrganizationSecurityPoliciesListAssociationsResponse + include Google::Apis::Core::Hashable + + # A list of associations. + # Corresponds to the JSON property `associations` + # @return [Array] + attr_accessor :associations + + # [Output Only] Type of securityPolicy associations. Always compute# + # organizationSecurityPoliciesListAssociations for lists of securityPolicy + # associations. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @associations = args[:associations] if args.key?(:associations) + @kind = args[:kind] if args.key?(:kind) + end + end + # Settings controlling the eviction of unhealthy hosts from the load balancing # pool for the backend service. class OutlierDetection @@ -21787,21 +22069,21 @@ module Google class PerInstanceConfig include Google::Apis::Core::Hashable - # Fingerprint of this per-instance config. This field may be used in optimistic - # locking. It will be ignored when inserting a per-instance config. An up-to- - # date fingerprint must be provided in order to update an existing per-instance + # Fingerprint of this per-instance config. This field can be used in optimistic + # locking. It is ignored when inserting a per-instance config. An up-to-date + # fingerprint must be provided in order to update an existing per-instance # config or the field needs to be unset. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint - # The name of the per-instance config and the corresponding instance. Serves as - # a merge key during UpdatePerInstanceConfigs operation, i.e. if per-instance - # config with the same name exists then it will be updated, otherwise a new one - # will be created for the VM instance with the same name. An attempt to create a - # per-instance config for a VM instance that either doesn't exist or is not part - # of the group will result in a failure. + # The name of a per-instance config and its corresponding instance. Serves as a + # merge key during UpdatePerInstanceConfigs operations, that is, if a per- + # instance config with the same name exists then it will be updated, otherwise a + # new one will be created for the VM instance with the same name. An attempt to + # create a per-instance config for a VM instance that either doesn't exist or is + # not part of the group will result in an error. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -23755,8 +24037,8 @@ module Google # Represents a URL Map resource. # Google Compute Engine has two URL Map resources: - # * [Global](/compute/docs/reference/rest/latest/urlMaps) * [Regional](/compute/ - # docs/reference/rest/latest/regionUrlMaps) + # * [Global](/compute/docs/reference/rest/`$api_version`/urlMaps) * [Regional](/ + # compute/docs/reference/rest/`$api_version`/regionUrlMaps) # A URL map resource is a component of certain types of GCP load balancers and # Traffic Director. # * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * @@ -24429,7 +24711,10 @@ module Google end end - # + # Represents a Resource Policy resource. You can use resource policies to + # schedule actions for some Compute Engine resources. For example, you can use + # them to schedule persistent disk snapshots. + # (== resource_for `$api_version`.resourcePolicies ==) class ResourcePolicy include Google::Apis::Core::Hashable @@ -24640,7 +24925,8 @@ module Google class ResourcePolicyDailyCycle include Google::Apis::Core::Hashable - # Defines a schedule that runs every nth day of the month. + # Defines a schedule with units measured in months. The value determines how + # many months pass between the start of each cycle. # Corresponds to the JSON property `daysInCycle` # @return [Fixnum] attr_accessor :days_in_cycle @@ -24714,7 +25000,8 @@ module Google # @return [String] attr_accessor :duration - # Allows to define schedule that runs every nth hour. + # Defines a schedule with units measured in hours. The value determines how many + # hours pass between the start of each cycle. # Corresponds to the JSON property `hoursInCycle` # @return [Fixnum] attr_accessor :hours_in_cycle @@ -25009,7 +25296,9 @@ module Google class ResourcePolicyWeeklyCycleDayOfWeek include Google::Apis::Core::Hashable - # Allows to define schedule that runs specified day of the week. + # Defines a schedule that runs on specific days of the week. Specify one or more + # days. The following options are available: MONDAY, TUESDAY, WEDNESDAY, + # THURSDAY, FRIDAY, SATURDAY, SUNDAY. # Corresponds to the JSON property `day` # @return [String] attr_accessor :day @@ -25855,15 +26144,15 @@ module Google attr_accessor :ip_range # URI of the linked Interconnect attachment. It must be in the same region as - # the router. Each interface can have one linked resource, which can be either - # be a VPN tunnel or an Interconnect attachment. + # the router. Each interface can have one linked resource, which can be a VPN + # tunnel, an Interconnect attachment, or a virtual machine instance. # Corresponds to the JSON property `linkedInterconnectAttachment` # @return [String] attr_accessor :linked_interconnect_attachment # URI of the linked VPN tunnel, which must be in the same region as the router. - # Each interface can have one linked resource, which can be either a VPN tunnel - # or an Interconnect attachment. + # Each interface can have one linked resource, which can be a VPN tunnel, an + # Interconnect attachment, or a virtual machine instance. # Corresponds to the JSON property `linkedVpnTunnel` # @return [String] attr_accessor :linked_vpn_tunnel @@ -26774,7 +27063,7 @@ module Google end end - # Sets the scheduling options for an Instance. NextID: 9 + # Sets the scheduling options for an Instance. NextID: 10 class Scheduling include Google::Apis::Core::Hashable @@ -26796,7 +27085,7 @@ module Google attr_accessor :min_node_cpus # A set of node affinity and anti-affinity configurations. Refer to Configuring - # node affinity for more information. + # node affinity for more information. Overrides reservationAffinity. # Corresponds to the JSON property `nodeAffinities` # @return [Array] attr_accessor :node_affinities @@ -26864,6 +27153,32 @@ module Google end end + # An instance's screenshot. + class Screenshot + include Google::Apis::Core::Hashable + + # [Output Only] The Base64-encoded screenshot data. + # Corresponds to the JSON property `contents` + # @return [String] + attr_accessor :contents + + # [Output Only] Type of the resource. Always compute#screenshot for the + # screenshots. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @contents = args[:contents] if args.key?(:contents) + @kind = args[:kind] if args.key?(:kind) + end + end + # class SecurityPoliciesListPreconfiguredExpressionSetsResponse include Google::Apis::Core::Hashable @@ -26909,6 +27224,11 @@ module Google class SecurityPolicy include Google::Apis::Core::Hashable + # A list of associations that belong to this policy. + # Corresponds to the JSON property `associations` + # @return [Array] + attr_accessor :associations + # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] @@ -26920,6 +27240,18 @@ module Google # @return [String] attr_accessor :description + # User-provided name of the Organization security plicy. The name should be + # unique in the organization in which the security policy is created. This + # should only be used when SecurityPolicyType is FIREWALL. The name must be 1-63 + # characters long, and comply with RFC1035. Specifically, the name must be 1-63 + # characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` + # which means the first character must be a lowercase letter, and all following + # characters must be a dash, lowercase letter, or digit, except the last + # character, which cannot be a dash. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + # Specifies a fingerprint for this resource, which is essentially a hash of the # metadata's contents and used for optimistic locking. The fingerprint is # initially generated by Compute Engine and changes after every request to @@ -26972,6 +27304,17 @@ module Google # @return [String] attr_accessor :name + # [Output Only] The parent of the security policy. + # Corresponds to the JSON property `parent` + # @return [String] + attr_accessor :parent + + # [Output Only] Total count of all security policy rule tuples. A security + # policy can not exceed a set number of tuples. + # Corresponds to the JSON property `ruleTupleCount` + # @return [Fixnum] + attr_accessor :rule_tuple_count + # A list of rules that belong to this policy. There must always be a default # rule (rule with priority 2147483647 and match "*"). If no rules are provided # when creating a security policy, a default rule with action "allow" will be @@ -26985,22 +27328,76 @@ module Google # @return [String] attr_accessor :self_link + # [Output Only] Server-defined URL for this resource with the resource id. + # Corresponds to the JSON property `selfLinkWithId` + # @return [String] + attr_accessor :self_link_with_id + + # The type indicates the intended use of the security policy. CLOUD_ARMOR + # policies apply to backend services. FIREWALL policies apply to organizations. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @associations = args[:associations] if args.key?(:associations) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) + @parent = args[:parent] if args.key?(:parent) + @rule_tuple_count = args[:rule_tuple_count] if args.key?(:rule_tuple_count) @rules = args[:rules] if args.key?(:rules) @self_link = args[:self_link] if args.key?(:self_link) + @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) + @type = args[:type] if args.key?(:type) + end + end + + # + class SecurityPolicyAssociation + include Google::Apis::Core::Hashable + + # The resource that the security policy is attached to. + # Corresponds to the JSON property `attachmentId` + # @return [String] + attr_accessor :attachment_id + + # [Output Only] The display name of the security policy of the association. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The name for an association. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # [Output Only] The security policy ID of the association. + # Corresponds to the JSON property `securityPolicyId` + # @return [String] + attr_accessor :security_policy_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @attachment_id = args[:attachment_id] if args.key?(:attachment_id) + @display_name = args[:display_name] if args.key?(:display_name) + @name = args[:name] if args.key?(:name) + @security_policy_id = args[:security_policy_id] if args.key?(:security_policy_id) end end @@ -27153,6 +27550,22 @@ module Google # @return [String] attr_accessor :description + # The direction in which this rule applies. This field may only be specified + # when versioned_expr is set to FIREWALL. + # Corresponds to the JSON property `direction` + # @return [String] + attr_accessor :direction + + # Denotes whether to enable logging for a particular rule. If logging is enabled, + # logs will be exported to the configured export destination in Stackdriver. + # Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging + # on "goto_next" rules. + # This field may only be specified when the versioned_expr is set to FIREWALL. + # Corresponds to the JSON property `enableLogging` + # @return [Boolean] + attr_accessor :enable_logging + alias_method :enable_logging?, :enable_logging + # [Output only] Type of the resource. Always compute#securityPolicyRule for # security policy rules # Corresponds to the JSON property `kind` @@ -27179,6 +27592,26 @@ module Google # @return [Fixnum] attr_accessor :priority + # [Output Only] Calculation of the complexity of a single firewall security + # policy rule. + # Corresponds to the JSON property `ruleTupleCount` + # @return [Fixnum] + attr_accessor :rule_tuple_count + + # A list of network resource URLs to which this rule applies. This field allows + # you to control which network's VMs get this rule. If this field is left blank, + # all VMs within the organization will receive the rule. + # This field may only be specified when versioned_expr is set to FIREWALL. + # Corresponds to the JSON property `targetResources` + # @return [Array] + attr_accessor :target_resources + + # A list of service accounts indicating the sets of instances that are applied + # with this rule. + # Corresponds to the JSON property `targetServiceAccounts` + # @return [Array] + attr_accessor :target_service_accounts + def initialize(**args) update!(**args) end @@ -27187,10 +27620,15 @@ module Google def update!(**args) @action = args[:action] if args.key?(:action) @description = args[:description] if args.key?(:description) + @direction = args[:direction] if args.key?(:direction) + @enable_logging = args[:enable_logging] if args.key?(:enable_logging) @kind = args[:kind] if args.key?(:kind) @match = args[:match] if args.key?(:match) @preview = args[:preview] if args.key?(:preview) @priority = args[:priority] if args.key?(:priority) + @rule_tuple_count = args[:rule_tuple_count] if args.key?(:rule_tuple_count) + @target_resources = args[:target_resources] if args.key?(:target_resources) + @target_service_accounts = args[:target_service_accounts] if args.key?(:target_service_accounts) end end @@ -27254,6 +27692,18 @@ module Google class SecurityPolicyRuleMatcherConfig include Google::Apis::Core::Hashable + # CIDR IP address range. + # This field may only be specified when versioned_expr is set to FIREWALL. + # Corresponds to the JSON property `destIpRanges` + # @return [Array] + attr_accessor :dest_ip_ranges + + # Pairs of IP protocols and ports that the rule should match. + # This field may only be specified when versioned_expr is set to FIREWALL. + # Corresponds to the JSON property `layer4Configs` + # @return [Array] + attr_accessor :layer4_configs + # CIDR IP address range. # Corresponds to the JSON property `srcIpRanges` # @return [Array] @@ -27265,10 +27715,81 @@ module Google # Update properties of this object def update!(**args) + @dest_ip_ranges = args[:dest_ip_ranges] if args.key?(:dest_ip_ranges) + @layer4_configs = args[:layer4_configs] if args.key?(:layer4_configs) @src_ip_ranges = args[:src_ip_ranges] if args.key?(:src_ip_ranges) end end + # + class SecurityPolicyRuleMatcherConfigLayer4Config + include Google::Apis::Core::Hashable + + # The IP protocol to which this rule applies. The protocol type is required when + # creating a firewall rule. This value can either be one of the following well + # known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP + # protocol number. + # Corresponds to the JSON property `ipProtocol` + # @return [String] + attr_accessor :ip_protocol + + # An optional list of ports to which this rule applies. This field is only + # applicable for UDP or TCP protocol. Each entry must be either an integer or a + # range. If not specified, this rule applies to connections through any port. + # Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + # This field may only be specified when versioned_expr is set to FIREWALL. + # Corresponds to the JSON property `ports` + # @return [Array] + attr_accessor :ports + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ip_protocol = args[:ip_protocol] if args.key?(:ip_protocol) + @ports = args[:ports] if args.key?(:ports) + end + end + + # The authentication and authorization settings for a BackendService. + class SecuritySettings + include Google::Apis::Core::Hashable + + # A URL referring to a networksecurity.Authentication resource that describes + # how clients should authenticate with this service's backends. If left blank, + # communications between services are not encrypted (i.e., the TLS policy is set + # to OPEN). When sending traffic to this service's backends, the OriginationTls + # setting of Authentication.TransportAuthentication is applied. Refer to the + # Authentication and Authentication.TransportAuthentication.OriginationTls + # resources for additional details. authentication only applies to a global + # BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. + # Corresponds to the JSON property `authentication` + # @return [String] + attr_accessor :authentication + + # Optional. A list of subject alternate names to verify the subject identity ( + # SAN) in the certificate presented by the server, to authorize the SAN list as + # identities to run the service represented by this BackendService. If specified, + # the client will verify that the server certificate's subject alt name matches + # one of the specified values. Only applies to a global BackendService with the + # loadBalancingScheme set to INTERNAL_SELF_MANAGED. + # Corresponds to the JSON property `subjectAltNames` + # @return [Array] + attr_accessor :subject_alt_names + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @authentication = args[:authentication] if args.key?(:authentication) + @subject_alt_names = args[:subject_alt_names] if args.key?(:subject_alt_names) + end + end + # An instance's serial console output. class SerialPortOutput include Google::Apis::Core::Hashable @@ -28027,7 +28548,7 @@ module Google # @return [Array] attr_accessor :network_interfaces - # Sets the scheduling options for an Instance. NextID: 9 + # Sets the scheduling options for an Instance. NextID: 10 # Corresponds to the JSON property `scheduling` # @return [Google::Apis::ComputeBeta::Scheduling] attr_accessor :scheduling @@ -28069,16 +28590,19 @@ module Google # Represents an SSL Certificate resource. # Google Compute Engine has two SSL Certificate resources: - # * [Global](/compute/docs/reference/rest/latest/sslCertificates) * [Regional](/ - # compute/docs/reference/rest/latest/regionSslCertificates) - # - sslCertificates are used by: - external HTTPS load balancers - SSL proxy - # load balancers - # - regionSslCertificates are used by: - internal HTTPS load balancers - # This SSL certificate resource also contains a private key. You can use SSL - # keys and certificates to secure connections to a load balancer. For more - # information, read Creating and Using SSL Certificates. (== resource_for `$ - # api_version`.sslCertificates ==) (== resource_for `$api_version`. - # regionSslCertificates ==) Next ID: 17 + # * [Global](/compute/docs/reference/rest/`$api_version`/sslCertificates) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionSslCertificates) + # The sslCertificates are used by: + # - external HTTPS load balancers + # - SSL proxy load balancers + # The regionSslCertificates are used by internal HTTPS load balancers. + # Optionally, certificate file contents that you upload can contain a set of up + # to five PEM-encoded certificates. The API call creates an object ( + # sslCertificate) that holds this data. You can use SSL keys and certificates to + # secure connections to a load balancer. For more information, read Creating + # and using SSL certificates and SSL certificates quotas and limits. (== + # resource_for `$api_version`.sslCertificates ==) (== resource_for `$api_version` + # .regionSslCertificates ==) class SslCertificate include Google::Apis::Core::Hashable @@ -29119,7 +29643,7 @@ module Google # @return [String] attr_accessor :region - # The role of subnetwork. Currenly, this field is only used when purpose = + # The role of subnetwork. Currently, this field is only used when purpose = # INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An # ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) # Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to @@ -29439,6 +29963,12 @@ module Google attr_accessor :enable alias_method :enable?, :enable + # Can only be specified if VPC flow logs for this subnetwork is enabled. Export + # filter used to define which VPC flow logs should be logged. + # Corresponds to the JSON property `filterExpr` + # @return [String] + attr_accessor :filter_expr + # Can only be specified if VPC flow logging for this subnetwork is enabled. The # value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs # within the subnetwork where 1.0 means all collected logs are reported and 0.0 @@ -29455,6 +29985,12 @@ module Google # @return [String] attr_accessor :metadata + # Can only be specified if VPC flow logs for this subnetwork is enabled and " + # metadata" was set to CUSTOM_METADATA. + # Corresponds to the JSON property `metadataFields` + # @return [Array] + attr_accessor :metadata_fields + def initialize(**args) update!(**args) end @@ -29463,8 +29999,10 @@ module Google def update!(**args) @aggregation_interval = args[:aggregation_interval] if args.key?(:aggregation_interval) @enable = args[:enable] if args.key?(:enable) + @filter_expr = args[:filter_expr] if args.key?(:filter_expr) @flow_sampling = args[:flow_sampling] if args.key?(:flow_sampling) @metadata = args[:metadata] if args.key?(:metadata) + @metadata_fields = args[:metadata_fields] if args.key?(:metadata_fields) end end @@ -29819,8 +30357,8 @@ module Google # Represents a Target HTTP Proxy resource. # Google Compute Engine has two Target HTTP Proxy resources: - # * [Global](/compute/docs/reference/rest/latest/targetHttpProxies) * [Regional]( - # /compute/docs/reference/rest/latest/regionTargetHttpProxies) + # * [Global](/compute/docs/reference/rest/`$api_version`/targetHttpProxies) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionTargetHttpProxies) # A target HTTP proxy is a component of GCP HTTP load balancers. # * targetHttpProxies are used by external HTTP load balancers and Traffic # Director. * regionTargetHttpProxies are used by internal HTTP load balancers. @@ -29864,6 +30402,14 @@ module Google # @return [String] attr_accessor :name + # This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. + # When set to true the Envoy binds on the IP address specified by the forwarding + # rule. Default is false. + # Corresponds to the JSON property `proxyBind` + # @return [Boolean] + attr_accessor :proxy_bind + alias_method :proxy_bind?, :proxy_bind + # [Output Only] URL of the region where the regional Target HTTP Proxy resides. # This field is not applicable to global Target HTTP Proxies. # Corresponds to the JSON property `region` @@ -29892,6 +30438,7 @@ module Google @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) + @proxy_bind = args[:proxy_bind] if args.key?(:proxy_bind) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @url_map = args[:url_map] if args.key?(:url_map) @@ -30266,8 +30813,8 @@ module Google # Represents a Target HTTPS Proxy resource. # Google Compute Engine has two Target HTTPS Proxy resources: - # * [Global](/compute/docs/reference/rest/latest/targetHttpsProxies) * [Regional] - # (/compute/docs/reference/rest/latest/regionTargetHttpsProxies) + # * [Global](/compute/docs/reference/rest/`$api_version`/targetHttpsProxies) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionTargetHttpsProxies) # A target HTTPS proxy is a component of GCP HTTPS load balancers. # * targetHttpsProxies are used by external HTTPS load balancers. * # regionTargetHttpsProxies are used by internal HTTPS load balancers. @@ -30278,6 +30825,31 @@ module Google class TargetHttpsProxy include Google::Apis::Core::Hashable + # A URL referring to a networksecurity.Authentication resource that describes + # how the proxy should authenticate inbound traffic. If left blank, + # communications between services are not encrypted (i.e., the TLS policy is set + # to OPEN). When terminating inbound traffic to this proxy, the TerminationTls + # setting of Authentication.TransportAuthentication is applied. + # Refer to the Authentication and Authentication.TransportAuthentication. + # TerminationTls resources for additional details. + # authentication only applies to a global TargetHttpsProxy attached to + # globalForwardingRules with the loadBalancingScheme set to + # INTERNAL_SELF_MANAGED. + # Corresponds to the JSON property `authentication` + # @return [String] + attr_accessor :authentication + + # A URL referring to a networksecurity.Authorization resource that describes how + # the proxy should authorize inbound traffic. If left blank, access will not be + # restricted by an authorization policy. + # Refer to the Authorization resource for additional details. + # authorization only applies to a global TargetHttpsProxy attached to + # globalForwardingRules with the loadBalancingScheme set to + # INTERNAL_SELF_MANAGED. + # Corresponds to the JSON property `authorization` + # @return [String] + attr_accessor :authorization + # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] @@ -30311,6 +30883,14 @@ module Google # @return [String] attr_accessor :name + # This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. + # When set to true the Envoy binds on the IP address specified by the forwarding + # rule. Default is false. + # Corresponds to the JSON property `proxyBind` + # @return [Boolean] + attr_accessor :proxy_bind + alias_method :proxy_bind?, :proxy_bind + # Specifies the QUIC override policy for this TargetHttpsProxy resource. This # setting determines whether the load balancer attempts to negotiate QUIC with # clients. You can specify NONE, ENABLE, or DISABLE. @@ -30365,11 +30945,14 @@ module Google # Update properties of this object def update!(**args) + @authentication = args[:authentication] if args.key?(:authentication) + @authorization = args[:authorization] if args.key?(:authorization) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) + @proxy_bind = args[:proxy_bind] if args.key?(:proxy_bind) @quic_override = args[:quic_override] if args.key?(:quic_override) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @@ -31922,7 +32505,7 @@ module Google # A target TCP proxy is a component of a TCP Proxy load balancer. Global # forwarding rules reference target TCP proxy, and the target proxy then # references an external backend service. For more information, read TCP Proxy - # Load Balancing Concepts. (== resource_for `$api_version`.targetTcpProxies ==) + # Load Balancing overview. (== resource_for `$api_version`.targetTcpProxies ==) class TargetTcpProxy include Google::Apis::Core::Hashable @@ -32633,8 +33216,8 @@ module Google # Represents a URL Map resource. # Google Compute Engine has two URL Map resources: - # * [Global](/compute/docs/reference/rest/latest/urlMaps) * [Regional](/compute/ - # docs/reference/rest/latest/regionUrlMaps) + # * [Global](/compute/docs/reference/rest/`$api_version`/urlMaps) * [Regional](/ + # compute/docs/reference/rest/`$api_version`/regionUrlMaps) # A URL map resource is a component of certain types of GCP load balancers and # Traffic Director. # * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * @@ -33207,8 +33790,8 @@ module Google # Represents a URL Map resource. # Google Compute Engine has two URL Map resources: - # * [Global](/compute/docs/reference/rest/latest/urlMaps) * [Regional](/compute/ - # docs/reference/rest/latest/regionUrlMaps) + # * [Global](/compute/docs/reference/rest/`$api_version`/urlMaps) * [Regional](/ + # compute/docs/reference/rest/`$api_version`/regionUrlMaps) # A URL map resource is a component of certain types of GCP load balancers and # Traffic Director. # * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * diff --git a/generated/google/apis/compute_beta/representations.rb b/generated/google/apis/compute_beta/representations.rb index d01464f7a..012ff4e90 100644 --- a/generated/google/apis/compute_beta/representations.rb +++ b/generated/google/apis/compute_beta/representations.rb @@ -820,6 +820,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class FileContentBuffer + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Firewall class Representation < Google::Apis::Core::JsonRepresentation; end @@ -958,12 +964,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class GoogleDuration - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GuestAttributes class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1048,6 +1048,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class HealthCheckServiceReference + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class HealthCheckServicesList class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1270,6 +1276,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class InitialStateConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Instance class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1708,6 +1720,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class InstancesAddResourcePoliciesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InstancesGetEffectiveFirewallsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InstancesGetEffectiveFirewallsResponseOrganizationFirewallPolicy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InstancesRemoveResourcePoliciesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class InstancesResumeRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -2332,6 +2368,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class NetworksGetEffectiveFirewallsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NetworksGetEffectiveFirewallsResponseOrganizationFirewallPolicy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class NetworksRemovePeeringRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -2692,6 +2740,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class OrganizationSecurityPoliciesListAssociationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class OutlierDetection class Representation < Google::Apis::Core::JsonRepresentation; end @@ -3568,6 +3622,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Screenshot + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SecurityPoliciesListPreconfiguredExpressionSetsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -3586,6 +3646,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class SecurityPolicyAssociation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SecurityPolicyList class Representation < Google::Apis::Core::JsonRepresentation; end @@ -3628,6 +3694,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class SecurityPolicyRuleMatcherConfigLayer4Config + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SecuritySettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SerialPortOutput class Representation < Google::Apis::Core::JsonRepresentation; end @@ -5118,6 +5196,8 @@ module Google property :kind, as: 'kind' collection :licenses, as: 'licenses' property :mode, as: 'mode' + property :shielded_instance_initial_state, as: 'shieldedInstanceInitialState', class: Google::Apis::ComputeBeta::InitialStateConfig, decorator: Google::Apis::ComputeBeta::InitialStateConfig::Representation + property :source, as: 'source' property :type, as: 'type' end @@ -5133,6 +5213,7 @@ module Google collection :guest_os_features, as: 'guestOsFeatures', class: Google::Apis::ComputeBeta::GuestOsFeature, decorator: Google::Apis::ComputeBeta::GuestOsFeature::Representation hash :labels, as: 'labels' + property :on_update_action, as: 'onUpdateAction' collection :resource_policies, as: 'resourcePolicies' property :source_image, as: 'sourceImage' property :source_image_encryption_key, as: 'sourceImageEncryptionKey', class: Google::Apis::ComputeBeta::CustomerEncryptionKey, decorator: Google::Apis::ComputeBeta::CustomerEncryptionKey::Representation @@ -5338,8 +5419,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :max_scaled_down_replicas, as: 'maxScaledDownReplicas', class: Google::Apis::ComputeBeta::FixedOrPercent, decorator: Google::Apis::ComputeBeta::FixedOrPercent::Representation - property :time_window, as: 'timeWindow', class: Google::Apis::ComputeBeta::GoogleDuration, decorator: Google::Apis::ComputeBeta::GoogleDuration::Representation - + property :time_window_sec, as: 'timeWindowSec' end end @@ -5456,6 +5536,8 @@ module Google property :protocol, as: 'protocol' property :region, as: 'region' property :security_policy, as: 'securityPolicy' + property :security_settings, as: 'securitySettings', class: Google::Apis::ComputeBeta::SecuritySettings, decorator: Google::Apis::ComputeBeta::SecuritySettings::Representation + property :self_link, as: 'selfLink' property :session_affinity, as: 'sessionAffinity' property :timeout_sec, as: 'timeoutSec' @@ -6324,6 +6406,14 @@ module Google end end + class FileContentBuffer + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content, :base64 => true, as: 'content' + property :file_type, as: 'fileType' + end + end + class Firewall # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -6586,14 +6676,6 @@ module Google end end - class GoogleDuration - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :nanos, as: 'nanos' - property :seconds, :numeric_string => true, as: 'seconds' - end - end - class GuestAttributes # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -6765,6 +6847,13 @@ module Google end end + class HealthCheckServiceReference + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :health_check_service, as: 'healthCheckService' + end + end + class HealthCheckServicesList # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -6877,6 +6966,8 @@ module Google property :health_check, as: 'healthCheck', class: Google::Apis::ComputeBeta::HealthCheckReference, decorator: Google::Apis::ComputeBeta::HealthCheckReference::Representation + property :health_check_service, as: 'healthCheckService', class: Google::Apis::ComputeBeta::HealthCheckServiceReference, decorator: Google::Apis::ComputeBeta::HealthCheckServiceReference::Representation + property :health_state, as: 'healthState' end end @@ -7164,6 +7255,8 @@ module Google property :raw_disk, as: 'rawDisk', class: Google::Apis::ComputeBeta::Image::RawDisk, decorator: Google::Apis::ComputeBeta::Image::RawDisk::Representation property :self_link, as: 'selfLink' + property :shielded_instance_initial_state, as: 'shieldedInstanceInitialState', class: Google::Apis::ComputeBeta::InitialStateConfig, decorator: Google::Apis::ComputeBeta::InitialStateConfig::Representation + property :source_disk, as: 'sourceDisk' property :source_disk_encryption_key, as: 'sourceDiskEncryptionKey', class: Google::Apis::ComputeBeta::CustomerEncryptionKey, decorator: Google::Apis::ComputeBeta::CustomerEncryptionKey::Representation @@ -7223,6 +7316,20 @@ module Google end end + class InitialStateConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dbs, as: 'dbs', class: Google::Apis::ComputeBeta::FileContentBuffer, decorator: Google::Apis::ComputeBeta::FileContentBuffer::Representation + + collection :dbxs, as: 'dbxs', class: Google::Apis::ComputeBeta::FileContentBuffer, decorator: Google::Apis::ComputeBeta::FileContentBuffer::Representation + + collection :keks, as: 'keks', class: Google::Apis::ComputeBeta::FileContentBuffer, decorator: Google::Apis::ComputeBeta::FileContentBuffer::Representation + + property :pk, as: 'pk', class: Google::Apis::ComputeBeta::FileContentBuffer, decorator: Google::Apis::ComputeBeta::FileContentBuffer::Representation + + end + end + class Instance # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -7236,6 +7343,7 @@ module Google property :display_device, as: 'displayDevice', class: Google::Apis::ComputeBeta::DisplayDevice, decorator: Google::Apis::ComputeBeta::DisplayDevice::Representation property :erase_windows_vss_signature, as: 'eraseWindowsVssSignature' + property :fingerprint, :base64 => true, as: 'fingerprint' collection :guest_accelerators, as: 'guestAccelerators', class: Google::Apis::ComputeBeta::AcceleratorConfig, decorator: Google::Apis::ComputeBeta::AcceleratorConfig::Representation property :hostname, as: 'hostname' @@ -7250,6 +7358,7 @@ module Google property :name, as: 'name' collection :network_interfaces, as: 'networkInterfaces', class: Google::Apis::ComputeBeta::NetworkInterface, decorator: Google::Apis::ComputeBeta::NetworkInterface::Representation + property :private_ipv6_google_access, as: 'privateIpv6GoogleAccess' property :reservation_affinity, as: 'reservationAffinity', class: Google::Apis::ComputeBeta::ReservationAffinity, decorator: Google::Apis::ComputeBeta::ReservationAffinity::Representation collection :resource_policies, as: 'resourcePolicies' @@ -7546,6 +7655,7 @@ module Google class InstanceGroupManagerStatusStateful # @private class Representation < Google::Apis::Core::JsonRepresentation + property :has_stateful_config, as: 'hasStatefulConfig' property :is_stateful, as: 'isStateful' end end @@ -7960,6 +8070,7 @@ module Google property :min_cpu_platform, as: 'minCpuPlatform' collection :network_interfaces, as: 'networkInterfaces', class: Google::Apis::ComputeBeta::NetworkInterface, decorator: Google::Apis::ComputeBeta::NetworkInterface::Representation + property :private_ipv6_google_access, as: 'privateIpv6GoogleAccess' property :reservation_affinity, as: 'reservationAffinity', class: Google::Apis::ComputeBeta::ReservationAffinity, decorator: Google::Apis::ComputeBeta::ReservationAffinity::Representation collection :resource_policies, as: 'resourcePolicies' @@ -8042,6 +8153,39 @@ module Google end end + class InstancesAddResourcePoliciesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :resource_policies, as: 'resourcePolicies' + end + end + + class InstancesGetEffectiveFirewallsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :firewalls, as: 'firewalls', class: Google::Apis::ComputeBeta::Firewall, decorator: Google::Apis::ComputeBeta::Firewall::Representation + + collection :organization_firewalls, as: 'organizationFirewalls', class: Google::Apis::ComputeBeta::InstancesGetEffectiveFirewallsResponseOrganizationFirewallPolicy, decorator: Google::Apis::ComputeBeta::InstancesGetEffectiveFirewallsResponseOrganizationFirewallPolicy::Representation + + end + end + + class InstancesGetEffectiveFirewallsResponseOrganizationFirewallPolicy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, :numeric_string => true, as: 'id' + collection :rules, as: 'rules', class: Google::Apis::ComputeBeta::SecurityPolicyRule, decorator: Google::Apis::ComputeBeta::SecurityPolicyRule::Representation + + end + end + + class InstancesRemoveResourcePoliciesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :resource_policies, as: 'resourcePolicies' + end + end + class InstancesResumeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -9184,6 +9328,25 @@ module Google end end + class NetworksGetEffectiveFirewallsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :firewalls, as: 'firewalls', class: Google::Apis::ComputeBeta::Firewall, decorator: Google::Apis::ComputeBeta::Firewall::Representation + + collection :organization_firewalls, as: 'organizationFirewalls', class: Google::Apis::ComputeBeta::NetworksGetEffectiveFirewallsResponseOrganizationFirewallPolicy, decorator: Google::Apis::ComputeBeta::NetworksGetEffectiveFirewallsResponseOrganizationFirewallPolicy::Representation + + end + end + + class NetworksGetEffectiveFirewallsResponseOrganizationFirewallPolicy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, :numeric_string => true, as: 'id' + collection :rules, as: 'rules', class: Google::Apis::ComputeBeta::SecurityPolicyRule, decorator: Google::Apis::ComputeBeta::SecurityPolicyRule::Representation + + end + end + class NetworksRemovePeeringRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -9295,6 +9458,7 @@ module Google class NodeGroupNode # @private class Representation < Google::Apis::Core::JsonRepresentation + property :cpu_overcommit_type, as: 'cpuOvercommitType' collection :instances, as: 'instances' property :name, as: 'name' property :node_type, as: 'nodeType' @@ -9389,6 +9553,7 @@ module Google class NodeTemplate # @private class Representation < Google::Apis::Core::JsonRepresentation + property :cpu_overcommit_type, as: 'cpuOvercommitType' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' @@ -9836,6 +10001,15 @@ module Google end end + class OrganizationSecurityPoliciesListAssociationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :associations, as: 'associations', class: Google::Apis::ComputeBeta::SecurityPolicyAssociation, decorator: Google::Apis::ComputeBeta::SecurityPolicyAssociation::Representation + + property :kind, as: 'kind' + end + end + class OutlierDetection # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -11389,6 +11563,14 @@ module Google end end + class Screenshot + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :contents, as: 'contents' + property :kind, as: 'kind' + end + end + class SecurityPoliciesListPreconfiguredExpressionSetsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -11408,17 +11590,34 @@ module Google class SecurityPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :associations, as: 'associations', class: Google::Apis::ComputeBeta::SecurityPolicyAssociation, decorator: Google::Apis::ComputeBeta::SecurityPolicyAssociation::Representation + property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' + property :display_name, as: 'displayName' property :fingerprint, :base64 => true, as: 'fingerprint' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :label_fingerprint, :base64 => true, as: 'labelFingerprint' hash :labels, as: 'labels' property :name, as: 'name' + property :parent, as: 'parent' + property :rule_tuple_count, as: 'ruleTupleCount' collection :rules, as: 'rules', class: Google::Apis::ComputeBeta::SecurityPolicyRule, decorator: Google::Apis::ComputeBeta::SecurityPolicyRule::Representation property :self_link, as: 'selfLink' + property :self_link_with_id, as: 'selfLinkWithId' + property :type, as: 'type' + end + end + + class SecurityPolicyAssociation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :attachment_id, as: 'attachmentId' + property :display_name, as: 'displayName' + property :name, as: 'name' + property :security_policy_id, as: 'securityPolicyId' end end @@ -11465,11 +11664,16 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :action, as: 'action' property :description, as: 'description' + property :direction, as: 'direction' + property :enable_logging, as: 'enableLogging' property :kind, as: 'kind' property :match, as: 'match', class: Google::Apis::ComputeBeta::SecurityPolicyRuleMatcher, decorator: Google::Apis::ComputeBeta::SecurityPolicyRuleMatcher::Representation property :preview, as: 'preview' property :priority, as: 'priority' + property :rule_tuple_count, as: 'ruleTupleCount' + collection :target_resources, as: 'targetResources' + collection :target_service_accounts, as: 'targetServiceAccounts' end end @@ -11487,10 +11691,29 @@ module Google class SecurityPolicyRuleMatcherConfig # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :dest_ip_ranges, as: 'destIpRanges' + collection :layer4_configs, as: 'layer4Configs', class: Google::Apis::ComputeBeta::SecurityPolicyRuleMatcherConfigLayer4Config, decorator: Google::Apis::ComputeBeta::SecurityPolicyRuleMatcherConfigLayer4Config::Representation + collection :src_ip_ranges, as: 'srcIpRanges' end end + class SecurityPolicyRuleMatcherConfigLayer4Config + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ip_protocol, as: 'ipProtocol' + collection :ports, as: 'ports' + end + end + + class SecuritySettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :authentication, as: 'authentication' + collection :subject_alt_names, as: 'subjectAltNames' + end + end + class SerialPortOutput # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -12035,8 +12258,10 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :aggregation_interval, as: 'aggregationInterval' property :enable, as: 'enable' + property :filter_expr, as: 'filterExpr' property :flow_sampling, as: 'flowSampling' property :metadata, as: 'metadata' + collection :metadata_fields, as: 'metadataFields' end end @@ -12146,6 +12371,7 @@ module Google property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' + property :proxy_bind, as: 'proxyBind' property :region, as: 'region' property :self_link, as: 'selfLink' property :url_map, as: 'urlMap' @@ -12261,11 +12487,14 @@ module Google class TargetHttpsProxy # @private class Representation < Google::Apis::Core::JsonRepresentation + property :authentication, as: 'authentication' + property :authorization, as: 'authorization' property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' + property :proxy_bind, as: 'proxyBind' property :quic_override, as: 'quicOverride' property :region, as: 'region' property :self_link, as: 'selfLink' diff --git a/generated/google/apis/compute_beta/service.rb b/generated/google/apis/compute_beta/service.rb index 680658d64..31b489b3d 100644 --- a/generated/google/apis/compute_beta/service.rb +++ b/generated/google/apis/compute_beta/service.rb @@ -58,19 +58,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -80,21 +80,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -178,36 +178,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -250,19 +250,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -272,21 +272,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -473,36 +473,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -642,19 +642,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -664,21 +664,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -866,36 +866,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1330,36 +1330,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1559,19 +1559,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -1581,21 +1581,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1809,8 +1809,8 @@ module Google # Creates a BackendService resource in the specified project using the data # included in the request. There are several restrictions and guidelines to keep - # in mind when creating a backend service. Read Restrictions and Guidelines for - # more information. + # in mind when creating a backend service. Read Understanding backend services + # for more information. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeBeta::BackendService] backend_service_object @@ -1866,36 +1866,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1931,8 +1931,8 @@ module Google end # Patches the specified BackendService resource with the data included in the - # request. There are several restrictions and guidelines to keep in mind when - # updating a backend service. Read Restrictions and Guidelines for more + # request. There are several Understanding backend services to keep in mind when + # updating a backend service. Read Understanding backend services for more # information. This method supports PATCH semantics and uses the JSON merge # patch format and processing rules. # @param [String] project @@ -2077,8 +2077,8 @@ module Google end # Updates the specified BackendService resource with the data included in the - # request. There are several restrictions and guidelines to keep in mind when - # updating a backend service. Read Restrictions and Guidelines for more + # request. There are several Understanding backend services to keep in mind when + # updating a backend service. Read Understanding backend services for more # information. # @param [String] project # Project ID for this request. @@ -2137,19 +2137,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -2159,21 +2159,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2258,36 +2258,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2385,19 +2385,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -2407,21 +2407,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2718,36 +2718,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3173,36 +3173,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3456,36 +3456,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3672,19 +3672,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -3694,21 +3694,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3896,36 +3896,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4310,36 +4310,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4595,36 +4595,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5091,36 +5091,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5165,36 +5165,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5237,19 +5237,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -5259,21 +5259,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5344,7 +5344,7 @@ module Google end # Retrieves the specified Operations resource. Gets a list of operations by - # making a list() request. + # making a `list()` request. # @param [String] project # Project ID for this request. # @param [String] operation @@ -5387,36 +5387,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5451,17 +5451,17 @@ module Google execute_or_queue_command(command, &block) end - # Waits for the specified Operation resource to return as DONE or for the + # Waits for the specified Operation resource to return as `DONE` or for the # request to approach the 2 minute deadline, and retrieves the specified - # Operation resource. This method differs from the GET method in that it waits + # Operation resource. This method differs from the `GET` method in that it waits # for no more than the default deadline (2 minutes) and then returns the current - # state of the operation, which might be DONE or still in progress. + # state of the operation, which might be `DONE` or still in progress. # This method is called on a best-effort basis. Specifically: # - In uncommon cases, when the server is overloaded, the request might return # before the default deadline is reached, or might return after zero seconds. # - If the default deadline is reached, there is no guarantee that the operation # is actually done when the method returns. Be prepared to retry if the - # operation is not DONE. + # operation is not `DONE`. # @param [String] project # Project ID for this request. # @param [String] operation @@ -5497,6 +5497,149 @@ module Google execute_or_queue_command(command, &block) end + # Deletes the specified Operations resource. + # @param [String] operation + # Name of the Operations resource to delete. + # @param [String] parent_id + # Parent ID for this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_global_organization_operation(operation, parent_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'locations/global/operations/{operation}', options) + command.params['operation'] = operation unless operation.nil? + command.query['parentId'] = parent_id unless parent_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the specified Operations resource. Gets a list of operations by + # making a `list()` request. + # @param [String] operation + # Name of the Operations resource to return. + # @param [String] parent_id + # Parent ID for this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_global_organization_operation(operation, parent_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'locations/global/operations/{operation}', options) + command.response_representation = Google::Apis::ComputeBeta::Operation::Representation + command.response_class = Google::Apis::ComputeBeta::Operation + command.params['operation'] = operation unless operation.nil? + command.query['parentId'] = parent_id unless parent_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of Operation resources contained within the specified + # organization. + # @param [String] filter + # A filter expression that filters resources listed in the response. The + # expression must specify the field name, a comparison operator, and the value + # that you want to use for filtering. The value must be a string, a number, or a + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. + # For example, if you are filtering Compute Engine instances, you can exclude + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled + # for automatic restarts. You can use filtering on nested fields to filter based + # on resource labels. + # To filter on multiple expressions, provide each separate expression within + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Fixnum] max_results + # The maximum number of results per page that should be returned. If the number + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + # @param [String] order_by + # Sorts list results by a certain order. By default, results are returned in + # alphanumerical order based on the resource name. + # You can also sort results in descending order based on the creation timestamp + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). + # Use this to sort resources like operations so that the newest operation is + # returned first. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. + # @param [String] page_token + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [String] parent_id + # Parent ID for this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::OperationList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::OperationList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_global_organization_operations(filter: nil, max_results: nil, order_by: nil, page_token: nil, parent_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'locations/global/operations', options) + command.response_representation = Google::Apis::ComputeBeta::OperationList::Representation + command.response_class = Google::Apis::ComputeBeta::OperationList + command.query['filter'] = filter unless filter.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['parentId'] = parent_id unless parent_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Retrieves the list of all HealthCheck resources, regional and global, # available to the specified project. # @param [String] project @@ -5505,19 +5648,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -5527,21 +5670,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5718,36 +5861,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6068,36 +6211,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6418,36 +6561,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6903,36 +7046,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7158,19 +7301,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -7180,21 +7323,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7230,8 +7373,8 @@ module Google execute_or_queue_command(command, &block) end - # Apply changes to selected instances on the managed instance group. This method - # can be used to apply new overrides and/or new versions. + # Applies changes to selected instances on the managed instance group. This + # method can be used to apply new overrides and/or new versions. # @param [String] project # Project ID for this request. # @param [String] zone @@ -7601,36 +7744,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7681,36 +7824,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7762,36 +7905,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7820,7 +7963,7 @@ module Google command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.nil? - command.query['order_by'] = order_by unless order_by.nil? + command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? @@ -7840,36 +7983,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7965,9 +8108,9 @@ module Google execute_or_queue_command(command, &block) end - # Insert or patch (for the ones that already exist) per-instance configs for the - # managed instance group. perInstanceConfig.instance serves as a key used to - # distinguish whether to perform insert or patch. + # Inserts or patches per-instance configs for the managed instance group. + # perInstanceConfig.name serves as a key used to distinguish whether to perform + # insert or patch. # @param [String] project # Project ID for this request. # @param [String] zone @@ -8491,9 +8634,9 @@ module Google execute_or_queue_command(command, &block) end - # Insert or update (for the ones that already exist) per-instance configs for - # the managed instance group. perInstanceConfig.instance serves as a key used to - # distinguish whether to perform insert or patch. + # Inserts or updates per-instance configs for the managed instance group. + # perInstanceConfig.name serves as a key used to distinguish whether to perform + # insert or patch. # @param [String] project # Project ID for this request. # @param [String] zone @@ -8611,19 +8754,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -8633,21 +8776,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -8838,36 +8981,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -8916,36 +9059,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -9324,36 +9467,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -9524,6 +9667,62 @@ module Google execute_or_queue_command(command, &block) end + # Adds existing resource policies to an instance. You can only add one policy + # right now which will be applied to this instance for scheduling live + # migrations. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] instance + # The instance name for this request. + # @param [Google::Apis::ComputeBeta::InstancesAddResourcePoliciesRequest] instances_add_resource_policies_request_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def add_instance_resource_policies(project, zone, instance, instances_add_resource_policies_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/addResourcePolicies', options) + command.request_representation = Google::Apis::ComputeBeta::InstancesAddResourcePoliciesRequest::Representation + command.request_object = instances_add_resource_policies_request_object + command.response_representation = Google::Apis::ComputeBeta::Operation::Representation + command.response_class = Google::Apis::ComputeBeta::Operation + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['instance'] = instance unless instance.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Retrieves aggregated list of all of the instances in your project across all # regions and zones. # @param [String] project @@ -9532,19 +9731,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -9554,21 +9753,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -9869,6 +10068,48 @@ module Google execute_or_queue_command(command, &block) end + # Returns effective firewalls applied to an interface of the instance. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] instance + # Name of the instance scoping this request. + # @param [String] network_interface + # The name of the network interface to get the effective firewalls. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::InstancesGetEffectiveFirewallsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::InstancesGetEffectiveFirewallsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_instance_effective_firewalls(project, zone, instance, network_interface, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls', options) + command.response_representation = Google::Apis::ComputeBeta::InstancesGetEffectiveFirewallsResponse::Representation + command.response_class = Google::Apis::ComputeBeta::InstancesGetEffectiveFirewallsResponse + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['instance'] = instance unless instance.nil? + command.query['networkInterface'] = network_interface unless network_interface.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Returns the specified guest attributes entry. # @param [String] project # Project ID for this request. @@ -9957,6 +10198,45 @@ module Google execute_or_queue_command(command, &block) end + # Returns the screenshot from the specified instance. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] instance + # Name of the instance scoping this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::Screenshot] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::Screenshot] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_instance_screenshot(project, zone, instance, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/zones/{zone}/instances/{instance}/screenshot', options) + command.response_representation = Google::Apis::ComputeBeta::Screenshot::Representation + command.response_class = Google::Apis::ComputeBeta::Screenshot + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['instance'] = instance unless instance.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Returns the last 1 MB of serial port output from the specified instance. # @param [String] project # Project ID for this request. @@ -10162,36 +10442,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -10240,36 +10520,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -10306,6 +10586,60 @@ module Google execute_or_queue_command(command, &block) end + # Removes resource policies from an instance. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] instance + # The instance name for this request. + # @param [Google::Apis::ComputeBeta::InstancesRemoveResourcePoliciesRequest] instances_remove_resource_policies_request_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def remove_instance_resource_policies(project, zone, instance, instances_remove_resource_policies_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/removeResourcePolicies', options) + command.request_representation = Google::Apis::ComputeBeta::InstancesRemoveResourcePoliciesRequest::Representation + command.request_object = instances_remove_resource_policies_request_object + command.response_representation = Google::Apis::ComputeBeta::Operation::Representation + command.response_class = Google::Apis::ComputeBeta::Operation + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['instance'] = instance unless instance.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Performs a reset on the instance. This is a hard reset the VM does not do a # graceful shutdown. For more information, see Resetting an instance. # @param [String] project @@ -11421,6 +11755,73 @@ module Google execute_or_queue_command(command, &block) end + # Updates an instance only if the necessary resources are available. This method + # can update only a specific set of instance properties. See Updating a running + # instance for a list of updatable instance properties. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] instance + # Name of the instance resource to update. + # @param [Google::Apis::ComputeBeta::Instance] instance_object + # @param [String] minimal_action + # Specifies the action to take when updating an instance even if the updated + # properties do not require it. If not specified, then Compute Engine acts based + # on the minimum action that the updated properties require. + # @param [String] most_disruptive_allowed_action + # Specifies the most disruptive action that can be taken on the instance as part + # of the update. Compute Engine returns an error if the instance properties + # require a more disruptive action as part of the instance update. Valid options + # from lowest to highest are NO_EFFECT, REFRESH, and RESTART. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_instance(project, zone, instance, instance_object = nil, minimal_action: nil, most_disruptive_allowed_action: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, '{project}/zones/{zone}/instances/{instance}', options) + command.request_representation = Google::Apis::ComputeBeta::Instance::Representation + command.request_object = instance_object + command.response_representation = Google::Apis::ComputeBeta::Operation::Representation + command.response_class = Google::Apis::ComputeBeta::Operation + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['instance'] = instance unless instance.nil? + command.query['minimalAction'] = minimal_action unless minimal_action.nil? + command.query['mostDisruptiveAllowedAction'] = most_disruptive_allowed_action unless most_disruptive_allowed_action.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Updates the specified access config from an instance's network interface with # the data included in the request. This method supports PATCH semantics and # uses the JSON merge patch format and processing rules. @@ -11712,19 +12113,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -11734,21 +12135,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -11939,36 +12340,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -12202,36 +12603,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -12443,36 +12844,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -12640,7 +13041,9 @@ module Google end # Return a specified license code. License codes are mirrored across all - # projects that have permissions to read the License Code. + # projects that have permissions to read the License Code. Caution This + # resource is intended for use only by third-party partners who are creating + # Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] license_code @@ -12676,7 +13079,8 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified license. + # Deletes the specified license. Caution This resource is intended for use only + # by third-party partners who are creating Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] license @@ -12724,7 +13128,8 @@ module Google execute_or_queue_command(command, &block) end - # Returns the specified License resource. + # Returns the specified License resource. Caution This resource is intended for + # use only by third-party partners who are creating Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] license @@ -12761,7 +13166,8 @@ module Google end # Gets the access control policy for a resource. May be empty if no such policy - # or resource exists. + # or resource exists. Caution This resource is intended for use only by third- + # party partners who are creating Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] resource @@ -12800,7 +13206,9 @@ module Google execute_or_queue_command(command, &block) end - # Create a License resource in the specified project. + # Create a License resource in the specified project. Caution This resource is + # intended for use only by third-party partners who are creating Cloud + # Marketplace images. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeBeta::License] license_object @@ -12852,43 +13260,45 @@ module Google # does not get any licenses that belong to other projects, including licenses # attached to publicly-available images, like Debian 9. If you want to get a # list of publicly-available licenses, use this method to make a request to the - # respective image project, such as debian-cloud or windows-cloud. + # respective image project, such as debian-cloud or windows-cloud. Caution This + # resource is intended for use only by third-party partners who are creating + # Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] filter # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -12924,7 +13334,8 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. + # existing policy. Caution This resource is intended for use only by third- + # party partners who are creating Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] resource @@ -13151,36 +13562,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -13301,19 +13712,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -13323,21 +13734,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -13422,36 +13833,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -13494,19 +13905,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -13516,21 +13927,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -13839,36 +14250,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -13918,36 +14329,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -14164,6 +14575,42 @@ module Google execute_or_queue_command(command, &block) end + # Returns the effective firewalls on a given network. + # @param [String] project + # Project ID for this request. + # @param [String] network + # Name of the network for this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::NetworksGetEffectiveFirewallsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::NetworksGetEffectiveFirewallsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_network_effective_firewalls(project, network, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/global/networks/{network}/getEffectiveFirewalls', options) + command.response_representation = Google::Apis::ComputeBeta::NetworksGetEffectiveFirewallsResponse::Representation + command.response_class = Google::Apis::ComputeBeta::NetworksGetEffectiveFirewallsResponse + command.params['project'] = project unless project.nil? + command.params['network'] = network unless network.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Creates a network in the specified project using the data included in the # request. # @param [String] project @@ -14220,36 +14667,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -14295,36 +14742,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] peering_name # The response will show routes exchanged over the given peering connection. # @param [String] region @@ -14673,19 +15120,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -14695,21 +15142,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -14999,36 +15446,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -15075,36 +15522,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -15341,19 +15788,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -15363,21 +15810,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -15608,36 +16055,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -15765,19 +16212,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -15787,21 +16234,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -15886,36 +16333,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -15951,6 +16398,701 @@ module Google execute_or_queue_command(command, &block) end + # Inserts an association for the specified security policy. + # @param [String] security_policy + # Name of the security policy to update. + # @param [Google::Apis::ComputeBeta::SecurityPolicyAssociation] security_policy_association_object + # @param [Boolean] replace_existing_association + # Indicates whether or not to replace it if an association of the attachment + # already exists. This is false by default, in which case an error will be + # returned if an assocation already exists. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def add_organization_security_policy_association(security_policy, security_policy_association_object = nil, replace_existing_association: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'locations/global/securityPolicies/{securityPolicy}/addAssociation', options) + command.request_representation = Google::Apis::ComputeBeta::SecurityPolicyAssociation::Representation + command.request_object = security_policy_association_object + command.response_representation = Google::Apis::ComputeBeta::Operation::Representation + command.response_class = Google::Apis::ComputeBeta::Operation + command.params['securityPolicy'] = security_policy unless security_policy.nil? + command.query['replaceExistingAssociation'] = replace_existing_association unless replace_existing_association.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a rule into a security policy. + # @param [String] security_policy + # Name of the security policy to update. + # @param [Google::Apis::ComputeBeta::SecurityPolicyRule] security_policy_rule_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def add_organization_security_policy_rule(security_policy, security_policy_rule_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'locations/global/securityPolicies/{securityPolicy}/addRule', options) + command.request_representation = Google::Apis::ComputeBeta::SecurityPolicyRule::Representation + command.request_object = security_policy_rule_object + command.response_representation = Google::Apis::ComputeBeta::Operation::Representation + command.response_class = Google::Apis::ComputeBeta::Operation + command.params['securityPolicy'] = security_policy unless security_policy.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Copies rules to the specified security policy. + # @param [String] security_policy + # Name of the security policy to update. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] source_security_policy + # The security policy from which to copy rules. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def copy_organization_security_policy_rules(security_policy, request_id: nil, source_security_policy: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'locations/global/securityPolicies/{securityPolicy}/copyRules', options) + command.response_representation = Google::Apis::ComputeBeta::Operation::Representation + command.response_class = Google::Apis::ComputeBeta::Operation + command.params['securityPolicy'] = security_policy unless security_policy.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['sourceSecurityPolicy'] = source_security_policy unless source_security_policy.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified policy. + # @param [String] security_policy + # Name of the security policy to delete. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_organization_security_policy(security_policy, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'locations/global/securityPolicies/{securityPolicy}', options) + command.response_representation = Google::Apis::ComputeBeta::Operation::Representation + command.response_class = Google::Apis::ComputeBeta::Operation + command.params['securityPolicy'] = security_policy unless security_policy.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # List all of the ordered rules present in a single specified policy. + # @param [String] security_policy + # Name of the security policy to get. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::SecurityPolicy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::SecurityPolicy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_security_policy(security_policy, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'locations/global/securityPolicies/{securityPolicy}', options) + command.response_representation = Google::Apis::ComputeBeta::SecurityPolicy::Representation + command.response_class = Google::Apis::ComputeBeta::SecurityPolicy + command.params['securityPolicy'] = security_policy unless security_policy.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets an association with the specified name. + # @param [String] security_policy + # Name of the security policy to which the queried rule belongs. + # @param [String] name + # The name of the association to get from the security policy. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::SecurityPolicyAssociation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::SecurityPolicyAssociation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_security_policy_association(security_policy, name: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'locations/global/securityPolicies/{securityPolicy}/getAssociation', options) + command.response_representation = Google::Apis::ComputeBeta::SecurityPolicyAssociation::Representation + command.response_class = Google::Apis::ComputeBeta::SecurityPolicyAssociation + command.params['securityPolicy'] = security_policy unless security_policy.nil? + command.query['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets a rule at the specified priority. + # @param [String] security_policy + # Name of the security policy to which the queried rule belongs. + # @param [Fixnum] priority + # The priority of the rule to get from the security policy. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::SecurityPolicyRule] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::SecurityPolicyRule] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_organization_security_policy_rule(security_policy, priority: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'locations/global/securityPolicies/{securityPolicy}/getRule', options) + command.response_representation = Google::Apis::ComputeBeta::SecurityPolicyRule::Representation + command.response_class = Google::Apis::ComputeBeta::SecurityPolicyRule + command.params['securityPolicy'] = security_policy unless security_policy.nil? + command.query['priority'] = priority unless priority.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new policy in the specified project using the data included in the + # request. + # @param [Google::Apis::ComputeBeta::SecurityPolicy] security_policy_object + # @param [String] parent_id + # Parent ID for this request. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_organization_security_policy(security_policy_object = nil, parent_id: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'locations/global/securityPolicies', options) + command.request_representation = Google::Apis::ComputeBeta::SecurityPolicy::Representation + command.request_object = security_policy_object + command.response_representation = Google::Apis::ComputeBeta::Operation::Representation + command.response_class = Google::Apis::ComputeBeta::Operation + command.query['parentId'] = parent_id unless parent_id.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # List all the policies that have been configured for the specified project. + # @param [String] filter + # A filter expression that filters resources listed in the response. The + # expression must specify the field name, a comparison operator, and the value + # that you want to use for filtering. The value must be a string, a number, or a + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. + # For example, if you are filtering Compute Engine instances, you can exclude + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled + # for automatic restarts. You can use filtering on nested fields to filter based + # on resource labels. + # To filter on multiple expressions, provide each separate expression within + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Fixnum] max_results + # The maximum number of results per page that should be returned. If the number + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + # @param [String] order_by + # Sorts list results by a certain order. By default, results are returned in + # alphanumerical order based on the resource name. + # You can also sort results in descending order based on the creation timestamp + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). + # Use this to sort resources like operations so that the newest operation is + # returned first. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. + # @param [String] page_token + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [String] parent_id + # Parent ID for this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::SecurityPolicyList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::SecurityPolicyList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_security_policies(filter: nil, max_results: nil, order_by: nil, page_token: nil, parent_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'locations/global/securityPolicies', options) + command.response_representation = Google::Apis::ComputeBeta::SecurityPolicyList::Representation + command.response_class = Google::Apis::ComputeBeta::SecurityPolicyList + command.query['filter'] = filter unless filter.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['parentId'] = parent_id unless parent_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Lists associations of a specified target, i.e., organization or folder. + # @param [String] target_resource + # The target resource to list associations. It is an organization, or a folder. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::OrganizationSecurityPoliciesListAssociationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::OrganizationSecurityPoliciesListAssociationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_organization_security_policy_associations(target_resource: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'locations/global/securityPolicies/listAssociations', options) + command.response_representation = Google::Apis::ComputeBeta::OrganizationSecurityPoliciesListAssociationsResponse::Representation + command.response_class = Google::Apis::ComputeBeta::OrganizationSecurityPoliciesListAssociationsResponse + command.query['targetResource'] = target_resource unless target_resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Moves the specified security policy. + # @param [String] security_policy + # Name of the security policy to update. + # @param [String] parent_id + # The new parent of the security policy. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def move_organization_security_policy(security_policy, parent_id: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'locations/global/securityPolicies/{securityPolicy}/move', options) + command.response_representation = Google::Apis::ComputeBeta::Operation::Representation + command.response_class = Google::Apis::ComputeBeta::Operation + command.params['securityPolicy'] = security_policy unless security_policy.nil? + command.query['parentId'] = parent_id unless parent_id.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Patches the specified policy with the data included in the request. + # @param [String] security_policy + # Name of the security policy to update. + # @param [Google::Apis::ComputeBeta::SecurityPolicy] security_policy_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_organization_security_policy(security_policy, security_policy_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'locations/global/securityPolicies/{securityPolicy}', options) + command.request_representation = Google::Apis::ComputeBeta::SecurityPolicy::Representation + command.request_object = security_policy_object + command.response_representation = Google::Apis::ComputeBeta::Operation::Representation + command.response_class = Google::Apis::ComputeBeta::Operation + command.params['securityPolicy'] = security_policy unless security_policy.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Patches a rule at the specified priority. + # @param [String] security_policy + # Name of the security policy to update. + # @param [Google::Apis::ComputeBeta::SecurityPolicyRule] security_policy_rule_object + # @param [Fixnum] priority + # The priority of the rule to patch. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_organization_security_policy_rule(security_policy, security_policy_rule_object = nil, priority: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'locations/global/securityPolicies/{securityPolicy}/patchRule', options) + command.request_representation = Google::Apis::ComputeBeta::SecurityPolicyRule::Representation + command.request_object = security_policy_rule_object + command.response_representation = Google::Apis::ComputeBeta::Operation::Representation + command.response_class = Google::Apis::ComputeBeta::Operation + command.params['securityPolicy'] = security_policy unless security_policy.nil? + command.query['priority'] = priority unless priority.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Removes an association for the specified security policy. + # @param [String] security_policy + # Name of the security policy to update. + # @param [String] name + # Name for the attachment that will be removed. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def remove_organization_security_policy_association(security_policy, name: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'locations/global/securityPolicies/{securityPolicy}/removeAssociation', options) + command.response_representation = Google::Apis::ComputeBeta::Operation::Representation + command.response_class = Google::Apis::ComputeBeta::Operation + command.params['securityPolicy'] = security_policy unless security_policy.nil? + command.query['name'] = name unless name.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a rule at the specified priority. + # @param [String] security_policy + # Name of the security policy to update. + # @param [Fixnum] priority + # The priority of the rule to remove from the security policy. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def remove_organization_security_policy_rule(security_policy, priority: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'locations/global/securityPolicies/{securityPolicy}/removeRule', options) + command.response_representation = Google::Apis::ComputeBeta::Operation::Representation + command.response_class = Google::Apis::ComputeBeta::Operation + command.params['securityPolicy'] = security_policy unless security_policy.nil? + command.query['priority'] = priority unless priority.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Retrieves an aggregated list of packetMirrorings. # @param [String] project # Project ID for this request. @@ -15958,19 +17100,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -15980,21 +17122,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -16182,36 +17324,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -16608,36 +17750,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -16664,7 +17806,7 @@ module Google command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.nil? - command.query['order_by'] = order_by unless order_by.nil? + command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? @@ -16680,36 +17822,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -16738,7 +17880,7 @@ module Google command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.nil? - command.query['order_by'] = order_by unless order_by.nil? + command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? @@ -17142,36 +18284,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -17493,8 +18635,8 @@ module Google # Creates a regional BackendService resource in the specified project using the # data included in the request. There are several restrictions and guidelines to - # keep in mind when creating a regional backend service. Read Restrictions and - # Guidelines for more information. + # keep in mind when creating a regional backend service. Read Understanding + # backend services for more information. # @param [String] project # Project ID for this request. # @param [String] region @@ -17555,36 +18697,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -17621,9 +18763,9 @@ module Google end # Updates the specified regional BackendService resource with the data included - # in the request. There are several restrictions and guidelines to keep in mind - # when updating a backend service. Read Restrictions and Guidelines for more - # information. This method supports PATCH semantics and uses the JSON merge + # in the request. There are several Understanding backend services to keep in + # mind when updating a backend service. Read Understanding backend services for + # more information. This method supports PATCH semantics and uses the JSON merge # patch format and processing rules. # @param [String] project # Project ID for this request. @@ -17721,9 +18863,9 @@ module Google end # Updates the specified regional BackendService resource with the data included - # in the request. There are several restrictions and guidelines to keep in mind - # when updating a backend service. Read Restrictions and Guidelines for more - # information. + # in the request. There are several Understanding backend services to keep in + # mind when updating a backend service. Read Understanding backend services for + # more information. # @param [String] project # Project ID for this request. # @param [String] region @@ -17784,19 +18926,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -17806,21 +18948,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -17957,36 +19099,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -18125,36 +19267,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -18499,36 +19641,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -18965,36 +20107,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -19239,36 +20381,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -19845,36 +20987,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -19924,36 +21066,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -20003,36 +21145,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -20061,7 +21203,7 @@ module Google command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.nil? - command.query['order_by'] = order_by unless order_by.nil? + command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? @@ -20080,36 +21222,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -20756,36 +21898,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -20835,36 +21977,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -21150,36 +22292,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -21300,36 +22442,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -21365,17 +22507,17 @@ module Google execute_or_queue_command(command, &block) end - # Waits for the specified Operation resource to return as DONE or for the + # Waits for the specified Operation resource to return as `DONE` or for the # request to approach the 2 minute deadline, and retrieves the specified - # Operation resource. This method differs from the GET method in that it waits + # Operation resource. This method differs from the `GET` method in that it waits # for no more than the default deadline (2 minutes) and then returns the current - # state of the operation, which might be DONE or still in progress. + # state of the operation, which might be `DONE` or still in progress. # This method is called on a best-effort basis. Specifically: # - In uncommon cases, when the server is overloaded, the request might return # before the default deadline is reached, or might return after zero seconds. # - If the default deadline is reached, there is no guarantee that the operation # is actually done when the method returns. Be prepared to retry if the - # operation is not DONE. + # operation is not `DONE`. # @param [String] project # Project ID for this request. # @param [String] region @@ -21567,36 +22709,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -21785,36 +22927,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -22057,36 +23199,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -22411,36 +23553,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -22655,36 +23797,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -22726,19 +23868,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -22748,21 +23890,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -22993,36 +24135,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -23205,19 +24347,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -23227,21 +24369,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -23471,36 +24613,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -23628,19 +24770,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -23650,21 +24792,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -23803,24 +24945,24 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] nat_name # Name of the nat service to filter the Nat Mapping information. If it is # omitted, all nats for this router will be returned. Name should conform to @@ -23829,14 +24971,14 @@ module Google # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -23974,36 +25116,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -24378,36 +25520,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -24705,36 +25847,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -24777,36 +25919,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -25192,36 +26334,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -25383,19 +26525,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -25405,21 +26547,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -25597,36 +26739,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -25843,36 +26985,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -25915,36 +27057,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -26077,19 +27219,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -26099,21 +27241,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -26398,36 +27540,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -26472,36 +27614,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -26538,7 +27680,7 @@ module Google # Patches the specified subnetwork with the data included in the request. Only # certain fields can up updated with a patch request as indicated in the field - # descriptions. You must specify the current fingeprint of the subnetwork + # descriptions. You must specify the current fingerprint of the subnetwork # resource being patched. # @param [String] project # Project ID for this request. @@ -26750,19 +27892,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -26772,21 +27914,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -26964,36 +28106,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -27126,19 +28268,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -27148,21 +28290,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -27340,36 +28482,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -27659,19 +28801,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -27681,21 +28823,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -27884,36 +29026,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -28106,19 +29248,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -28128,21 +29270,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -28373,36 +29515,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -28787,36 +29929,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -29240,36 +30382,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -29413,19 +30555,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -29435,21 +30577,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -29638,36 +30780,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -29808,19 +30950,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -29830,21 +30972,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -30073,36 +31215,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -30327,19 +31469,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -30349,21 +31491,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -30590,36 +31732,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -30717,19 +31859,19 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Boolean] include_all_scopes # Indicates whether every visible scope for each scope type (zone, region, # global) should be included in the response. For new resource types added after @@ -30739,21 +31881,21 @@ module Google # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -30942,36 +32084,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -31189,36 +32331,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -31254,17 +32396,17 @@ module Google execute_or_queue_command(command, &block) end - # Waits for the specified Operation resource to return as DONE or for the + # Waits for the specified Operation resource to return as `DONE` or for the # request to approach the 2 minute deadline, and retrieves the specified - # Operation resource. This method differs from the GET method in that it waits + # Operation resource. This method differs from the `GET` method in that it waits # for no more than the default deadline (2 minutes) and then returns the current - # state of the operation, which might be DONE or still in progress. + # state of the operation, which might be `DONE` or still in progress. # This method is called on a best-effort basis. Specifically: # - In uncommon cases, when the server is overloaded, the request might return # before the default deadline is reached, or might return after zero seconds. # - If the default deadline is reached, there is no guarantee that the operation # is actually done when the method returns. Be prepared to retry if the - # operation is not DONE. + # operation is not `DONE`. # @param [String] project # Project ID for this request. # @param [String] zone @@ -31347,36 +32489,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/compute_v1.rb b/generated/google/apis/compute_v1.rb index 0160629e0..c19095ef6 100644 --- a/generated/google/apis/compute_v1.rb +++ b/generated/google/apis/compute_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/compute/docs/reference/latest/ module ComputeV1 VERSION = 'V1' - REVISION = '20200120' + REVISION = '20200311' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/compute_v1/classes.rb b/generated/google/apis/compute_v1/classes.rb index f66449afd..cd76e173e 100644 --- a/generated/google/apis/compute_v1/classes.rb +++ b/generated/google/apis/compute_v1/classes.rb @@ -1207,8 +1207,7 @@ module Google # SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and # the request will fail if you attempt to attach a persistent disk in any other # format than SCSI. Local SSDs can use either NVME or SCSI. For performance - # characteristics of SCSI over NVMe, see Local SSD performance. TODO(b/131765817) - # : Update documentation when NVME is supported. + # characteristics of SCSI over NVMe, see Local SSD performance. # Corresponds to the JSON property `interface` # @return [String] attr_accessor :interface @@ -1230,6 +1229,12 @@ module Google # @return [String] attr_accessor :mode + # Initial State for shielded instance, these are public keys which are safe to + # store in public + # Corresponds to the JSON property `shieldedInstanceInitialState` + # @return [Google::Apis::ComputeV1::InitialStateConfig] + attr_accessor :shielded_instance_initial_state + # Specifies a valid partial or full URL to an existing Persistent Disk resource. # When creating a new instance, one of initializeParams.sourceImage or # initializeParams.sourceSnapshot or disks.source is required except for local @@ -1266,6 +1271,7 @@ module Google @kind = args[:kind] if args.key?(:kind) @licenses = args[:licenses] if args.key?(:licenses) @mode = args[:mode] if args.key?(:mode) + @shielded_instance_initial_state = args[:shielded_instance_initial_state] if args.key?(:shielded_instance_initial_state) @source = args[:source] if args.key?(:source) @type = args[:type] if args.key?(:type) end @@ -1285,8 +1291,9 @@ module Google attr_accessor :description # Specifies the disk name. If not specified, the default is to use the name of - # the instance. If the disk with the instance name exists already in the given - # zone/region, a new name will be automatically generated. + # the instance. If a disk with the same name already exists in the given region, + # the existing disk is attached to the new instance and the new disk is not + # created. # Corresponds to the JSON property `diskName` # @return [String] attr_accessor :disk_name @@ -1321,6 +1328,12 @@ module Google # @return [Hash] attr_accessor :labels + # Specifies which action to take on instance update with this disk. Default is + # to use the existing disk. + # Corresponds to the JSON property `onUpdateAction` + # @return [String] + attr_accessor :on_update_action + # Resource policies applied to this disk for automatic snapshot creations. # Specified using the full or partial URL. For instance template, specify only # the resource policy name. @@ -1381,6 +1394,7 @@ module Google @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb) @disk_type = args[:disk_type] if args.key?(:disk_type) @labels = args[:labels] if args.key?(:labels) + @on_update_action = args[:on_update_action] if args.key?(:on_update_action) @resource_policies = args[:resource_policies] if args.key?(:resource_policies) @source_image = args[:source_image] if args.key?(:source_image) @source_image_encryption_key = args[:source_image_encryption_key] if args.key?(:source_image_encryption_key) @@ -1496,8 +1510,8 @@ module Google # Represents an Autoscaler resource. # Google Compute Engine has two Autoscaler resources: - # * [Global](/compute/docs/reference/rest/latest/autoscalers) * [Regional](/ - # compute/docs/reference/rest/latest/regionAutoscalers) + # * [Global](/compute/docs/reference/rest/`$api_version`/autoscalers) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionAutoscalers) # Use autoscalers to automatically add or delete instances from a managed # instance group according to your defined autoscaling policy. For more # information, read Autoscaling Groups of Instances. @@ -2175,8 +2189,8 @@ module Google # service is SSL, TCP, or UDP. # If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and # TCP Proxy load balancers), you must also specify exactly one of the following - # parameters: maxConnections, maxConnectionsPerInstance, or - # maxConnectionsPerEndpoint. + # parameters: maxConnections (except for regional managed instance groups), + # maxConnectionsPerInstance, or maxConnectionsPerEndpoint. # If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/ # UDP load balancers), you cannot specify any additional parameters. # @@ -2184,10 +2198,11 @@ module Google # HTTP requests per second (RPS). # You can use the RATE balancing mode if the protocol for the backend service is # HTTP or HTTPS. You must specify exactly one of the following parameters: - # maxRate, maxRatePerInstance, or maxRatePerEndpoint. + # maxRate (except for regional managed instance groups), maxRatePerInstance, or + # maxRatePerEndpoint. # # - If the load balancing mode is UTILIZATION, the load is spread based on the - # CPU utilization of instances in an instance group. + # backend utilization of instances in an instance group. # You can use the UTILIZATION balancing mode if the loadBalancingScheme of the # backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and # the backends are instance groups. There are no restrictions on the backend @@ -2212,6 +2227,13 @@ module Google # @return [String] attr_accessor :description + # This field designates whether this is a failover backend. More than one + # failover backend can be configured for a given BackendService. + # Corresponds to the JSON property `failover` + # @return [Boolean] + attr_accessor :failover + alias_method :failover?, :failover + # The fully-qualified URL of an instance group or network endpoint group (NEG) # resource. The type of backend that a backend service supports depends on the # backend service's loadBalancingScheme. @@ -2230,12 +2252,13 @@ module Google # @return [String] attr_accessor :group - # Defines a maximum target for simultaneous connections for the entire backend ( - # instance group or NEG). If the backend's balancingMode is UTILIZATION, this is - # an optional parameter. If the backend's balancingMode is CONNECTION, and - # backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, - # you must specify either this parameter, maxConnectionsPerInstance, or - # maxConnectionsPerEndpoint. + # Defines a target maximum number of simultaneous connections that the backend + # can handle. Valid for network endpoint group and instance group backends ( + # except for regional managed instance groups). If the backend's balancingMode + # is UTILIZATION, this is an optional parameter. If the backend's balancingMode + # is CONNECTION, and backend is attached to a backend service whose + # loadBalancingScheme is EXTERNAL, you must specify either this parameter, + # maxConnectionsPerInstance, or maxConnectionsPerEndpoint. # Not available if the backend's balancingMode is RATE. If the # loadBalancingScheme is INTERNAL, then maxConnections is not supported, even # though the backend requires a balancing mode of CONNECTION. @@ -2243,8 +2266,8 @@ module Google # @return [Fixnum] attr_accessor :max_connections - # Defines a maximum target for simultaneous connections for an endpoint of a NEG. - # This is multiplied by the number of endpoints in the NEG to implicitly + # Defines a target maximum number of simultaneous connections for an endpoint of + # a NEG. This is multiplied by the number of endpoints in the NEG to implicitly # calculate a maximum number of target maximum simultaneous connections for the # NEG. If the backend's balancingMode is CONNECTION, and the backend is attached # to a backend service whose loadBalancingScheme is EXTERNAL, you must specify @@ -2256,8 +2279,8 @@ module Google # @return [Fixnum] attr_accessor :max_connections_per_endpoint - # Defines a maximum target for simultaneous connections for a single VM in a - # backend instance group. This is multiplied by the number of instances in the + # Defines a target maximum number of simultaneous connections for a single VM in + # a backend instance group. This is multiplied by the number of instances in the # instance group to implicitly calculate a target maximum number of simultaneous # connections for the whole instance group. If the backend's balancingMode is # UTILIZATION, this is an optional parameter. If the backend's balancingMode is @@ -2271,10 +2294,15 @@ module Google # @return [Fixnum] attr_accessor :max_connections_per_instance - # The max requests per second (RPS) of the group. Can be used with either RATE - # or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, - # either maxRate or maxRatePerInstance must be set. - # This cannot be used for internal load balancing. + # Defines a maximum number of HTTP requests per second (RPS) that the backend + # can handle. Valid for network endpoint group and instance group backends ( + # except for regional managed instance groups). Must not be defined if the + # backend is a managed instance group that uses autoscaling based on load + # balancing. + # If the backend's balancingMode is UTILIZATION, this is an optional parameter. + # If the backend's balancingMode is RATE, you must specify maxRate, + # maxRatePerInstance, or maxRatePerEndpoint. + # Not available if the backend's balancingMode is CONNECTION. # Corresponds to the JSON property `maxRate` # @return [Fixnum] attr_accessor :max_rate @@ -2283,7 +2311,7 @@ module Google # NEG. This is multiplied by the number of endpoints in the NEG to implicitly # calculate a target maximum rate for the NEG. # If the backend's balancingMode is RATE, you must specify either this parameter, - # maxRate, or maxRatePerInstance. + # maxRate (except for regional managed instance groups), or maxRatePerInstance. # Not available if the backend's balancingMode is CONNECTION. # Corresponds to the JSON property `maxRatePerEndpoint` # @return [Float] @@ -2295,17 +2323,18 @@ module Google # instance group. # If the backend's balancingMode is UTILIZATION, this is an optional parameter. # If the backend's balancingMode is RATE, you must specify either this parameter, - # maxRate, or maxRatePerEndpoint. + # maxRate (except for regional managed instance groups), or maxRatePerEndpoint. # Not available if the backend's balancingMode is CONNECTION. # Corresponds to the JSON property `maxRatePerInstance` # @return [Float] attr_accessor :max_rate_per_instance - # Defines the maximum average CPU utilization of a backend VM in an instance + # Defines the maximum average backend utilization of a backend VM in an instance # group. The valid range is [0.0, 1.0]. This is an optional parameter if the # backend's balancingMode is UTILIZATION. # This parameter can be used in conjunction with maxRate, maxRatePerInstance, - # maxConnections, or maxConnectionsPerInstance. + # maxConnections (except for regional managed instance groups), or + # maxConnectionsPerInstance. # Corresponds to the JSON property `maxUtilization` # @return [Float] attr_accessor :max_utilization @@ -2319,6 +2348,7 @@ module Google @balancing_mode = args[:balancing_mode] if args.key?(:balancing_mode) @capacity_scaler = args[:capacity_scaler] if args.key?(:capacity_scaler) @description = args[:description] if args.key?(:description) + @failover = args[:failover] if args.key?(:failover) @group = args[:group] if args.key?(:group) @max_connections = args[:max_connections] if args.key?(:max_connections) @max_connections_per_endpoint = args[:max_connections_per_endpoint] if args.key?(:max_connections_per_endpoint) @@ -2559,8 +2589,8 @@ module Google # balancing services. # Backend services in Google Compute Engine can be either regionally or globally # scoped. - # * [Global](/compute/docs/reference/rest/latest/backendServices) * [Regional](/ - # compute/docs/reference/rest/latest/regionBackendServices) + # * [Global](/compute/docs/reference/rest/`$api_version`/backendServices) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionBackendServices) # For more information, read Backend Services. # (== resource_for `$api_version`.backendService ==) class BackendService @@ -2620,6 +2650,17 @@ module Google attr_accessor :enable_cdn alias_method :enable_cdn?, :enable_cdn + # Applicable only to Failover for Internal TCP/UDP Load Balancing. On failover + # or failback, this field indicates whether connection draining will be honored. + # GCP has a fixed connection draining timeout of 10 minutes. A setting of true + # terminates existing TCP connections to the active pool during failover and + # failback, immediately draining traffic. A setting of false allows existing TCP + # connections to persist, even on VMs no longer in the active pool, for up to + # the duration of the connection draining timeout (10 minutes). + # Corresponds to the JSON property `failoverPolicy` + # @return [Google::Apis::ComputeV1::BackendServiceFailoverPolicy] + attr_accessor :failover_policy + # Fingerprint of this resource. A hash of the contents stored in this object. # This field is used in optimistic locking. This field will be ignored when # inserting a BackendService. An up-to-date fingerprint must be provided in @@ -2632,15 +2673,13 @@ module Google # @return [String] attr_accessor :fingerprint - # The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for - # health checking this BackendService. Currently at most one health check can be - # specified. Health check is optional for Compute Engine backend services if - # there is no backend. A health check must not be specified when adding Internet - # Network Endpoint Group or Serverless Network Endpoint Group as backends. In - # all other cases, a health check is required for Compute Engine backend - # services. - # For internal load balancing, a URL to a HealthCheck resource must be specified - # instead. + # The list of URLs to the healthChecks, httpHealthChecks (legacy), or + # httpsHealthChecks (legacy) resource for health checking this backend service. + # Not all backend services support legacy health checks. See Load balancer + # guide. Currently at most one health check can be specified. Backend services + # with instance group or zonal NEG backends must have a health check. Backend + # services with internet NEG backends must not have a health check. A health + # check must # Corresponds to the JSON property `healthChecks` # @return [Array] attr_accessor :health_checks @@ -2739,9 +2778,9 @@ module Google # A named port on a backend instance group representing the port for # communication to the backend VMs in that group. Required when the - # loadBalancingScheme is EXTERNAL and the backends are instance groups. The - # named port must be defined on each backend instance group. This parameter has - # no meaning if the backends are NEGs. + # loadBalancingScheme is EXTERNAL, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED + # and the backends are instance groups. The named port must be defined on each + # backend instance group. This parameter has no meaning if the backends are NEGs. # Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP # Load Blaancing). # Corresponds to the JSON property `portName` @@ -2749,7 +2788,7 @@ module Google attr_accessor :port_name # The protocol this BackendService uses to communicate with backends. - # Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP, depending on the + # Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP. depending on the # chosen load balancer or Traffic Director configuration. Refer to the # documentation for the load balancer or for Traffic Director for more # information. @@ -2813,6 +2852,7 @@ module Google @custom_request_headers = args[:custom_request_headers] if args.key?(:custom_request_headers) @description = args[:description] if args.key?(:description) @enable_cdn = args[:enable_cdn] if args.key?(:enable_cdn) + @failover_policy = args[:failover_policy] if args.key?(:failover_policy) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @health_checks = args[:health_checks] if args.key?(:health_checks) @iap = args[:iap] if args.key?(:iap) @@ -2990,6 +3030,55 @@ module Google end end + # Applicable only to Failover for Internal TCP/UDP Load Balancing. On failover + # or failback, this field indicates whether connection draining will be honored. + # GCP has a fixed connection draining timeout of 10 minutes. A setting of true + # terminates existing TCP connections to the active pool during failover and + # failback, immediately draining traffic. A setting of false allows existing TCP + # connections to persist, even on VMs no longer in the active pool, for up to + # the duration of the connection draining timeout (10 minutes). + class BackendServiceFailoverPolicy + include Google::Apis::Core::Hashable + + # This can be set to true only if the protocol is TCP. + # The default is false. + # Corresponds to the JSON property `disableConnectionDrainOnFailover` + # @return [Boolean] + attr_accessor :disable_connection_drain_on_failover + alias_method :disable_connection_drain_on_failover?, :disable_connection_drain_on_failover + + # Applicable only to Failover for Internal TCP/UDP Load Balancing. If set to + # true, connections to the load balancer are dropped when all primary and all + # backup backend VMs are unhealthy. If set to false, connections are distributed + # among all primary VMs when all primary and all backup backend VMs are + # unhealthy. + # The default is false. + # Corresponds to the JSON property `dropTrafficIfUnhealthy` + # @return [Boolean] + attr_accessor :drop_traffic_if_unhealthy + alias_method :drop_traffic_if_unhealthy?, :drop_traffic_if_unhealthy + + # Applicable only to Failover for Internal TCP/UDP Load Balancing. The value of + # the field must be in the range [0, 1]. If the value is 0, the load balancer + # performs a failover when the number of healthy primary VMs equals zero. For + # all other values, the load balancer performs a failover when the total number + # of healthy primary VMs is less than this ratio. + # Corresponds to the JSON property `failoverRatio` + # @return [Float] + attr_accessor :failover_ratio + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @disable_connection_drain_on_failover = args[:disable_connection_drain_on_failover] if args.key?(:disable_connection_drain_on_failover) + @drop_traffic_if_unhealthy = args[:drop_traffic_if_unhealthy] if args.key?(:drop_traffic_if_unhealthy) + @failover_ratio = args[:failover_ratio] if args.key?(:failover_ratio) + end + end + # class BackendServiceGroupHealth include Google::Apis::Core::Hashable @@ -4186,6 +4275,12 @@ module Google # @return [String] attr_accessor :kms_key_name + # The service account being used for the encryption request for the given KMS + # key. If absent, the Compute Engine default service account is used. + # Corresponds to the JSON property `kmsKeyServiceAccount` + # @return [String] + attr_accessor :kms_key_service_account + # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 # base64 to either encrypt or decrypt this resource. # Corresponds to the JSON property `rawKey` @@ -4205,6 +4300,7 @@ module Google # Update properties of this object def update!(**args) @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name) + @kms_key_service_account = args[:kms_key_service_account] if args.key?(:kms_key_service_account) @raw_key = args[:raw_key] if args.key?(:raw_key) @sha256 = args[:sha256] if args.key?(:sha256) end @@ -4294,8 +4390,8 @@ module Google # Represents a Persistent Disk resource. # Google Compute Engine has two Disk resources: - # * [Global](/compute/docs/reference/rest/latest/disks) * [Regional](/compute/ - # docs/reference/rest/latest/regionDisks) + # * [Zonal](/compute/docs/reference/rest/`$api_version`/disks) * [Regional](/ + # compute/docs/reference/rest/`$api_version`/regionDisks) # Persistent disks are required for running your VM instances. Create both boot # and non-boot (data) persistent disks. For more information, read Persistent # Disks. For more storage options, read Storage options. @@ -4882,8 +4978,8 @@ module Google # Represents a Disk Type resource. # Google Compute Engine has two Disk Type resources: - # * [Global](/compute/docs/reference/rest/latest/diskTypes) * [Regional](/ - # compute/docs/reference/rest/latest/regionDiskTypes) + # * [Regional](/compute/docs/reference/rest/`$api_version`/regionDiskTypes) * [ + # Zonal](/compute/docs/reference/rest/`$api_version`/diskTypes) # You can choose from a variety of disk types based on your needs. For more # information, read Storage options. # The diskTypes resource represents disk types for a zonal persistent disk. For @@ -6016,6 +6112,32 @@ module Google end end + # + class FileContentBuffer + include Google::Apis::Core::Hashable + + # The raw content in the secure keys file. + # Corresponds to the JSON property `content` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :content + + # + # Corresponds to the JSON property `fileType` + # @return [String] + attr_accessor :file_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content = args[:content] if args.key?(:content) + @file_type = args[:file_type] if args.key?(:file_type) + end + end + # Represents a Firewall Rule resource. # Firewall rules allow or deny ingress traffic to, and egress traffic from your # instances. For more information, read Firewall rules. @@ -6453,8 +6575,8 @@ module Google # Represents a Forwarding Rule resource. # Forwarding rule resources in GCP can be either regional or global in scope: - # * [Global](/compute/docs/reference/rest/latest/globalForwardingRules) * [ - # Regional](/compute/docs/reference/rest/latest/forwardingRules) + # * [Global](/compute/docs/reference/rest/`$api_version`/globalForwardingRules) * + # [Regional](/compute/docs/reference/rest/`$api_version`/forwardingRules) # A forwarding rule and its corresponding IP address represent the frontend # configuration of a Google Cloud Platform load balancer. Forwarding rules can # also reference target instances and Cloud VPN Classic gateways ( @@ -6590,7 +6712,7 @@ module Google # - Internal TCP/UDP load balancers # - INTERNAL_MANAGED is used for: # - Internal HTTP(S) load balancers - # - >INTERNAL_SELF_MANAGED is used for: + # - INTERNAL_SELF_MANAGED is used for: # - Traffic Director # For more information about forwarding rules, refer to Forwarding rule concepts. # Corresponds to the JSON property `loadBalancingScheme` @@ -6635,7 +6757,7 @@ module Google attr_accessor :network # This signifies the networking tier used for configuring this load balancer and - # can only take the following values: PREMIUM , STANDARD. + # can only take the following values: PREMIUM, STANDARD. # For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For # GlobalForwardingRule, the valid value is PREMIUM. # If this field is not specified, it is assumed to be PREMIUM. If IPAddress is @@ -7110,6 +7232,44 @@ module Google end end + # + class GlobalNetworkEndpointGroupsAttachEndpointsRequest + include Google::Apis::Core::Hashable + + # The list of network endpoints to be attached. + # Corresponds to the JSON property `networkEndpoints` + # @return [Array] + attr_accessor :network_endpoints + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @network_endpoints = args[:network_endpoints] if args.key?(:network_endpoints) + end + end + + # + class GlobalNetworkEndpointGroupsDetachEndpointsRequest + include Google::Apis::Core::Hashable + + # The list of network endpoints to be detached. + # Corresponds to the JSON property `networkEndpoints` + # @return [Array] + attr_accessor :network_endpoints + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @network_endpoints = args[:network_endpoints] if args.key?(:network_endpoints) + end + end + # class GlobalSetLabelsRequest include Google::Apis::Core::Hashable @@ -7541,8 +7701,8 @@ module Google # Represents a Health Check resource. # Google Compute Engine has two Health Check resources: - # * [Global](/compute/docs/reference/rest/latest/healthChecks) * [Regional](/ - # compute/docs/reference/rest/latest/regionHealthChecks) + # * [Global](/compute/docs/reference/rest/`$api_version`/healthChecks) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionHealthChecks) # Internal HTTP(S) load balancers use regional health checks. All other types of # GCP load balancers and managed instance group auto-healing use global health # checks. For more information, read Health Check Concepts. @@ -8119,9 +8279,10 @@ module Google # @return [String] attr_accessor :description - # The list of host patterns to match. They must be valid hostnames, except * - # will match any string of ([a-z0-9-.]*). In that case, * must be the first - # character and must be followed in the pattern by either - or .. + # The list of host patterns to match. They must be valid hostnames with optional + # port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). + # In that case, * must be the first character and must be followed in the + # pattern by either - or .. # Corresponds to the JSON property `hosts` # @return [Array] attr_accessor :hosts @@ -9388,6 +9549,12 @@ module Google # @return [String] attr_accessor :self_link + # Initial State for shielded instance, these are public keys which are safe to + # store in public + # Corresponds to the JSON property `shieldedInstanceInitialState` + # @return [Google::Apis::ComputeV1::InitialStateConfig] + attr_accessor :shielded_instance_initial_state + # URL of the source disk used to create this image. This can be a full or valid # partial URL. You must provide either this property or the rawDisk.source # property but not both to create an image. For example, the following are valid @@ -9497,6 +9664,7 @@ module Google @name = args[:name] if args.key?(:name) @raw_disk = args[:raw_disk] if args.key?(:raw_disk) @self_link = args[:self_link] if args.key?(:self_link) + @shielded_instance_initial_state = args[:shielded_instance_initial_state] if args.key?(:shielded_instance_initial_state) @source_disk = args[:source_disk] if args.key?(:source_disk) @source_disk_encryption_key = args[:source_disk_encryption_key] if args.key?(:source_disk_encryption_key) @source_disk_id = args[:source_disk_id] if args.key?(:source_disk_id) @@ -9664,6 +9832,44 @@ module Google end end + # Initial State for shielded instance, these are public keys which are safe to + # store in public + class InitialStateConfig + include Google::Apis::Core::Hashable + + # The Key Database (db). + # Corresponds to the JSON property `dbs` + # @return [Array] + attr_accessor :dbs + + # The forbidden key database (dbx). + # Corresponds to the JSON property `dbxs` + # @return [Array] + attr_accessor :dbxs + + # The Key Exchange Key (KEK). + # Corresponds to the JSON property `keks` + # @return [Array] + attr_accessor :keks + + # The Platform Key (PK). + # Corresponds to the JSON property `pk` + # @return [Google::Apis::ComputeV1::FileContentBuffer] + attr_accessor :pk + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dbs = args[:dbs] if args.key?(:dbs) + @dbxs = args[:dbxs] if args.key?(:dbxs) + @keks = args[:keks] if args.key?(:keks) + @pk = args[:pk] if args.key?(:pk) + end + end + # Represents an Instance resource. # An instance is a virtual machine that is hosted on Google Cloud Platform. For # more information, read Virtual Machine Instances. (== resource_for `$ @@ -9712,6 +9918,17 @@ module Google # @return [Google::Apis::ComputeV1::DisplayDevice] attr_accessor :display_device + # Specifies a fingerprint for this resource, which is essentially a hash of the + # instance's contents and used for optimistic locking. The fingerprint is + # initially generated by Compute Engine and changes after every request to + # modify or update the instance. You must always provide an up-to-date + # fingerprint hash in order to update the instance. + # To see the latest fingerprint, make get() request to the instance. + # Corresponds to the JSON property `fingerprint` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :fingerprint + # A list of the type and count of accelerator cards attached to the instance. # Corresponds to the JSON property `guestAccelerators` # @return [Array] @@ -9805,7 +10022,12 @@ module Google # @return [Google::Apis::ComputeV1::ReservationAffinity] attr_accessor :reservation_affinity - # Sets the scheduling options for an Instance. NextID: 9 + # Resource policies applied to this instance. + # Corresponds to the JSON property `resourcePolicies` + # @return [Array] + attr_accessor :resource_policies + + # Sets the scheduling options for an Instance. NextID: 10 # Corresponds to the JSON property `scheduling` # @return [Google::Apis::ComputeV1::Scheduling] attr_accessor :scheduling @@ -9879,6 +10101,7 @@ module Google @description = args[:description] if args.key?(:description) @disks = args[:disks] if args.key?(:disks) @display_device = args[:display_device] if args.key?(:display_device) + @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators) @hostname = args[:hostname] if args.key?(:hostname) @id = args[:id] if args.key?(:id) @@ -9891,6 +10114,7 @@ module Google @name = args[:name] if args.key?(:name) @network_interfaces = args[:network_interfaces] if args.key?(:network_interfaces) @reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity) + @resource_policies = args[:resource_policies] if args.key?(:resource_policies) @scheduling = args[:scheduling] if args.key?(:scheduling) @self_link = args[:self_link] if args.key?(:self_link) @service_accounts = args[:service_accounts] if args.key?(:service_accounts) @@ -10911,6 +11135,12 @@ module Google class InstanceGroupManagerStatus include Google::Apis::Core::Hashable + # [Output Only] The URL of the Autoscaler that targets this instance group + # manager. + # Corresponds to the JSON property `autoscaler` + # @return [String] + attr_accessor :autoscaler + # [Output Only] A bit indicating whether the managed instance group is in a # stable state. A stable state means that: none of the instances in the managed # instance group is currently undergoing any type of change (for example, @@ -10934,6 +11164,7 @@ module Google # Update properties of this object def update!(**args) + @autoscaler = args[:autoscaler] if args.key?(:autoscaler) @is_stable = args[:is_stable] if args.key?(:is_stable) @version_target = args[:version_target] if args.key?(:version_target) end @@ -10995,6 +11226,11 @@ module Google # @return [String] attr_accessor :minimal_action + # What action should be used to replace instances. See minimal_action.REPLACE + # Corresponds to the JSON property `replacementMethod` + # @return [String] + attr_accessor :replacement_method + # The type of update process. You can specify either PROACTIVE so that the # instance group manager proactively executes actions in order to bring # instances to their target versions or OPPORTUNISTIC so that no action is @@ -11014,6 +11250,7 @@ module Google @max_surge = args[:max_surge] if args.key?(:max_surge) @max_unavailable = args[:max_unavailable] if args.key?(:max_unavailable) @minimal_action = args[:minimal_action] if args.key?(:minimal_action) + @replacement_method = args[:replacement_method] if args.key?(:replacement_method) @type = args[:type] if args.key?(:type) end end @@ -11158,6 +11395,35 @@ module Google end end + # + class InstanceGroupManagersListErrorsResponse + include Google::Apis::Core::Hashable + + # [Output Only] The list of errors of the managed instance group. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. + # 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) + @items = args[:items] if args.key?(:items) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + # class InstanceGroupManagersListManagedInstancesResponse include Google::Apis::Core::Hashable @@ -11167,6 +11433,15 @@ module Google # @return [Array] attr_accessor :managed_instances + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + def initialize(**args) update!(**args) end @@ -11174,6 +11449,7 @@ module Google # Update properties of this object def update!(**args) @managed_instances = args[:managed_instances] if args.key?(:managed_instances) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end @@ -11880,6 +12156,101 @@ module Google end end + # + class InstanceManagedByIgmError + include Google::Apis::Core::Hashable + + # [Output Only] Contents of the error. + # Corresponds to the JSON property `error` + # @return [Google::Apis::ComputeV1::InstanceManagedByIgmErrorManagedInstanceError] + attr_accessor :error + + # [Output Only] Details of the instance action that triggered this error. May be + # null, if the error was not caused by an action on an instance. This field is + # optional. + # Corresponds to the JSON property `instanceActionDetails` + # @return [Google::Apis::ComputeV1::InstanceManagedByIgmErrorInstanceActionDetails] + attr_accessor :instance_action_details + + # [Output Only] The time that this error occurred. This value is in RFC3339 text + # format. + # Corresponds to the JSON property `timestamp` + # @return [String] + attr_accessor :timestamp + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @error = args[:error] if args.key?(:error) + @instance_action_details = args[:instance_action_details] if args.key?(:instance_action_details) + @timestamp = args[:timestamp] if args.key?(:timestamp) + end + end + + # + class InstanceManagedByIgmErrorInstanceActionDetails + include Google::Apis::Core::Hashable + + # [Output Only] Action that managed instance group was executing on the instance + # when the error occurred. Possible values: + # Corresponds to the JSON property `action` + # @return [String] + attr_accessor :action + + # [Output Only] The URL of the instance. The URL can be set even if the instance + # has not yet been created. + # Corresponds to the JSON property `instance` + # @return [String] + attr_accessor :instance + + # [Output Only] Version this instance was created from, or was being created + # from, but the creation failed. Corresponds to one of the versions that were + # set on the Instance Group Manager resource at the time this instance was being + # created. + # Corresponds to the JSON property `version` + # @return [Google::Apis::ComputeV1::ManagedInstanceVersion] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action = args[:action] if args.key?(:action) + @instance = args[:instance] if args.key?(:instance) + @version = args[:version] if args.key?(:version) + end + end + + # + class InstanceManagedByIgmErrorManagedInstanceError + include Google::Apis::Core::Hashable + + # [Output Only] Error code. + # Corresponds to the JSON property `code` + # @return [String] + attr_accessor :code + + # [Output Only] Error 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) + @code = args[:code] if args.key?(:code) + @message = args[:message] if args.key?(:message) + end + end + # class MoveInstanceRequest include Google::Apis::Core::Hashable @@ -11981,7 +12352,13 @@ module Google # @return [Google::Apis::ComputeV1::ReservationAffinity] attr_accessor :reservation_affinity - # Sets the scheduling options for an Instance. NextID: 9 + # Resource policies (names, not ULRs) applied to instances created from this + # template. + # Corresponds to the JSON property `resourcePolicies` + # @return [Array] + attr_accessor :resource_policies + + # Sets the scheduling options for an Instance. NextID: 10 # Corresponds to the JSON property `scheduling` # @return [Google::Apis::ComputeV1::Scheduling] attr_accessor :scheduling @@ -12019,6 +12396,7 @@ module Google @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform) @network_interfaces = args[:network_interfaces] if args.key?(:network_interfaces) @reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity) + @resource_policies = args[:resource_policies] if args.key?(:resource_policies) @scheduling = args[:scheduling] if args.key?(:scheduling) @service_accounts = args[:service_accounts] if args.key?(:service_accounts) @shielded_instance_config = args[:shielded_instance_config] if args.key?(:shielded_instance_config) @@ -12279,6 +12657,44 @@ module Google end end + # + class InstancesAddResourcePoliciesRequest + include Google::Apis::Core::Hashable + + # Resource policies to be added to this instance. + # Corresponds to the JSON property `resourcePolicies` + # @return [Array] + attr_accessor :resource_policies + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_policies = args[:resource_policies] if args.key?(:resource_policies) + end + end + + # + class InstancesRemoveResourcePoliciesRequest + include Google::Apis::Core::Hashable + + # Resource policies to be removed from this instance. + # Corresponds to the JSON property `resourcePolicies` + # @return [Array] + attr_accessor :resource_policies + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_policies = args[:resource_policies] if args.key?(:resource_policies) + end + end + # class InstancesScopedList include Google::Apis::Core::Hashable @@ -14065,7 +14481,11 @@ module Google end end - # A license resource. + # Represents a License resource. + # A License represents billing and aggregate usage data for public and + # marketplace images. Caution This resource is intended for use only by third- + # party partners who are creating Cloud Marketplace images. (== resource_for `$ + # api_version`.licenses ==) class License include Google::Apis::Core::Hashable @@ -14146,7 +14566,11 @@ module Google end end - # + # Represents a License Code resource. + # A License Code is a unique identifier used to represent a license resource. + # Caution This resource is intended for use only by third-party partners who are + # creating Cloud Marketplace images. (== resource_for `$api_version`. + # licenseCodes ==) class LicenseCode include Google::Apis::Core::Hashable @@ -14404,8 +14828,6 @@ module Google # Examples: counter ` metric: "/debug_access_count" field: "iam_principal" ` ==> # increment counter /iam/policy/debug_access_count `iam_principal=[value of # IAMContext.principal]` - # TODO(b/141846426): Consider supporting "authority" and "iam_principal" fields - # in the same counter. # Corresponds to the JSON property `counter` # @return [Google::Apis::ComputeV1::LogConfigCounterOptions] attr_accessor :counter @@ -14466,8 +14888,6 @@ module Google # Examples: counter ` metric: "/debug_access_count" field: "iam_principal" ` ==> # increment counter /iam/policy/debug_access_count `iam_principal=[value of # IAMContext.principal]` - # TODO(b/141846426): Consider supporting "authority" and "iam_principal" fields - # in the same counter. class LogConfigCounterOptions include Google::Apis::Core::Hashable @@ -14531,7 +14951,9 @@ module Google include Google::Apis::Core::Hashable # Whether Gin logging should happen in a fail-closed manner at the caller. This - # is relevant only in the LocalIAM implementation, for now. + # is currently supported in the LocalIAM implementation, Stubby C++, and Stubby + # Java. For Apps Framework, see go/af-audit-logging#failclosed. TODO(b/77591626): + # Add support for Stubby Go. TODO(b/129671387): Add support for Scaffolding. # Corresponds to the JSON property `logMode` # @return [String] attr_accessor :log_mode @@ -15488,6 +15910,12 @@ module Google class NetworkEndpoint include Google::Apis::Core::Hashable + # Optional fully qualified domain name of network endpoint. This can only be + # specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. + # Corresponds to the JSON property `fqdn` + # @return [String] + attr_accessor :fqdn + # The name for a specific VM instance that the IP address belongs to. This is # required for network endpoints of type GCE_VM_IP_PORT. The instance must be in # the same zone of network endpoint group. @@ -15518,6 +15946,7 @@ module Google # Update properties of this object def update!(**args) + @fqdn = args[:fqdn] if args.key?(:fqdn) @instance = args[:instance] if args.key?(:instance) @ip_address = args[:ip_address] if args.key?(:ip_address) @port = args[:port] if args.key?(:port) @@ -15525,8 +15954,8 @@ module Google end # Represents a collection of network endpoints. - # For more information read Setting up network endpoint groups in load balancing. - # (== resource_for `$api_version`.networkEndpointGroups ==) Next ID: 21 + # For more information read Network endpoint groups overview. (== resource_for `$ + # api_version`.networkEndpointGroups ==) Next ID: 21 class NetworkEndpointGroup include Google::Apis::Core::Hashable @@ -15575,8 +16004,7 @@ module Google # @return [String] attr_accessor :network - # Type of network endpoints in this network endpoint group. Currently the only - # supported value is GCE_VM_IP_PORT. + # Type of network endpoints in this network endpoint group. # Corresponds to the JSON property `networkEndpointType` # @return [String] attr_accessor :network_endpoint_type @@ -16559,6 +16987,11 @@ module Google class NodeGroup include Google::Apis::Core::Hashable + # Specifies how autoscaling should behave. + # Corresponds to the JSON property `autoscalingPolicy` + # @return [Google::Apis::ComputeV1::NodeGroupAutoscalingPolicy] + attr_accessor :autoscaling_policy + # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] @@ -16570,6 +17003,12 @@ module Google # @return [String] attr_accessor :description + # + # Corresponds to the JSON property `fingerprint` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :fingerprint + # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` @@ -16582,6 +17021,12 @@ module Google # @return [String] attr_accessor :kind + # Specifies how to handle instances when a node in the group undergoes + # maintenance. + # Corresponds to the JSON property `maintenancePolicy` + # @return [String] + attr_accessor :maintenance_policy + # The name of the resource, provided by the client when initially creating the # resource. The resource name must be 1-63 characters long, and comply with # RFC1035. Specifically, the name must be 1-63 characters long and match the @@ -16625,10 +17070,13 @@ module Google # Update properties of this object def update!(**args) + @autoscaling_policy = args[:autoscaling_policy] if args.key?(:autoscaling_policy) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) + @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) + @maintenance_policy = args[:maintenance_policy] if args.key?(:maintenance_policy) @name = args[:name] if args.key?(:name) @node_template = args[:node_template] if args.key?(:node_template) @self_link = args[:self_link] if args.key?(:self_link) @@ -16756,6 +17204,37 @@ module Google end end + # + class NodeGroupAutoscalingPolicy + include Google::Apis::Core::Hashable + + # The maximum number of nodes that the group should have. + # Corresponds to the JSON property `maxNodes` + # @return [Fixnum] + attr_accessor :max_nodes + + # The minimum number of nodes that the group should have. + # Corresponds to the JSON property `minNodes` + # @return [Fixnum] + attr_accessor :min_nodes + + # The autoscaling mode. + # Corresponds to the JSON property `mode` + # @return [String] + attr_accessor :mode + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @max_nodes = args[:max_nodes] if args.key?(:max_nodes) + @min_nodes = args[:min_nodes] if args.key?(:min_nodes) + @mode = args[:mode] if args.key?(:mode) + end + end + # Contains a list of nodeGroups. class NodeGroupList include Google::Apis::Core::Hashable @@ -16898,6 +17377,11 @@ module Google # @return [Google::Apis::ComputeV1::ServerBinding] attr_accessor :server_binding + # Server ID associated with this node. + # Corresponds to the JSON property `serverId` + # @return [String] + attr_accessor :server_id + # # Corresponds to the JSON property `status` # @return [String] @@ -16913,6 +17397,7 @@ module Google @name = args[:name] if args.key?(:name) @node_type = args[:node_type] if args.key?(:node_type) @server_binding = args[:server_binding] if args.key?(:server_binding) + @server_id = args[:server_id] if args.key?(:server_id) @status = args[:status] if args.key?(:status) end end @@ -17187,7 +17672,7 @@ module Google # Represent a sole-tenant Node Template resource. # You can use a template to define properties for nodes in a node group. For # more information, read Creating node groups and instances. (== resource_for `$ - # api_version`.nodeTemplates ==) (== NextID: 18 ==) + # api_version`.nodeTemplates ==) (== NextID: 19 ==) class NodeTemplate include Google::Apis::Core::Hashable @@ -18077,15 +18562,15 @@ module Google # Represents an Operation resource. # Google Compute Engine has three Operation resources: - # * [Global](/compute/docs/reference/rest/latest/globalOperations) * [Regional](/ - # compute/docs/reference/rest/latest/regionOperations) * [Zonal](/compute/docs/ - # reference/rest/latest/zoneOperations) + # * [Global](/compute/docs/reference/rest/`$api_version`/globalOperations) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionOperations) * [ + # Zonal](/compute/docs/reference/rest/`$api_version`/zoneOperations) # You can use an operation resource to manage asynchronous API requests. For # more information, read Handling API responses. # Operations can be global, regional or zonal. - # - For global operations, use the globalOperations resource. - # - For regional operations, use the regionOperations resource. - # - For zonal operations, use the zonalOperations resource. + # - For global operations, use the `globalOperations` resource. + # - For regional operations, use the `regionOperations` resource. + # - For zonal operations, use the `zonalOperations` resource. # For more information, read Global, Regional, and Zonal Resources. (== # resource_for `$api_version`.globalOperations ==) (== resource_for `$ # api_version`.regionOperations ==) (== resource_for `$api_version`. @@ -18123,13 +18608,13 @@ module Google attr_accessor :error # [Output Only] If the operation fails, this field contains the HTTP error - # message that was returned, such as NOT FOUND. + # message that was returned, such as `NOT FOUND`. # Corresponds to the JSON property `httpErrorMessage` # @return [String] attr_accessor :http_error_message # [Output Only] If the operation fails, this field contains the HTTP error - # status code that was returned. For example, a 404 means the resource was not + # status code that was returned. For example, a `404` means the resource was not # found. # Corresponds to the JSON property `httpErrorStatusCode` # @return [Fixnum] @@ -18147,7 +18632,7 @@ module Google # @return [String] attr_accessor :insert_time - # [Output Only] Type of the resource. Always compute#operation for Operation + # [Output Only] Type of the resource. Always `compute#operation` for Operation # resources. # Corresponds to the JSON property `kind` # @return [String] @@ -18158,8 +18643,8 @@ module Google # @return [String] attr_accessor :name - # [Output Only] The type of operation, such as insert, update, or delete, and so - # on. + # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, + # and so on. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type @@ -18189,8 +18674,8 @@ module Google # @return [String] attr_accessor :start_time - # [Output Only] The status of the operation, which can be one of the following: - # PENDING, RUNNING, or DONE. + # [Output Only] The status of the operation, which can be one of the following: ` + # PENDING`, `RUNNING`, or `DONE`. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -18214,7 +18699,8 @@ module Google # @return [String] attr_accessor :target_link - # [Output Only] User who requested the operation, for example: user@example.com. + # [Output Only] User who requested the operation, for example: `user@example.com` + # . # Corresponds to the JSON property `user` # @return [String] attr_accessor :user @@ -18394,16 +18880,16 @@ module Google # @return [Hash] attr_accessor :items - # [Output Only] Type of resource. Always compute#operationAggregatedList for + # [Output Only] Type of resource. Always `compute#operationAggregatedList` for # aggregated lists of operations. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] This token allows you to get the next page of results for list - # requests. If the number of results is larger than maxResults, use the - # nextPageToken as a value for the query parameter pageToken in the next list - # request. Subsequent list requests will have their own nextPageToken to + # requests. If the number of results is larger than `maxResults`, use the ` + # nextPageToken` as a value for the query parameter `pageToken` in the next list + # request. Subsequent list requests will have their own `nextPageToken` to # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -18513,16 +18999,16 @@ module Google # @return [Array] attr_accessor :items - # [Output Only] Type of resource. Always compute#operations for Operations + # [Output Only] Type of resource. Always `compute#operations` for Operations # resource. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # [Output Only] This token allows you to get the next page of results for list - # requests. If the number of results is larger than maxResults, use the - # nextPageToken as a value for the query parameter pageToken in the next list - # request. Subsequent list requests will have their own nextPageToken to + # requests. If the number of results is larger than `maxResults`, use the ` + # nextPageToken` as a value for the query parameter `pageToken` in the next list + # request. Subsequent list requests will have their own `nextPageToken` to # continue paging through the results. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -19578,21 +20064,21 @@ module Google class PerInstanceConfig include Google::Apis::Core::Hashable - # Fingerprint of this per-instance config. This field may be used in optimistic - # locking. It will be ignored when inserting a per-instance config. An up-to- - # date fingerprint must be provided in order to update an existing per-instance + # Fingerprint of this per-instance config. This field can be used in optimistic + # locking. It is ignored when inserting a per-instance config. An up-to-date + # fingerprint must be provided in order to update an existing per-instance # config or the field needs to be unset. # Corresponds to the JSON property `fingerprint` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :fingerprint - # The name of the per-instance config and the corresponding instance. Serves as - # a merge key during UpdatePerInstanceConfigs operation, i.e. if per-instance - # config with the same name exists then it will be updated, otherwise a new one - # will be created for the VM instance with the same name. An attempt to create a - # per-instance config for a VM instance that either doesn't exist or is not part - # of the group will result in a failure. + # The name of a per-instance config and its corresponding instance. Serves as a + # merge key during UpdatePerInstanceConfigs operations, that is, if a per- + # instance config with the same name exists then it will be updated, otherwise a + # new one will be created for the VM instance with the same name. An attempt to + # create a per-instance config for a VM instance that either doesn't exist or is + # not part of the group will result in an error. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -19718,6 +20204,25 @@ module Google end end + # + class PreconfiguredWafSet + include Google::Apis::Core::Hashable + + # List of entities that are currently supported for WAF rules. + # Corresponds to the JSON property `expressionSets` + # @return [Array] + attr_accessor :expression_sets + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @expression_sets = args[:expression_sets] if args.key?(:expression_sets) + end + end + # Represents a Project resource. # A project is used to organize resources in a Google Cloud Platform environment. # For more information, read about the Resource Hierarchy. (== resource_for `$ @@ -20723,6 +21228,35 @@ module Google end end + # + class RegionInstanceGroupManagersListErrorsResponse + include Google::Apis::Core::Hashable + + # [Output Only] The list of errors of the managed instance group. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. + # 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) + @items = args[:items] if args.key?(:items) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + # class RegionInstanceGroupManagersListInstancesResponse include Google::Apis::Core::Hashable @@ -20732,6 +21266,15 @@ module Google # @return [Array] attr_accessor :managed_instances + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + def initialize(**args) update!(**args) end @@ -20739,6 +21282,7 @@ module Google # Update properties of this object def update!(**args) @managed_instances = args[:managed_instances] if args.key?(:managed_instances) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end @@ -21222,8 +21766,8 @@ module Google # Represents a URL Map resource. # Google Compute Engine has two URL Map resources: - # * [Global](/compute/docs/reference/rest/latest/urlMaps) * [Regional](/compute/ - # docs/reference/rest/latest/regionUrlMaps) + # * [Global](/compute/docs/reference/rest/`$api_version`/urlMaps) * [Regional](/ + # compute/docs/reference/rest/`$api_version`/regionUrlMaps) # A URL map resource is a component of certain types of GCP load balancers and # Traffic Director. # * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * @@ -21896,7 +22440,10 @@ module Google end end - # + # Represents a Resource Policy resource. You can use resource policies to + # schedule actions for some Compute Engine resources. For example, you can use + # them to schedule persistent disk snapshots. + # (== resource_for `$api_version`.resourcePolicies ==) class ResourcePolicy include Google::Apis::Core::Hashable @@ -21910,6 +22457,12 @@ module Google # @return [String] attr_accessor :description + # A GroupPlacementPolicy specifies resource placement configuration. It + # specifies the failure bucket separation as well as network locality + # Corresponds to the JSON property `groupPlacementPolicy` + # @return [Google::Apis::ComputeV1::ResourcePolicyGroupPlacementPolicy] + attr_accessor :group_placement_policy + # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` @@ -21963,6 +22516,7 @@ module Google def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) + @group_placement_policy = args[:group_placement_policy] if args.key?(:group_placement_policy) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @@ -22100,7 +22654,8 @@ module Google class ResourcePolicyDailyCycle include Google::Apis::Core::Hashable - # Defines a schedule that runs every nth day of the month. + # Defines a schedule with units measured in months. The value determines how + # many months pass between the start of each cycle. # Corresponds to the JSON property `daysInCycle` # @return [Fixnum] attr_accessor :days_in_cycle @@ -22130,6 +22685,40 @@ module Google end end + # A GroupPlacementPolicy specifies resource placement configuration. It + # specifies the failure bucket separation as well as network locality + class ResourcePolicyGroupPlacementPolicy + include Google::Apis::Core::Hashable + + # The number of availability domains instances will be spread across. If two + # instances are in different availability domain, they will not be put in the + # same low latency network + # Corresponds to the JSON property `availabilityDomainCount` + # @return [Fixnum] + attr_accessor :availability_domain_count + + # Specifies network collocation + # Corresponds to the JSON property `collocation` + # @return [String] + attr_accessor :collocation + + # Number of vms in this placement group + # Corresponds to the JSON property `vmCount` + # @return [Fixnum] + attr_accessor :vm_count + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @availability_domain_count = args[:availability_domain_count] if args.key?(:availability_domain_count) + @collocation = args[:collocation] if args.key?(:collocation) + @vm_count = args[:vm_count] if args.key?(:vm_count) + end + end + # Time window specified for hourly operations. class ResourcePolicyHourlyCycle include Google::Apis::Core::Hashable @@ -22140,7 +22729,8 @@ module Google # @return [String] attr_accessor :duration - # Allows to define schedule that runs every nth hour. + # Defines a schedule with units measured in hours. The value determines how many + # hours pass between the start of each cycle. # Corresponds to the JSON property `hoursInCycle` # @return [Fixnum] attr_accessor :hours_in_cycle @@ -22435,7 +23025,9 @@ module Google class ResourcePolicyWeeklyCycleDayOfWeek include Google::Apis::Core::Hashable - # Allows to define schedule that runs specified day of the week. + # Defines a schedule that runs on specific days of the week. Specify one or more + # days. The following options are available: MONDAY, TUESDAY, WEDNESDAY, + # THURSDAY, FRIDAY, SATURDAY, SUNDAY. # Corresponds to the JSON property `day` # @return [String] attr_accessor :day @@ -23195,15 +23787,15 @@ module Google attr_accessor :ip_range # URI of the linked Interconnect attachment. It must be in the same region as - # the router. Each interface can have one linked resource, which can be either - # be a VPN tunnel or an Interconnect attachment. + # the router. Each interface can have one linked resource, which can be a VPN + # tunnel, an Interconnect attachment, or a virtual machine instance. # Corresponds to the JSON property `linkedInterconnectAttachment` # @return [String] attr_accessor :linked_interconnect_attachment # URI of the linked VPN tunnel, which must be in the same region as the router. - # Each interface can have one linked resource, which can be either a VPN tunnel - # or an Interconnect attachment. + # Each interface can have one linked resource, which can be a VPN tunnel, an + # Interconnect attachment, or a virtual machine instance. # Corresponds to the JSON property `linkedVpnTunnel` # @return [String] attr_accessor :linked_vpn_tunnel @@ -23985,7 +24577,7 @@ module Google end end - # Sets the scheduling options for an Instance. NextID: 9 + # Sets the scheduling options for an Instance. NextID: 10 class Scheduling include Google::Apis::Core::Hashable @@ -24001,7 +24593,7 @@ module Google alias_method :automatic_restart?, :automatic_restart # A set of node affinity and anti-affinity configurations. Refer to Configuring - # node affinity for more information. + # node affinity for more information. Overrides reservationAffinity. # Corresponds to the JSON property `nodeAffinities` # @return [Array] attr_accessor :node_affinities @@ -24068,6 +24660,44 @@ module Google end end + # + class SecurityPoliciesListPreconfiguredExpressionSetsResponse + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `preconfiguredExpressionSets` + # @return [Google::Apis::ComputeV1::SecurityPoliciesWafConfig] + attr_accessor :preconfigured_expression_sets + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @preconfigured_expression_sets = args[:preconfigured_expression_sets] if args.key?(:preconfigured_expression_sets) + end + end + + # + class SecurityPoliciesWafConfig + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `wafRules` + # @return [Google::Apis::ComputeV1::PreconfiguredWafSet] + attr_accessor :waf_rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @waf_rules = args[:waf_rules] if args.key?(:waf_rules) + end + end + # Represents a Cloud Armor Security Policy resource. # Only external backend services that use load balancers can reference a # Security Policy. For more information, read Cloud Armor Security Policy @@ -24964,16 +25594,19 @@ module Google # Represents an SSL Certificate resource. # Google Compute Engine has two SSL Certificate resources: - # * [Global](/compute/docs/reference/rest/latest/sslCertificates) * [Regional](/ - # compute/docs/reference/rest/latest/regionSslCertificates) - # - sslCertificates are used by: - external HTTPS load balancers - SSL proxy - # load balancers - # - regionSslCertificates are used by: - internal HTTPS load balancers - # This SSL certificate resource also contains a private key. You can use SSL - # keys and certificates to secure connections to a load balancer. For more - # information, read Creating and Using SSL Certificates. (== resource_for `$ - # api_version`.sslCertificates ==) (== resource_for `$api_version`. - # regionSslCertificates ==) Next ID: 17 + # * [Global](/compute/docs/reference/rest/`$api_version`/sslCertificates) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionSslCertificates) + # The sslCertificates are used by: + # - external HTTPS load balancers + # - SSL proxy load balancers + # The regionSslCertificates are used by internal HTTPS load balancers. + # Optionally, certificate file contents that you upload can contain a set of up + # to five PEM-encoded certificates. The API call creates an object ( + # sslCertificate) that holds this data. You can use SSL keys and certificates to + # secure connections to a load balancer. For more information, read Creating + # and using SSL certificates and SSL certificates quotas and limits. (== + # resource_for `$api_version`.sslCertificates ==) (== resource_for `$api_version` + # .regionSslCertificates ==) class SslCertificate include Google::Apis::Core::Hashable @@ -25818,7 +26451,7 @@ module Google # @return [String] attr_accessor :region - # The role of subnetwork. Currenly, this field is only used when purpose = + # The role of subnetwork. Currently, this field is only used when purpose = # INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An # ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) # Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to @@ -26134,6 +26767,12 @@ module Google attr_accessor :enable alias_method :enable?, :enable + # Can only be specified if VPC flow logs for this subnetwork is enabled. Export + # filter used to define which VPC flow logs should be logged. + # Corresponds to the JSON property `filterExpr` + # @return [String] + attr_accessor :filter_expr + # Can only be specified if VPC flow logging for this subnetwork is enabled. The # value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs # within the subnetwork where 1.0 means all collected logs are reported and 0.0 @@ -26150,6 +26789,12 @@ module Google # @return [String] attr_accessor :metadata + # Can only be specified if VPC flow logs for this subnetwork is enabled and " + # metadata" was set to CUSTOM_METADATA. + # Corresponds to the JSON property `metadataFields` + # @return [Array] + attr_accessor :metadata_fields + def initialize(**args) update!(**args) end @@ -26158,8 +26803,10 @@ module Google def update!(**args) @aggregation_interval = args[:aggregation_interval] if args.key?(:aggregation_interval) @enable = args[:enable] if args.key?(:enable) + @filter_expr = args[:filter_expr] if args.key?(:filter_expr) @flow_sampling = args[:flow_sampling] if args.key?(:flow_sampling) @metadata = args[:metadata] if args.key?(:metadata) + @metadata_fields = args[:metadata_fields] if args.key?(:metadata_fields) end end @@ -26514,8 +27161,8 @@ module Google # Represents a Target HTTP Proxy resource. # Google Compute Engine has two Target HTTP Proxy resources: - # * [Global](/compute/docs/reference/rest/latest/targetHttpProxies) * [Regional]( - # /compute/docs/reference/rest/latest/regionTargetHttpProxies) + # * [Global](/compute/docs/reference/rest/`$api_version`/targetHttpProxies) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionTargetHttpProxies) # A target HTTP proxy is a component of GCP HTTP load balancers. # * targetHttpProxies are used by external HTTP load balancers and Traffic # Director. * regionTargetHttpProxies are used by internal HTTP load balancers. @@ -26891,8 +27538,8 @@ module Google # Represents a Target HTTPS Proxy resource. # Google Compute Engine has two Target HTTPS Proxy resources: - # * [Global](/compute/docs/reference/rest/latest/targetHttpsProxies) * [Regional] - # (/compute/docs/reference/rest/latest/regionTargetHttpsProxies) + # * [Global](/compute/docs/reference/rest/`$api_version`/targetHttpsProxies) * [ + # Regional](/compute/docs/reference/rest/`$api_version`/regionTargetHttpsProxies) # A target HTTPS proxy is a component of GCP HTTPS load balancers. # * targetHttpsProxies are used by external HTTPS load balancers. * # regionTargetHttpsProxies are used by internal HTTPS load balancers. @@ -28547,7 +29194,7 @@ module Google # A target TCP proxy is a component of a TCP Proxy load balancer. Global # forwarding rules reference target TCP proxy, and the target proxy then # references an external backend service. For more information, read TCP Proxy - # Load Balancing Concepts. (== resource_for `$api_version`.targetTcpProxies ==) + # Load Balancing overview. (== resource_for `$api_version`.targetTcpProxies ==) class TargetTcpProxy include Google::Apis::Core::Hashable @@ -29236,8 +29883,8 @@ module Google # Represents a URL Map resource. # Google Compute Engine has two URL Map resources: - # * [Global](/compute/docs/reference/rest/latest/urlMaps) * [Regional](/compute/ - # docs/reference/rest/latest/regionUrlMaps) + # * [Global](/compute/docs/reference/rest/`$api_version`/urlMaps) * [Regional](/ + # compute/docs/reference/rest/`$api_version`/regionUrlMaps) # A URL map resource is a component of certain types of GCP load balancers and # Traffic Director. # * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * @@ -29810,8 +30457,8 @@ module Google # Represents a URL Map resource. # Google Compute Engine has two URL Map resources: - # * [Global](/compute/docs/reference/rest/latest/urlMaps) * [Regional](/compute/ - # docs/reference/rest/latest/regionUrlMaps) + # * [Global](/compute/docs/reference/rest/`$api_version`/urlMaps) * [Regional](/ + # compute/docs/reference/rest/`$api_version`/regionUrlMaps) # A URL map resource is a component of certain types of GCP load balancers and # Traffic Director. # * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * @@ -31411,6 +32058,63 @@ module Google end end + # + class WafExpressionSet + include Google::Apis::Core::Hashable + + # A list of alternate IDs. The format should be: - E.g. XSS-stable Generic + # suffix like "stable" is particularly useful if a policy likes to avail newer + # set of expressions without having to change the policy. A given alias name can' + # t be used for more than one entity set. + # Corresponds to the JSON property `aliases` + # @return [Array] + attr_accessor :aliases + + # List of available expressions. + # Corresponds to the JSON property `expressions` + # @return [Array] + attr_accessor :expressions + + # Google specified expression set ID. The format should be: - E.g. XSS-20170329 + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @aliases = args[:aliases] if args.key?(:aliases) + @expressions = args[:expressions] if args.key?(:expressions) + @id = args[:id] if args.key?(:id) + end + end + + # + class WafExpressionSetExpression + include Google::Apis::Core::Hashable + + # Expression ID should uniquely identify the origin of the expression. E.g. + # owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 rule + # id 973337. The ID could be used to determine the individual attack definition + # that has been detected. It could also be used to exclude it from the policy in + # case of false positive. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + end + end + # In contrast to a single BackendService in HttpRouteAction to which all # matching traffic is directed to, WeightedBackendService allows traffic to be # split across multiple BackendServices. The volume of traffic for each diff --git a/generated/google/apis/compute_v1/representations.rb b/generated/google/apis/compute_v1/representations.rb index 7d2974b58..b0371de8d 100644 --- a/generated/google/apis/compute_v1/representations.rb +++ b/generated/google/apis/compute_v1/representations.rb @@ -364,6 +364,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class BackendServiceFailoverPolicy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class BackendServiceGroupHealth class Representation < Google::Apis::Core::JsonRepresentation; end @@ -790,6 +796,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class FileContentBuffer + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Firewall class Representation < Google::Apis::Core::JsonRepresentation; end @@ -904,6 +916,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GlobalNetworkEndpointGroupsAttachEndpointsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GlobalNetworkEndpointGroupsDetachEndpointsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GlobalSetLabelsRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1192,6 +1216,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class InitialStateConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Instance class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1360,6 +1390,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class InstanceGroupManagersListErrorsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class InstanceGroupManagersListManagedInstancesResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1498,6 +1534,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class InstanceManagedByIgmError + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InstanceManagedByIgmErrorInstanceActionDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InstanceManagedByIgmErrorManagedInstanceError + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class MoveInstanceRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1546,6 +1600,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class InstancesAddResourcePoliciesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InstancesRemoveResourcePoliciesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class InstancesScopedList class Representation < Google::Apis::Core::JsonRepresentation; end @@ -2176,6 +2242,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class NodeGroupAutoscalingPolicy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class NodeGroupList class Representation < Google::Apis::Core::JsonRepresentation; end @@ -2590,6 +2662,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class PreconfiguredWafSet + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Project class Representation < Google::Apis::Core::JsonRepresentation; end @@ -2758,6 +2836,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class RegionInstanceGroupManagersListErrorsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class RegionInstanceGroupManagersListInstancesResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -2992,6 +3076,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ResourcePolicyGroupPlacementPolicy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ResourcePolicyHourlyCycle class Representation < Google::Apis::Core::JsonRepresentation; end @@ -3244,6 +3334,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class SecurityPoliciesListPreconfiguredExpressionSetsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SecurityPoliciesWafConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SecurityPolicy class Representation < Google::Apis::Core::JsonRepresentation; end @@ -4324,6 +4426,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class WafExpressionSet + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class WafExpressionSetExpression + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class WeightedBackendService class Representation < Google::Apis::Core::JsonRepresentation; end @@ -4690,6 +4804,8 @@ module Google property :kind, as: 'kind' collection :licenses, as: 'licenses' property :mode, as: 'mode' + property :shielded_instance_initial_state, as: 'shieldedInstanceInitialState', class: Google::Apis::ComputeV1::InitialStateConfig, decorator: Google::Apis::ComputeV1::InitialStateConfig::Representation + property :source, as: 'source' property :type, as: 'type' end @@ -4703,6 +4819,7 @@ module Google property :disk_size_gb, :numeric_string => true, as: 'diskSizeGb' property :disk_type, as: 'diskType' hash :labels, as: 'labels' + property :on_update_action, as: 'onUpdateAction' collection :resource_policies, as: 'resourcePolicies' property :source_image, as: 'sourceImage' property :source_image_encryption_key, as: 'sourceImageEncryptionKey', class: Google::Apis::ComputeV1::CustomerEncryptionKey, decorator: Google::Apis::ComputeV1::CustomerEncryptionKey::Representation @@ -4905,6 +5022,7 @@ module Google property :balancing_mode, as: 'balancingMode' property :capacity_scaler, as: 'capacityScaler' property :description, as: 'description' + property :failover, as: 'failover' property :group, as: 'group' property :max_connections, as: 'maxConnections' property :max_connections_per_endpoint, as: 'maxConnectionsPerEndpoint' @@ -4990,6 +5108,8 @@ module Google collection :custom_request_headers, as: 'customRequestHeaders' property :description, as: 'description' property :enable_cdn, as: 'enableCDN' + property :failover_policy, as: 'failoverPolicy', class: Google::Apis::ComputeV1::BackendServiceFailoverPolicy, decorator: Google::Apis::ComputeV1::BackendServiceFailoverPolicy::Representation + property :fingerprint, :base64 => true, as: 'fingerprint' collection :health_checks, as: 'healthChecks' property :iap, as: 'iap', class: Google::Apis::ComputeV1::BackendServiceIap, decorator: Google::Apis::ComputeV1::BackendServiceIap::Representation @@ -5057,6 +5177,15 @@ module Google end end + class BackendServiceFailoverPolicy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :disable_connection_drain_on_failover, as: 'disableConnectionDrainOnFailover' + property :drop_traffic_if_unhealthy, as: 'dropTrafficIfUnhealthy' + property :failover_ratio, as: 'failoverRatio' + end + end + class BackendServiceGroupHealth # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -5361,6 +5490,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :kms_key_name, as: 'kmsKeyName' + property :kms_key_service_account, as: 'kmsKeyServiceAccount' property :raw_key, as: 'rawKey' property :sha256, as: 'sha256' end @@ -5808,6 +5938,14 @@ module Google end end + class FileContentBuffer + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content, :base64 => true, as: 'content' + property :file_type, as: 'fileType' + end + end + class Firewall # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -6031,6 +6169,22 @@ module Google end end + class GlobalNetworkEndpointGroupsAttachEndpointsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :network_endpoints, as: 'networkEndpoints', class: Google::Apis::ComputeV1::NetworkEndpoint, decorator: Google::Apis::ComputeV1::NetworkEndpoint::Representation + + end + end + + class GlobalNetworkEndpointGroupsDetachEndpointsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :network_endpoints, as: 'networkEndpoints', class: Google::Apis::ComputeV1::NetworkEndpoint, decorator: Google::Apis::ComputeV1::NetworkEndpoint::Representation + + end + end + class GlobalSetLabelsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -6559,6 +6713,8 @@ module Google property :raw_disk, as: 'rawDisk', class: Google::Apis::ComputeV1::Image::RawDisk, decorator: Google::Apis::ComputeV1::Image::RawDisk::Representation property :self_link, as: 'selfLink' + property :shielded_instance_initial_state, as: 'shieldedInstanceInitialState', class: Google::Apis::ComputeV1::InitialStateConfig, decorator: Google::Apis::ComputeV1::InitialStateConfig::Representation + property :source_disk, as: 'sourceDisk' property :source_disk_encryption_key, as: 'sourceDiskEncryptionKey', class: Google::Apis::ComputeV1::CustomerEncryptionKey, decorator: Google::Apis::ComputeV1::CustomerEncryptionKey::Representation @@ -6618,6 +6774,20 @@ module Google end end + class InitialStateConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dbs, as: 'dbs', class: Google::Apis::ComputeV1::FileContentBuffer, decorator: Google::Apis::ComputeV1::FileContentBuffer::Representation + + collection :dbxs, as: 'dbxs', class: Google::Apis::ComputeV1::FileContentBuffer, decorator: Google::Apis::ComputeV1::FileContentBuffer::Representation + + collection :keks, as: 'keks', class: Google::Apis::ComputeV1::FileContentBuffer, decorator: Google::Apis::ComputeV1::FileContentBuffer::Representation + + property :pk, as: 'pk', class: Google::Apis::ComputeV1::FileContentBuffer, decorator: Google::Apis::ComputeV1::FileContentBuffer::Representation + + end + end + class Instance # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -6630,6 +6800,7 @@ module Google property :display_device, as: 'displayDevice', class: Google::Apis::ComputeV1::DisplayDevice, decorator: Google::Apis::ComputeV1::DisplayDevice::Representation + property :fingerprint, :base64 => true, as: 'fingerprint' collection :guest_accelerators, as: 'guestAccelerators', class: Google::Apis::ComputeV1::AcceleratorConfig, decorator: Google::Apis::ComputeV1::AcceleratorConfig::Representation property :hostname, as: 'hostname' @@ -6646,6 +6817,7 @@ module Google property :reservation_affinity, as: 'reservationAffinity', class: Google::Apis::ComputeV1::ReservationAffinity, decorator: Google::Apis::ComputeV1::ReservationAffinity::Representation + collection :resource_policies, as: 'resourcePolicies' property :scheduling, as: 'scheduling', class: Google::Apis::ComputeV1::Scheduling, decorator: Google::Apis::ComputeV1::Scheduling::Representation property :self_link, as: 'selfLink' @@ -6904,6 +7076,7 @@ module Google class InstanceGroupManagerStatus # @private class Representation < Google::Apis::Core::JsonRepresentation + property :autoscaler, as: 'autoscaler' property :is_stable, as: 'isStable' property :version_target, as: 'versionTarget', class: Google::Apis::ComputeV1::InstanceGroupManagerStatusVersionTarget, decorator: Google::Apis::ComputeV1::InstanceGroupManagerStatusVersionTarget::Representation @@ -6926,6 +7099,7 @@ module Google property :max_unavailable, as: 'maxUnavailable', class: Google::Apis::ComputeV1::FixedOrPercent, decorator: Google::Apis::ComputeV1::FixedOrPercent::Representation property :minimal_action, as: 'minimalAction' + property :replacement_method, as: 'replacementMethod' property :type, as: 'type' end end @@ -6971,11 +7145,21 @@ module Google end end + class InstanceGroupManagersListErrorsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :items, as: 'items', class: Google::Apis::ComputeV1::InstanceManagedByIgmError, decorator: Google::Apis::ComputeV1::InstanceManagedByIgmError::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + class InstanceGroupManagersListManagedInstancesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :managed_instances, as: 'managedInstances', class: Google::Apis::ComputeV1::ManagedInstance, decorator: Google::Apis::ComputeV1::ManagedInstance::Representation + property :next_page_token, as: 'nextPageToken' end end @@ -7185,6 +7369,35 @@ module Google end end + class InstanceManagedByIgmError + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :error, as: 'error', class: Google::Apis::ComputeV1::InstanceManagedByIgmErrorManagedInstanceError, decorator: Google::Apis::ComputeV1::InstanceManagedByIgmErrorManagedInstanceError::Representation + + property :instance_action_details, as: 'instanceActionDetails', class: Google::Apis::ComputeV1::InstanceManagedByIgmErrorInstanceActionDetails, decorator: Google::Apis::ComputeV1::InstanceManagedByIgmErrorInstanceActionDetails::Representation + + property :timestamp, as: 'timestamp' + end + end + + class InstanceManagedByIgmErrorInstanceActionDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action, as: 'action' + property :instance, as: 'instance' + property :version, as: 'version', class: Google::Apis::ComputeV1::ManagedInstanceVersion, decorator: Google::Apis::ComputeV1::ManagedInstanceVersion::Representation + + end + end + + class InstanceManagedByIgmErrorManagedInstanceError + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + property :message, as: 'message' + end + end + class MoveInstanceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -7211,6 +7424,7 @@ module Google property :reservation_affinity, as: 'reservationAffinity', class: Google::Apis::ComputeV1::ReservationAffinity, decorator: Google::Apis::ComputeV1::ReservationAffinity::Representation + collection :resource_policies, as: 'resourcePolicies' property :scheduling, as: 'scheduling', class: Google::Apis::ComputeV1::Scheduling, decorator: Google::Apis::ComputeV1::Scheduling::Representation collection :service_accounts, as: 'serviceAccounts', class: Google::Apis::ComputeV1::ServiceAccount, decorator: Google::Apis::ComputeV1::ServiceAccount::Representation @@ -7288,6 +7502,20 @@ module Google end end + class InstancesAddResourcePoliciesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :resource_policies, as: 'resourcePolicies' + end + end + + class InstancesRemoveResourcePoliciesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :resource_policies, as: 'resourcePolicies' + end + end + class InstancesScopedList # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -8089,6 +8317,7 @@ module Google class NetworkEndpoint # @private class Representation < Google::Apis::Core::JsonRepresentation + property :fqdn, as: 'fqdn' property :instance, as: 'instance' property :ip_address, as: 'ipAddress' property :port, as: 'port' @@ -8367,10 +8596,14 @@ module Google class NodeGroup # @private class Representation < Google::Apis::Core::JsonRepresentation + property :autoscaling_policy, as: 'autoscalingPolicy', class: Google::Apis::ComputeV1::NodeGroupAutoscalingPolicy, decorator: Google::Apis::ComputeV1::NodeGroupAutoscalingPolicy::Representation + property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' + property :fingerprint, :base64 => true, as: 'fingerprint' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' + property :maintenance_policy, as: 'maintenancePolicy' property :name, as: 'name' property :node_template, as: 'nodeTemplate' property :self_link, as: 'selfLink' @@ -8412,6 +8645,15 @@ module Google end end + class NodeGroupAutoscalingPolicy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :max_nodes, as: 'maxNodes' + property :min_nodes, as: 'minNodes' + property :mode, as: 'mode' + end + end + class NodeGroupList # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -8452,6 +8694,7 @@ module Google property :node_type, as: 'nodeType' property :server_binding, as: 'serverBinding', class: Google::Apis::ComputeV1::ServerBinding, decorator: Google::Apis::ComputeV1::ServerBinding::Representation + property :server_id, as: 'serverId' property :status, as: 'status' end end @@ -9167,6 +9410,14 @@ module Google end end + class PreconfiguredWafSet + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :expression_sets, as: 'expressionSets', class: Google::Apis::ComputeV1::WafExpressionSet, decorator: Google::Apis::ComputeV1::WafExpressionSet::Representation + + end + end + class Project # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -9447,11 +9698,21 @@ module Google end end + class RegionInstanceGroupManagersListErrorsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :items, as: 'items', class: Google::Apis::ComputeV1::InstanceManagedByIgmError, decorator: Google::Apis::ComputeV1::InstanceManagedByIgmError::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + class RegionInstanceGroupManagersListInstancesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :managed_instances, as: 'managedInstances', class: Google::Apis::ComputeV1::ManagedInstance, decorator: Google::Apis::ComputeV1::ManagedInstance::Representation + property :next_page_token, as: 'nextPageToken' end end @@ -9774,6 +10035,8 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :creation_timestamp, as: 'creationTimestamp' property :description, as: 'description' + property :group_placement_policy, as: 'groupPlacementPolicy', class: Google::Apis::ComputeV1::ResourcePolicyGroupPlacementPolicy, decorator: Google::Apis::ComputeV1::ResourcePolicyGroupPlacementPolicy::Representation + property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' @@ -9827,6 +10090,15 @@ module Google end end + class ResourcePolicyGroupPlacementPolicy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :availability_domain_count, as: 'availabilityDomainCount' + property :collocation, as: 'collocation' + property :vm_count, as: 'vmCount' + end + end + class ResourcePolicyHourlyCycle # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -10310,6 +10582,22 @@ module Google end end + class SecurityPoliciesListPreconfiguredExpressionSetsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :preconfigured_expression_sets, as: 'preconfiguredExpressionSets', class: Google::Apis::ComputeV1::SecurityPoliciesWafConfig, decorator: Google::Apis::ComputeV1::SecurityPoliciesWafConfig::Representation + + end + end + + class SecurityPoliciesWafConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :waf_rules, as: 'wafRules', class: Google::Apis::ComputeV1::PreconfiguredWafSet, decorator: Google::Apis::ComputeV1::PreconfiguredWafSet::Representation + + end + end + class SecurityPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -10817,8 +11105,10 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :aggregation_interval, as: 'aggregationInterval' property :enable, as: 'enable' + property :filter_expr, as: 'filterExpr' property :flow_sampling, as: 'flowSampling' property :metadata, as: 'metadata' + collection :metadata_fields, as: 'metadataFields' end end @@ -12194,6 +12484,23 @@ module Google end end + class WafExpressionSet + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :aliases, as: 'aliases' + collection :expressions, as: 'expressions', class: Google::Apis::ComputeV1::WafExpressionSetExpression, decorator: Google::Apis::ComputeV1::WafExpressionSetExpression::Representation + + property :id, as: 'id' + end + end + + class WafExpressionSetExpression + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + end + end + class WeightedBackendService # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/compute_v1/service.rb b/generated/google/apis/compute_v1/service.rb index af53d2046..1e6a6ccb6 100644 --- a/generated/google/apis/compute_v1/service.rb +++ b/generated/google/apis/compute_v1/service.rb @@ -58,36 +58,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -107,12 +114,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_accelerator_type_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_accelerator_type_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/acceleratorTypes', options) command.response_representation = Google::Apis::ComputeV1::AcceleratorTypeAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::AcceleratorTypeAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -170,36 +178,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -242,36 +250,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -291,12 +306,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_aggregated_addresses(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_aggregated_addresses(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/addresses', options) command.response_representation = Google::Apis::ComputeV1::AddressAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::AddressAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -457,36 +473,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -529,36 +545,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -578,12 +601,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_aggregated_autoscalers(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_aggregated_autoscalers(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/autoscalers', options) command.response_representation = Google::Apis::ComputeV1::AutoscalerAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::AutoscalerAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -745,36 +769,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1167,36 +1191,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1396,36 +1420,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1445,12 +1476,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_backend_service_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_backend_service_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/backendServices', options) command.response_representation = Google::Apis::ComputeV1::BackendServiceAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::BackendServiceAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -1638,8 +1670,8 @@ module Google # Creates a BackendService resource in the specified project using the data # included in the request. There are several restrictions and guidelines to keep - # in mind when creating a backend service. Read Restrictions and Guidelines for - # more information. + # in mind when creating a backend service. Read Understanding backend services + # for more information. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeV1::BackendService] backend_service_object @@ -1695,36 +1727,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1760,8 +1792,8 @@ module Google end # Patches the specified BackendService resource with the data included in the - # request. There are several restrictions and guidelines to keep in mind when - # updating a backend service. Read Restrictions and Guidelines for more + # request. There are several Understanding backend services to keep in mind when + # updating a backend service. Read Understanding backend services for more # information. This method supports PATCH semantics and uses the JSON merge # patch format and processing rules. # @param [String] project @@ -1867,8 +1899,8 @@ module Google end # Updates the specified BackendService resource with the data included in the - # request. There are several restrictions and guidelines to keep in mind when - # updating a backend service. Read Restrictions and Guidelines for more + # request. There are several Understanding backend services to keep in mind when + # updating a backend service. Read Understanding backend services for more # information. # @param [String] project # Project ID for this request. @@ -1927,36 +1959,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1976,12 +2015,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_aggregated_disk_types(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_aggregated_disk_types(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/diskTypes', options) command.response_representation = Google::Apis::ComputeV1::DiskTypeAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::DiskTypeAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -2040,36 +2080,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2167,36 +2207,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2216,12 +2263,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_aggregated_disk(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_aggregated_disk(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/disks', options) command.response_representation = Google::Apis::ComputeV1::DiskAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::DiskAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -2489,36 +2537,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2944,36 +2992,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3227,36 +3275,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3404,36 +3452,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3453,12 +3508,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_aggregated_forwarding_rules(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_aggregated_forwarding_rules(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/forwardingRules', options) command.response_representation = Google::Apis::ComputeV1::ForwardingRuleAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::ForwardingRuleAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -3620,36 +3676,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3937,36 +3993,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4143,36 +4199,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4312,6 +4368,393 @@ module Google execute_or_queue_command(command, &block) end + # Attach a network endpoint to the specified network endpoint group. + # @param [String] project + # Project ID for this request. + # @param [String] network_endpoint_group + # The name of the network endpoint group where you are attaching network + # endpoints to. It should comply with RFC1035. + # @param [Google::Apis::ComputeV1::GlobalNetworkEndpointGroupsAttachEndpointsRequest] global_network_endpoint_groups_attach_endpoints_request_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def attach_global_network_endpoint_group_network_endpoints(project, network_endpoint_group, global_network_endpoint_groups_attach_endpoints_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints', options) + command.request_representation = Google::Apis::ComputeV1::GlobalNetworkEndpointGroupsAttachEndpointsRequest::Representation + command.request_object = global_network_endpoint_groups_attach_endpoints_request_object + command.response_representation = Google::Apis::ComputeV1::Operation::Representation + command.response_class = Google::Apis::ComputeV1::Operation + command.params['project'] = project unless project.nil? + command.params['networkEndpointGroup'] = network_endpoint_group unless network_endpoint_group.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified network endpoint group.Note that the NEG cannot be + # deleted if there are backend services referencing it. + # @param [String] project + # Project ID for this request. + # @param [String] network_endpoint_group + # The name of the network endpoint group to delete. It should comply with + # RFC1035. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_global_network_endpoint_group(project, network_endpoint_group, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, '{project}/global/networkEndpointGroups/{networkEndpointGroup}', options) + command.response_representation = Google::Apis::ComputeV1::Operation::Representation + command.response_class = Google::Apis::ComputeV1::Operation + command.params['project'] = project unless project.nil? + command.params['networkEndpointGroup'] = network_endpoint_group unless network_endpoint_group.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Detach the network endpoint from the specified network endpoint group. + # @param [String] project + # Project ID for this request. + # @param [String] network_endpoint_group + # The name of the network endpoint group where you are removing network + # endpoints. It should comply with RFC1035. + # @param [Google::Apis::ComputeV1::GlobalNetworkEndpointGroupsDetachEndpointsRequest] global_network_endpoint_groups_detach_endpoints_request_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def detach_global_network_endpoint_group_network_endpoints(project, network_endpoint_group, global_network_endpoint_groups_detach_endpoints_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints', options) + command.request_representation = Google::Apis::ComputeV1::GlobalNetworkEndpointGroupsDetachEndpointsRequest::Representation + command.request_object = global_network_endpoint_groups_detach_endpoints_request_object + command.response_representation = Google::Apis::ComputeV1::Operation::Representation + command.response_class = Google::Apis::ComputeV1::Operation + command.params['project'] = project unless project.nil? + command.params['networkEndpointGroup'] = network_endpoint_group unless network_endpoint_group.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Returns the specified network endpoint group. Gets a list of available network + # endpoint groups by making a list() request. + # @param [String] project + # Project ID for this request. + # @param [String] network_endpoint_group + # The name of the network endpoint group. It should comply with RFC1035. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::NetworkEndpointGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::NetworkEndpointGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_global_network_endpoint_group(project, network_endpoint_group, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/global/networkEndpointGroups/{networkEndpointGroup}', options) + command.response_representation = Google::Apis::ComputeV1::NetworkEndpointGroup::Representation + command.response_class = Google::Apis::ComputeV1::NetworkEndpointGroup + command.params['project'] = project unless project.nil? + command.params['networkEndpointGroup'] = network_endpoint_group unless network_endpoint_group.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Creates a network endpoint group in the specified project using the parameters + # that are included in the request. + # @param [String] project + # Project ID for this request. + # @param [Google::Apis::ComputeV1::NetworkEndpointGroup] network_endpoint_group_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_global_network_endpoint_group(project, network_endpoint_group_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/global/networkEndpointGroups', options) + command.request_representation = Google::Apis::ComputeV1::NetworkEndpointGroup::Representation + command.request_object = network_endpoint_group_object + command.response_representation = Google::Apis::ComputeV1::Operation::Representation + command.response_class = Google::Apis::ComputeV1::Operation + command.params['project'] = project unless project.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the list of network endpoint groups that are located in the + # specified project. + # @param [String] project + # Project ID for this request. + # @param [String] filter + # A filter expression that filters resources listed in the response. The + # expression must specify the field name, a comparison operator, and the value + # that you want to use for filtering. The value must be a string, a number, or a + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. + # For example, if you are filtering Compute Engine instances, you can exclude + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled + # for automatic restarts. You can use filtering on nested fields to filter based + # on resource labels. + # To filter on multiple expressions, provide each separate expression within + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Fixnum] max_results + # The maximum number of results per page that should be returned. If the number + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + # @param [String] order_by + # Sorts list results by a certain order. By default, results are returned in + # alphanumerical order based on the resource name. + # You can also sort results in descending order based on the creation timestamp + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). + # Use this to sort resources like operations so that the newest operation is + # returned first. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. + # @param [String] page_token + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::NetworkEndpointGroupList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::NetworkEndpointGroupList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_global_network_endpoint_groups(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/global/networkEndpointGroups', options) + command.response_representation = Google::Apis::ComputeV1::NetworkEndpointGroupList::Representation + command.response_class = Google::Apis::ComputeV1::NetworkEndpointGroupList + command.params['project'] = project unless project.nil? + command.query['filter'] = filter unless filter.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Lists the network endpoints in the specified network endpoint group. + # @param [String] project + # Project ID for this request. + # @param [String] network_endpoint_group + # The name of the network endpoint group from which you want to generate a list + # of included network endpoints. It should comply with RFC1035. + # @param [String] filter + # A filter expression that filters resources listed in the response. The + # expression must specify the field name, a comparison operator, and the value + # that you want to use for filtering. The value must be a string, a number, or a + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. + # For example, if you are filtering Compute Engine instances, you can exclude + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled + # for automatic restarts. You can use filtering on nested fields to filter based + # on resource labels. + # To filter on multiple expressions, provide each separate expression within + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Fixnum] max_results + # The maximum number of results per page that should be returned. If the number + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + # @param [String] order_by + # Sorts list results by a certain order. By default, results are returned in + # alphanumerical order based on the resource name. + # You can also sort results in descending order based on the creation timestamp + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). + # Use this to sort resources like operations so that the newest operation is + # returned first. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. + # @param [String] page_token + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::NetworkEndpointGroupsListNetworkEndpoints] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::NetworkEndpointGroupsListNetworkEndpoints] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_global_network_endpoint_group_network_endpoints(project, network_endpoint_group, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints', options) + command.response_representation = Google::Apis::ComputeV1::NetworkEndpointGroupsListNetworkEndpoints::Representation + command.response_class = Google::Apis::ComputeV1::NetworkEndpointGroupsListNetworkEndpoints + command.params['project'] = project unless project.nil? + command.params['networkEndpointGroup'] = network_endpoint_group unless network_endpoint_group.nil? + command.query['filter'] = filter unless filter.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Retrieves an aggregated list of all operations. # @param [String] project # Project ID for this request. @@ -4319,36 +4762,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4368,12 +4818,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_aggregated_global_operation(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_aggregated_global_operation(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/operations', options) command.response_representation = Google::Apis::ComputeV1::OperationAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::OperationAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -4418,7 +4869,7 @@ module Google end # Retrieves the specified Operations resource. Gets a list of operations by - # making a list() request. + # making a `list()` request. # @param [String] project # Project ID for this request. # @param [String] operation @@ -4461,36 +4912,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4525,17 +4976,17 @@ module Google execute_or_queue_command(command, &block) end - # Waits for the specified Operation resource to return as DONE or for the + # Waits for the specified Operation resource to return as `DONE` or for the # request to approach the 2 minute deadline, and retrieves the specified - # Operation resource. This method differs from the GET method in that it waits + # Operation resource. This method differs from the `GET` method in that it waits # for no more than the default deadline (2 minutes) and then returns the current - # state of the operation, which might be DONE or still in progress. + # state of the operation, which might be `DONE` or still in progress. # This method is called on a best-effort basis. Specifically: # - In uncommon cases, when the server is overloaded, the request might return # before the default deadline is reached, or might return after zero seconds. # - If the default deadline is reached, there is no guarantee that the operation # is actually done when the method returns. Be prepared to retry if the - # operation is not DONE. + # operation is not `DONE`. # @param [String] project # Project ID for this request. # @param [String] operation @@ -4579,36 +5030,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4628,12 +5086,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_health_check_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_health_check_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/healthChecks', options) command.response_representation = Google::Apis::ComputeV1::HealthChecksAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::HealthChecksAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -4784,36 +5243,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5095,36 +5554,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5406,36 +5865,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5849,36 +6308,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6104,36 +6563,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6153,12 +6619,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_aggregated_instance_group_managers(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_aggregated_instance_group_managers(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/instanceGroupManagers', options) command.response_representation = Google::Apis::ComputeV1::InstanceGroupManagerAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::InstanceGroupManagerAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -6168,8 +6635,8 @@ module Google execute_or_queue_command(command, &block) end - # Apply changes to selected instances on the managed instance group. This method - # can be used to apply new overrides and/or new versions. + # Applies changes to selected instances on the managed instance group. This + # method can be used to apply new overrides and/or new versions. # @param [String] project # Project ID for this request. # @param [String] zone @@ -6496,36 +6963,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6561,6 +7028,87 @@ module Google execute_or_queue_command(command, &block) end + # Lists all errors thrown by actions on instances for a given managed instance + # group. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone where the managed instance group is located. It should + # conform to RFC1035. + # @param [String] instance_group_manager + # The name of the managed instance group. It must be a string that meets the + # requirements in RFC1035, or an unsigned long integer: must match regexp + # pattern: (?:[a-z](?:[-a-z0-9]`0,61`[a-z0-9])?)|[1-9][0-9]`0,19`. + # @param [String] filter + # A filter expression that filters resources listed in the response. The + # expression must specify the field name, a comparison operator, and the value + # that you want to use for filtering. The value must be a string, a number, or a + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. + # For example, if you are filtering Compute Engine instances, you can exclude + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled + # for automatic restarts. You can use filtering on nested fields to filter based + # on resource labels. + # To filter on multiple expressions, provide each separate expression within + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Fixnum] max_results + # The maximum number of results per page that should be returned. If the number + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + # @param [String] order_by + # Sorts list results by a certain order. By default, results are returned in + # alphanumerical order based on the resource name. + # You can also sort results in descending order based on the creation timestamp + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). + # Use this to sort resources like operations so that the newest operation is + # returned first. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. + # @param [String] page_token + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::InstanceGroupManagersListErrorsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::InstanceGroupManagersListErrorsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_instance_group_manager_errors(project, zone, instance_group_manager, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors', options) + command.response_representation = Google::Apis::ComputeV1::InstanceGroupManagersListErrorsResponse::Representation + command.response_class = Google::Apis::ComputeV1::InstanceGroupManagersListErrorsResponse + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.nil? + command.query['filter'] = filter unless filter.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Lists all of the instances in the managed instance group. Each instance in the # list has a currentAction, which indicates the action that the managed instance # group is performing on the instance. For example, if the group is still @@ -6576,36 +7124,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6634,7 +7182,7 @@ module Google command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.nil? - command.query['order_by'] = order_by unless order_by.nil? + command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? @@ -7013,36 +7561,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7062,12 +7617,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_aggregated_instance_groups(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_aggregated_instance_groups(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/instanceGroups', options) command.response_representation = Google::Apis::ComputeV1::InstanceGroupAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::InstanceGroupAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -7232,36 +7788,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7310,36 +7866,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7673,36 +8229,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7873,6 +8429,62 @@ module Google execute_or_queue_command(command, &block) end + # Adds existing resource policies to an instance. You can only add one policy + # right now which will be applied to this instance for scheduling live + # migrations. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] instance + # The instance name for this request. + # @param [Google::Apis::ComputeV1::InstancesAddResourcePoliciesRequest] instances_add_resource_policies_request_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def add_instance_resource_policies(project, zone, instance, instances_add_resource_policies_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/addResourcePolicies', options) + command.request_representation = Google::Apis::ComputeV1::InstancesAddResourcePoliciesRequest::Representation + command.request_object = instances_add_resource_policies_request_object + command.response_representation = Google::Apis::ComputeV1::Operation::Representation + command.response_class = Google::Apis::ComputeV1::Operation + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['instance'] = instance unless instance.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Retrieves aggregated list of all of the instances in your project across all # regions and zones. # @param [String] project @@ -7881,36 +8493,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -7930,12 +8549,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_aggregated_instances(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_aggregated_instances(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/instances', options) command.response_representation = Google::Apis::ComputeV1::InstanceAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::InstanceAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -8452,36 +9072,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -8530,36 +9150,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -8596,6 +9216,60 @@ module Google execute_or_queue_command(command, &block) end + # Removes resource policies from an instance. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] instance + # The instance name for this request. + # @param [Google::Apis::ComputeV1::InstancesRemoveResourcePoliciesRequest] instances_remove_resource_policies_request_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def remove_instance_resource_policies(project, zone, instance, instances_remove_resource_policies_request_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/zones/{zone}/instances/{instance}/removeResourcePolicies', options) + command.request_representation = Google::Apis::ComputeV1::InstancesRemoveResourcePoliciesRequest::Representation + command.request_object = instances_remove_resource_policies_request_object + command.response_representation = Google::Apis::ComputeV1::Operation::Representation + command.response_class = Google::Apis::ComputeV1::Operation + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['instance'] = instance unless instance.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Performs a reset on the instance. This is a hard reset the VM does not do a # graceful shutdown. For more information, see Resetting an instance. # @param [String] project @@ -9541,6 +10215,73 @@ module Google execute_or_queue_command(command, &block) end + # Updates an instance only if the necessary resources are available. This method + # can update only a specific set of instance properties. See Updating a running + # instance for a list of updatable instance properties. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] instance + # Name of the instance resource to update. + # @param [Google::Apis::ComputeV1::Instance] instance_object + # @param [String] minimal_action + # Specifies the action to take when updating an instance even if the updated + # properties do not require it. If not specified, then Compute Engine acts based + # on the minimum action that the updated properties require. + # @param [String] most_disruptive_allowed_action + # Specifies the most disruptive action that can be taken on the instance as part + # of the update. Compute Engine returns an error if the instance properties + # require a more disruptive action as part of the instance update. Valid options + # from lowest to highest are NO_EFFECT, REFRESH, and RESTART. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_instance(project, zone, instance, instance_object = nil, minimal_action: nil, most_disruptive_allowed_action: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, '{project}/zones/{zone}/instances/{instance}', options) + command.request_representation = Google::Apis::ComputeV1::Instance::Representation + command.request_object = instance_object + command.response_representation = Google::Apis::ComputeV1::Operation::Representation + command.response_class = Google::Apis::ComputeV1::Operation + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['instance'] = instance unless instance.nil? + command.query['minimalAction'] = minimal_action unless minimal_action.nil? + command.query['mostDisruptiveAllowedAction'] = most_disruptive_allowed_action unless most_disruptive_allowed_action.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Updates the specified access config from an instance's network interface with # the data included in the request. This method supports PATCH semantics and # uses the JSON merge patch format and processing rules. @@ -9776,36 +10517,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -9825,12 +10573,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_interconnect_attachment_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_interconnect_attachment_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/interconnectAttachments', options) command.response_representation = Google::Apis::ComputeV1::InterconnectAttachmentAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::InterconnectAttachmentAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -9995,36 +10744,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -10161,36 +10910,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -10402,36 +11151,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -10520,7 +11269,9 @@ module Google end # Return a specified license code. License codes are mirrored across all - # projects that have permissions to read the License Code. + # projects that have permissions to read the License Code. Caution This + # resource is intended for use only by third-party partners who are creating + # Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] license_code @@ -10556,7 +11307,9 @@ module Google execute_or_queue_command(command, &block) end - # Returns permissions that a caller has on the specified resource. + # Returns permissions that a caller has on the specified resource. Caution This + # resource is intended for use only by third-party partners who are creating + # Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] resource @@ -10595,7 +11348,8 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified license. + # Deletes the specified license. Caution This resource is intended for use only + # by third-party partners who are creating Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] license @@ -10643,7 +11397,8 @@ module Google execute_or_queue_command(command, &block) end - # Returns the specified License resource. + # Returns the specified License resource. Caution This resource is intended for + # use only by third-party partners who are creating Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] license @@ -10680,7 +11435,8 @@ module Google end # Gets the access control policy for a resource. May be empty if no such policy - # or resource exists. + # or resource exists. Caution This resource is intended for use only by third- + # party partners who are creating Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] resource @@ -10716,7 +11472,9 @@ module Google execute_or_queue_command(command, &block) end - # Create a License resource in the specified project. + # Create a License resource in the specified project. Caution This resource is + # intended for use only by third-party partners who are creating Cloud + # Marketplace images. # @param [String] project # Project ID for this request. # @param [Google::Apis::ComputeV1::License] license_object @@ -10768,43 +11526,45 @@ module Google # does not get any licenses that belong to other projects, including licenses # attached to publicly-available images, like Debian 9. If you want to get a # list of publicly-available licenses, use this method to make a request to the - # respective image project, such as debian-cloud or windows-cloud. + # respective image project, such as debian-cloud or windows-cloud. Caution This + # resource is intended for use only by third-party partners who are creating + # Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] filter # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -10840,7 +11600,8 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. + # existing policy. Caution This resource is intended for use only by third- + # party partners who are creating Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] resource @@ -10879,7 +11640,9 @@ module Google execute_or_queue_command(command, &block) end - # Returns permissions that a caller has on the specified resource. + # Returns permissions that a caller has on the specified resource. Caution This + # resource is intended for use only by third-party partners who are creating + # Cloud Marketplace images. # @param [String] project # Project ID for this request. # @param [String] resource @@ -10925,36 +11688,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -10974,12 +11744,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_aggregated_machine_types(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_aggregated_machine_types(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/machineTypes', options) command.response_representation = Google::Apis::ComputeV1::MachineTypeAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::MachineTypeAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -11038,36 +11809,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -11110,36 +11881,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -11159,12 +11937,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_network_endpoint_group_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_network_endpoint_group_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/networkEndpointGroups', options) command.response_representation = Google::Apis::ComputeV1::NetworkEndpointGroupAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::NetworkEndpointGroupAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -11447,36 +12226,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -11526,36 +12305,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -11828,36 +12607,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -11903,36 +12682,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] peering_name # The response will show routes exchanged over the given peering connection. # @param [String] region @@ -12242,36 +13021,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -12291,12 +13077,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_node_group_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_node_group_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/nodeGroups', options) command.response_representation = Google::Apis::ComputeV1::NodeGroupAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::NodeGroupAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -12557,36 +13344,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -12633,36 +13420,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -12699,6 +13486,60 @@ module Google execute_or_queue_command(command, &block) end + # Patch the node group. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] node_group + # Name of the NodeGroup resource to update. + # @param [Google::Apis::ComputeV1::NodeGroup] node_group_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_node_group(project, zone, node_group, node_group_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, '{project}/zones/{zone}/nodeGroups/{nodeGroup}', options) + command.request_representation = Google::Apis::ComputeV1::NodeGroup::Representation + command.request_object = node_group_object + command.response_representation = Google::Apis::ComputeV1::Operation::Representation + command.response_class = Google::Apis::ComputeV1::Operation + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['nodeGroup'] = node_group unless node_group.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Sets the access control policy on the specified resource. Replaces any # existing policy. # @param [String] project @@ -12845,36 +13686,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -12894,12 +13742,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_node_template_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_node_template_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/nodeTemplates', options) command.response_representation = Google::Apis::ComputeV1::NodeTemplateAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::NodeTemplateAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -13101,36 +13950,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -13258,36 +14107,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -13307,12 +14163,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_node_type_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_node_type_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/nodeTypes', options) command.response_representation = Google::Apis::ComputeV1::NodeTypeAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::NodeTypeAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -13371,36 +14228,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -13443,36 +14300,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -13492,12 +14356,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_packet_mirroring_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_packet_mirroring_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/packetMirrorings', options) command.response_representation = Google::Apis::ComputeV1::PacketMirroringAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::PacketMirroringAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -13659,36 +14524,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -14085,36 +14950,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -14141,7 +15006,7 @@ module Google command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.nil? - command.query['order_by'] = order_by unless order_by.nil? + command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? @@ -14157,36 +15022,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -14215,7 +15080,7 @@ module Google command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.nil? - command.query['order_by'] = order_by unless order_by.nil? + command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? @@ -14619,36 +15484,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -14928,8 +15793,8 @@ module Google # Creates a regional BackendService resource in the specified project using the # data included in the request. There are several restrictions and guidelines to - # keep in mind when creating a regional backend service. Read Restrictions and - # Guidelines for more information. + # keep in mind when creating a regional backend service. Read Understanding + # backend services for more information. # @param [String] project # Project ID for this request. # @param [String] region @@ -14990,36 +15855,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -15056,9 +15921,9 @@ module Google end # Updates the specified regional BackendService resource with the data included - # in the request. There are several restrictions and guidelines to keep in mind - # when updating a backend service. Read Restrictions and Guidelines for more - # information. This method supports PATCH semantics and uses the JSON merge + # in the request. There are several Understanding backend services to keep in + # mind when updating a backend service. Read Understanding backend services for + # more information. This method supports PATCH semantics and uses the JSON merge # patch format and processing rules. # @param [String] project # Project ID for this request. @@ -15114,9 +15979,9 @@ module Google end # Updates the specified regional BackendService resource with the data included - # in the request. There are several restrictions and guidelines to keep in mind - # when updating a backend service. Read Restrictions and Guidelines for more - # information. + # in the request. There are several Understanding backend services to keep in + # mind when updating a backend service. Read Understanding backend services for + # more information. # @param [String] project # Project ID for this request. # @param [String] region @@ -15177,36 +16042,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -15226,12 +16098,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_region_commitment_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_region_commitment_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/commitments', options) command.response_representation = Google::Apis::ComputeV1::CommitmentAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::CommitmentAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -15342,36 +16215,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -15456,36 +16329,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -15787,36 +16660,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -16208,36 +17081,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -16772,36 +17645,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -16837,6 +17710,86 @@ module Google execute_or_queue_command(command, &block) end + # Lists all errors thrown by actions on instances for a given regional managed + # instance group. + # @param [String] project + # Project ID for this request. + # @param [String] region + # Name of the region scoping this request. This should conform to RFC1035. + # @param [String] instance_group_manager + # The name of the managed instance group. It must be a string that meets the + # requirements in RFC1035, or an unsigned long integer: must match regexp + # pattern: (?:[a-z](?:[-a-z0-9]`0,61`[a-z0-9])?)|[1-9][0-9]`0,19`. + # @param [String] filter + # A filter expression that filters resources listed in the response. The + # expression must specify the field name, a comparison operator, and the value + # that you want to use for filtering. The value must be a string, a number, or a + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. + # For example, if you are filtering Compute Engine instances, you can exclude + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled + # for automatic restarts. You can use filtering on nested fields to filter based + # on resource labels. + # To filter on multiple expressions, provide each separate expression within + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Fixnum] max_results + # The maximum number of results per page that should be returned. If the number + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + # @param [String] order_by + # Sorts list results by a certain order. By default, results are returned in + # alphanumerical order based on the resource name. + # You can also sort results in descending order based on the creation timestamp + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). + # Use this to sort resources like operations so that the newest operation is + # returned first. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. + # @param [String] page_token + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::RegionInstanceGroupManagersListErrorsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::RegionInstanceGroupManagersListErrorsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_region_instance_group_manager_errors(project, region, instance_group_manager, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors', options) + command.response_representation = Google::Apis::ComputeV1::RegionInstanceGroupManagersListErrorsResponse::Representation + command.response_class = Google::Apis::ComputeV1::RegionInstanceGroupManagersListErrorsResponse + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.nil? + command.query['filter'] = filter unless filter.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Lists the instances in the managed instance group and instances that are # scheduled to be created. The list includes any current actions that the group # has scheduled for its instances. @@ -16850,36 +17803,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -16908,7 +17861,7 @@ module Google command.params['instanceGroupManager'] = instance_group_manager unless instance_group_manager.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.nil? - command.query['order_by'] = order_by unless order_by.nil? + command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? @@ -17259,36 +18212,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -17338,36 +18291,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -17545,36 +18498,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -17610,17 +18563,17 @@ module Google execute_or_queue_command(command, &block) end - # Waits for the specified Operation resource to return as DONE or for the + # Waits for the specified Operation resource to return as `DONE` or for the # request to approach the 2 minute deadline, and retrieves the specified - # Operation resource. This method differs from the GET method in that it waits + # Operation resource. This method differs from the `GET` method in that it waits # for no more than the default deadline (2 minutes) and then returns the current - # state of the operation, which might be DONE or still in progress. + # state of the operation, which might be `DONE` or still in progress. # This method is called on a best-effort basis. Specifically: # - In uncommon cases, when the server is overloaded, the request might return # before the default deadline is reached, or might return after zero seconds. # - If the default deadline is reached, there is no guarantee that the operation # is actually done when the method returns. Be prepared to retry if the - # operation is not DONE. + # operation is not `DONE`. # @param [String] project # Project ID for this request. # @param [String] region @@ -17812,36 +18765,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -18030,36 +18983,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -18302,36 +19255,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -18610,36 +19563,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -18854,36 +19807,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -18925,36 +19878,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -18974,12 +19934,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_reservation_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_reservation_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/reservations', options) command.response_representation = Google::Apis::ComputeV1::ReservationAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::ReservationAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -19181,36 +20142,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -19393,36 +20354,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -19442,12 +20410,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_resource_policy_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_resource_policy_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/resourcePolicies', options) command.response_representation = Google::Apis::ComputeV1::ResourcePolicyAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::ResourcePolicyAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -19648,36 +20617,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -19805,36 +20774,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -19854,12 +20830,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_router_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_router_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/routers', options) command.response_representation = Google::Apis::ComputeV1::RouterAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::RouterAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -19972,36 +20949,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -20138,36 +21115,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -20500,36 +21477,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -20782,36 +21759,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -20846,6 +21823,78 @@ module Google execute_or_queue_command(command, &block) end + # Gets the current list of preconfigured Web Application Firewall (WAF) + # expressions. + # @param [String] project + # Project ID for this request. + # @param [String] filter + # A filter expression that filters resources listed in the response. The + # expression must specify the field name, a comparison operator, and the value + # that you want to use for filtering. The value must be a string, a number, or a + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. + # For example, if you are filtering Compute Engine instances, you can exclude + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled + # for automatic restarts. You can use filtering on nested fields to filter based + # on resource labels. + # To filter on multiple expressions, provide each separate expression within + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Fixnum] max_results + # The maximum number of results per page that should be returned. If the number + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + # @param [String] order_by + # Sorts list results by a certain order. By default, results are returned in + # alphanumerical order based on the resource name. + # You can also sort results in descending order based on the creation timestamp + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). + # Use this to sort resources like operations so that the newest operation is + # returned first. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. + # @param [String] page_token + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::SecurityPoliciesListPreconfiguredExpressionSetsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::SecurityPoliciesListPreconfiguredExpressionSetsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_security_policy_preconfigured_expression_sets(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/global/securityPolicies/listPreconfiguredExpressionSets', options) + command.response_representation = Google::Apis::ComputeV1::SecurityPoliciesListPreconfiguredExpressionSetsResponse::Representation + command.response_class = Google::Apis::ComputeV1::SecurityPoliciesListPreconfiguredExpressionSetsResponse + command.params['project'] = project unless project.nil? + command.query['filter'] = filter unless filter.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Patches the specified policy with the data included in the request. # @param [String] project # Project ID for this request. @@ -21112,36 +22161,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -21303,36 +22352,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -21352,12 +22408,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_ssl_certificate_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_ssl_certificate_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/sslCertificates', options) command.response_representation = Google::Apis::ComputeV1::SslCertificateAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::SslCertificateAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -21509,36 +22566,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -21716,36 +22773,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -21788,36 +22845,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -21911,36 +22968,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -21960,12 +23024,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_subnetwork_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_subnetwork_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/subnetworks', options) command.response_representation = Google::Apis::ComputeV1::SubnetworkAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::SubnetworkAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -22221,36 +23286,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -22295,36 +23360,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -22361,7 +23426,7 @@ module Google # Patches the specified subnetwork with the data included in the request. Only # certain fields can up updated with a patch request as indicated in the field - # descriptions. You must specify the current fingeprint of the subnetwork + # descriptions. You must specify the current fingerprint of the subnetwork # resource being patched. # @param [String] project # Project ID for this request. @@ -22573,36 +23638,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -22622,12 +23694,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_target_http_proxy_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_target_http_proxy_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/targetHttpProxies', options) command.response_representation = Google::Apis::ComputeV1::TargetHttpProxyAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::TargetHttpProxyAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -22779,36 +23852,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -22902,36 +23975,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -22951,12 +24031,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_target_https_proxy_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_target_https_proxy_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/targetHttpsProxies', options) command.response_representation = Google::Apis::ComputeV1::TargetHttpsProxyAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::TargetHttpsProxyAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -23108,36 +24189,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -23388,36 +24469,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -23437,12 +24525,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_aggregated_target_instance(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_aggregated_target_instance(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/targetInstances', options) command.response_representation = Google::Apis::ComputeV1::TargetInstanceAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::TargetInstanceAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -23605,36 +24694,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -23785,36 +24874,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -23834,12 +24930,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_aggregated_target_pools(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_aggregated_target_pools(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/targetPools', options) command.response_representation = Google::Apis::ComputeV1::TargetPoolAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::TargetPoolAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -24044,36 +25141,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -24416,36 +25513,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -24830,36 +25927,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -25003,36 +26100,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -25052,12 +26156,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_aggregated_target_vpn_gateways(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_aggregated_target_vpn_gateways(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/targetVpnGateways', options) command.response_representation = Google::Apis::ComputeV1::TargetVpnGatewayAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::TargetVpnGatewayAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -25220,36 +26325,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -25293,36 +26398,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -25342,12 +26454,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_url_map_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_url_map_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/urlMaps', options) command.response_representation = Google::Apis::ComputeV1::UrlMapsAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::UrlMapsAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -25550,36 +26663,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -25765,36 +26878,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -25814,12 +26934,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def aggregated_vpn_gateway_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def aggregated_vpn_gateway_list(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/vpnGateways', options) command.response_representation = Google::Apis::ComputeV1::VpnGatewayAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::VpnGatewayAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -26020,36 +27141,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -26189,36 +27310,43 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` + # @param [Boolean] include_all_scopes + # Indicates whether every visible scope for each scope type (zone, region, + # global) should be included in the response. For new resource types added after + # this field, the flag has no effect as new resource types will always include + # every visible scope for each scope type in response. For resource types which + # predate this field, if this flag is omitted or false, only scopes of the scope + # types where the resource type is expected to be found will be included. # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -26238,12 +27366,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_aggregated_vpn_tunnel(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_aggregated_vpn_tunnel(project, filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/aggregated/vpnTunnels', options) command.response_representation = Google::Apis::ComputeV1::VpnTunnelAggregatedList::Representation command.response_class = Google::Apis::ComputeV1::VpnTunnelAggregatedList command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? + command.query['includeAllScopes'] = include_all_scopes unless include_all_scopes.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -26406,36 +27535,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -26556,36 +27685,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -26621,17 +27750,17 @@ module Google execute_or_queue_command(command, &block) end - # Waits for the specified Operation resource to return as DONE or for the + # Waits for the specified Operation resource to return as `DONE` or for the # request to approach the 2 minute deadline, and retrieves the specified - # Operation resource. This method differs from the GET method in that it waits + # Operation resource. This method differs from the `GET` method in that it waits # for no more than the default deadline (2 minutes) and then returns the current - # state of the operation, which might be DONE or still in progress. + # state of the operation, which might be `DONE` or still in progress. # This method is called on a best-effort basis. Specifically: # - In uncommon cases, when the server is overloaded, the request might return # before the default deadline is reached, or might return after zero seconds. # - If the default deadline is reached, there is no guarantee that the operation # is actually done when the method returns. Be prepared to retry if the - # operation is not DONE. + # operation is not `DONE`. # @param [String] project # Project ID for this request. # @param [String] zone @@ -26714,36 +27843,36 @@ module Google # A filter expression that filters resources listed in the response. The # expression must specify the field name, a comparison operator, and the value # that you want to use for filtering. The value must be a string, a number, or a - # boolean. The comparison operator must be either =, !=, >, or <. + # boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. # For example, if you are filtering Compute Engine instances, you can exclude - # instances named example-instance by specifying name != example-instance. - # You can also filter nested fields. For example, you could specify scheduling. - # automaticRestart = false to include instances only if they are not scheduled + # instances named `example-instance` by specifying `name != example-instance`. + # You can also filter nested fields. For example, you could specify `scheduling. + # automaticRestart = false` to include instances only if they are not scheduled # for automatic restarts. You can use filtering on nested fields to filter based # on resource labels. # To filter on multiple expressions, provide each separate expression within - # parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " - # Intel Skylake"). By default, each expression is an AND expression. However, - # you can include AND and OR expressions explicitly. For example, (cpuPlatform = - # "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. - # automaticRestart = true). + # parentheses. For example: ``` (scheduling.automaticRestart = true) ( + # cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` + # expression. However, you can include `AND` and `OR` expressions explicitly. + # For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel + # Broadwell") AND (scheduling.automaticRestart = true) ``` # @param [Fixnum] max_results # The maximum number of results per page that should be returned. If the number - # of available results is larger than maxResults, Compute Engine returns a - # nextPageToken that can be used to get the next page of results in subsequent - # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # of available results is larger than `maxResults`, Compute Engine returns a ` + # nextPageToken` that can be used to get the next page of results in subsequent + # list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param [String] order_by # Sorts list results by a certain order. By default, results are returned in # alphanumerical order based on the resource name. # You can also sort results in descending order based on the creation timestamp - # using orderBy="creationTimestamp desc". This sorts results based on the - # creationTimestamp field in reverse chronological order (newest result first). + # using `orderBy="creationTimestamp desc"`. This sorts results based on the ` + # creationTimestamp` field in reverse chronological order (newest result first). # Use this to sort resources like operations so that the newest operation is # returned first. - # Currently, only sorting by name or creationTimestamp desc is supported. + # Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param [String] page_token - # Specifies a page token to use. Set pageToken to the nextPageToken returned by - # a previous list request to get the next page of results. + # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned + # by a previous list request to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/container_v1.rb b/generated/google/apis/container_v1.rb index c276555f6..10986aade 100644 --- a/generated/google/apis/container_v1.rb +++ b/generated/google/apis/container_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/container-engine/ module ContainerV1 VERSION = 'V1' - REVISION = '20200228' + REVISION = '20200324' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/container_v1/classes.rb b/generated/google/apis/container_v1/classes.rb index a613f7357..4816f879a 100644 --- a/generated/google/apis/container_v1/classes.rb +++ b/generated/google/apis/container_v1/classes.rb @@ -541,11 +541,13 @@ module Google # The logging service the cluster should use to write logs. # Currently available options: - # * "logging.googleapis.com/kubernetes" - the Google Cloud Logging - # service with Kubernetes-native resource model - # * `logging.googleapis.com` - the Google Cloud Logging service. + # * `logging.googleapis.com/kubernetes` - The Cloud Logging + # service with a Kubernetes-native resource model + # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer + # available as of GKE 1.15). # * `none` - no logs will be exported from the cluster. - # * if left as an empty string,`logging.googleapis.com` will be used. + # If left as an empty string,`logging.googleapis.com/kubernetes` will be + # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. # Corresponds to the JSON property `loggingService` # @return [String] attr_accessor :logging_service @@ -572,9 +574,13 @@ module Google # The monitoring service the cluster should use to write metrics. # Currently available options: - # * `monitoring.googleapis.com` - the Google Cloud Monitoring service. - # * `none` - no metrics will be exported from the cluster. - # * if left as an empty string, `monitoring.googleapis.com` will be used. + # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring + # service with a Kubernetes-native resource model + # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no + # longer available as of GKE 1.15). + # * `none` - No metrics will be exported from the cluster. + # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be + # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. # Corresponds to the JSON property `monitoringService` # @return [String] attr_accessor :monitoring_service @@ -866,10 +872,13 @@ module Google # The logging service the cluster should use to write logs. # Currently available options: - # * "logging.googleapis.com/kubernetes" - the Google Cloud Logging - # service with Kubernetes-native resource model - # * "logging.googleapis.com" - the Google Cloud Logging service - # * "none" - no logs will be exported from the cluster + # * `logging.googleapis.com/kubernetes` - The Cloud Logging + # service with a Kubernetes-native resource model + # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer + # available as of GKE 1.15). + # * `none` - no logs will be exported from the cluster. + # If left as an empty string,`logging.googleapis.com/kubernetes` will be + # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. # Corresponds to the JSON property `desiredLoggingService` # @return [String] attr_accessor :desired_logging_service @@ -896,10 +905,13 @@ module Google # The monitoring service the cluster should use to write metrics. # Currently available options: - # * "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring - # service with Kubernetes-native resource model - # * "monitoring.googleapis.com" - the Google Cloud Monitoring service - # * "none" - no metrics will be exported from the cluster + # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring + # service with a Kubernetes-native resource model + # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no + # longer available as of GKE 1.15). + # * `none` - No metrics will be exported from the cluster. + # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be + # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. # Corresponds to the JSON property `desiredMonitoringService` # @return [String] attr_accessor :desired_monitoring_service @@ -3205,10 +3217,15 @@ module Google # @return [String] attr_accessor :cluster_id - # Required. The logging service the cluster should use to write metrics. + # Required. The logging service the cluster should use to write logs. # Currently available options: - # * "logging.googleapis.com" - the Google Cloud Logging service - # * "none" - no metrics will be exported from the cluster + # * `logging.googleapis.com/kubernetes` - The Cloud Logging + # service with a Kubernetes-native resource model + # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer + # available as of GKE 1.15). + # * `none` - no logs will be exported from the cluster. + # If left as an empty string,`logging.googleapis.com/kubernetes` will be + # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. # Corresponds to the JSON property `loggingService` # @return [String] attr_accessor :logging_service @@ -3366,10 +3383,13 @@ module Google # Required. The monitoring service the cluster should use to write metrics. # Currently available options: - # * "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring - # service with Kubernetes-native resource model - # * "monitoring.googleapis.com" - the Google Cloud Monitoring service - # * "none" - no metrics will be exported from the cluster + # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring + # service with a Kubernetes-native resource model + # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no + # longer available as of GKE 1.15). + # * `none` - No metrics will be exported from the cluster. + # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be + # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. # Corresponds to the JSON property `monitoringService` # @return [String] attr_accessor :monitoring_service diff --git a/generated/google/apis/container_v1/service.rb b/generated/google/apis/container_v1/service.rb index 6eebe6a4e..1ef334016 100644 --- a/generated/google/apis/container_v1/service.rb +++ b/generated/google/apis/container_v1/service.rb @@ -460,7 +460,7 @@ module Google # Sets the locations for a specific cluster. # Deprecated. Use # [projects.locations.clusters.update](/kubernetes-engine/docs/reference/rest/v1/ - # projects.locations.clusters.update) + # projects.locations.clusters/update) # instead. # @param [String] name # The name (project, location, cluster) of the cluster to set locations. @@ -1693,7 +1693,7 @@ module Google # Sets the locations for a specific cluster. # Deprecated. Use # [projects.locations.clusters.update](/kubernetes-engine/docs/reference/rest/v1/ - # projects.locations.clusters.update) + # projects.locations.clusters/update) # instead. # @param [String] project_id # Deprecated. The Google Developers Console [project ID or project diff --git a/generated/google/apis/container_v1beta1.rb b/generated/google/apis/container_v1beta1.rb index 9511bf970..158176a4c 100644 --- a/generated/google/apis/container_v1beta1.rb +++ b/generated/google/apis/container_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/container-engine/ module ContainerV1beta1 VERSION = 'V1beta1' - REVISION = '20200214' + REVISION = '20200331' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/container_v1beta1/classes.rb b/generated/google/apis/container_v1beta1/classes.rb index ff8c0c356..2e051cd25 100644 --- a/generated/google/apis/container_v1beta1/classes.rb +++ b/generated/google/apis/container_v1beta1/classes.rb @@ -63,8 +63,8 @@ module Google # @return [Google::Apis::ContainerV1beta1::DnsCacheConfig] attr_accessor :dns_cache_config - # Configuration for the GCE PD CSI driver. This option can only be enabled - # at cluster creation time. + # Configuration for the Compute Engine PD CSI driver. This option can only be + # enabled at cluster creation time. # Corresponds to the JSON property `gcePersistentDiskCsiDriverConfig` # @return [Google::Apis::ContainerV1beta1::GcePersistentDiskCsiDriverConfig] attr_accessor :gce_persistent_disk_csi_driver_config @@ -525,6 +525,7 @@ module Google alias_method :enable_kubernetes_alpha?, :enable_kubernetes_alpha # Enable the ability to use Cloud TPUs in this cluster. + # This field is deprecated, use tpu_config.enabled instead. # Corresponds to the JSON property `enableTpu` # @return [Boolean] attr_accessor :enable_tpu @@ -611,9 +612,13 @@ module Google # The logging service the cluster should use to write logs. # Currently available options: - # * `logging.googleapis.com` - the Google Cloud Logging service. + # * `logging.googleapis.com/kubernetes` - The Cloud Logging + # service with a Kubernetes-native resource model + # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer + # available as of GKE 1.15). # * `none` - no logs will be exported from the cluster. - # * if left as an empty string,`logging.googleapis.com` will be used. + # If left as an empty string,`logging.googleapis.com/kubernetes` will be + # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. # Corresponds to the JSON property `loggingService` # @return [String] attr_accessor :logging_service @@ -649,9 +654,13 @@ module Google # The monitoring service the cluster should use to write metrics. # Currently available options: - # * `monitoring.googleapis.com` - the Google Cloud Monitoring service. - # * `none` - no metrics will be exported from the cluster. - # * if left as an empty string, `monitoring.googleapis.com` will be used. + # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring + # service with a Kubernetes-native resource model + # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no + # longer available as of GKE 1.15). + # * `none` - No metrics will be exported from the cluster. + # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be + # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. # Corresponds to the JSON property `monitoringService` # @return [String] attr_accessor :monitoring_service @@ -786,10 +795,10 @@ module Google # @return [String] attr_accessor :subnetwork - # Cluster tier settings. - # Corresponds to the JSON property `tierSettings` - # @return [Google::Apis::ContainerV1beta1::TierSettings] - attr_accessor :tier_settings + # Configuration for Cloud TPU. + # Corresponds to the JSON property `tpuConfig` + # @return [Google::Apis::ContainerV1beta1::TpuConfig] + attr_accessor :tpu_config # [Output only] The IP address range of the Cloud TPUs in this cluster, in # [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) @@ -876,7 +885,7 @@ module Google @status = args[:status] if args.key?(:status) @status_message = args[:status_message] if args.key?(:status_message) @subnetwork = args[:subnetwork] if args.key?(:subnetwork) - @tier_settings = args[:tier_settings] if args.key?(:tier_settings) + @tpu_config = args[:tpu_config] if args.key?(:tpu_config) @tpu_ipv4_cidr_block = args[:tpu_ipv4_cidr_block] if args.key?(:tpu_ipv4_cidr_block) @vertical_pod_autoscaling = args[:vertical_pod_autoscaling] if args.key?(:vertical_pod_autoscaling) @workload_identity_config = args[:workload_identity_config] if args.key?(:workload_identity_config) @@ -1010,12 +1019,15 @@ module Google # @return [Array] attr_accessor :desired_locations - # The logging service the cluster should use to write metrics. + # The logging service the cluster should use to write logs. # Currently available options: - # * "logging.googleapis.com/kubernetes" - the Google Cloud Logging - # service with Kubernetes-native resource model - # * "logging.googleapis.com" - the Google Cloud Logging service - # * "none" - no logs will be exported from the cluster + # * `logging.googleapis.com/kubernetes` - The Cloud Logging + # service with a Kubernetes-native resource model + # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer + # available as of GKE 1.15). + # * `none` - no logs will be exported from the cluster. + # If left as an empty string,`logging.googleapis.com/kubernetes` will be + # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. # Corresponds to the JSON property `desiredLoggingService` # @return [String] attr_accessor :desired_logging_service @@ -1043,10 +1055,13 @@ module Google # The monitoring service the cluster should use to write metrics. # Currently available options: - # * "monitoring.googleapis.com/kubernetes" - the Google Cloud Monitoring - # service with Kubernetes-native resource model - # * "monitoring.googleapis.com" - the Google Cloud Monitoring service - # * "none" - no metrics will be exported from the cluster + # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring + # service with a Kubernetes-native resource model + # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no + # longer available as of GKE 1.15). + # * `none` - No metrics will be exported from the cluster. + # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be + # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. # Corresponds to the JSON property `desiredMonitoringService` # @return [String] attr_accessor :desired_monitoring_service @@ -1109,6 +1124,11 @@ module Google # @return [Google::Apis::ContainerV1beta1::ShieldedNodes] attr_accessor :desired_shielded_nodes + # Configuration for Cloud TPU. + # Corresponds to the JSON property `desiredTpuConfig` + # @return [Google::Apis::ContainerV1beta1::TpuConfig] + attr_accessor :desired_tpu_config + # VerticalPodAutoscaling contains global, per-cluster information # required by Vertical Pod Autoscaler to automatically adjust # the resources of pods controlled by it. @@ -1148,6 +1168,7 @@ module Google @desired_release_channel = args[:desired_release_channel] if args.key?(:desired_release_channel) @desired_resource_usage_export_config = args[:desired_resource_usage_export_config] if args.key?(:desired_resource_usage_export_config) @desired_shielded_nodes = args[:desired_shielded_nodes] if args.key?(:desired_shielded_nodes) + @desired_tpu_config = args[:desired_tpu_config] if args.key?(:desired_tpu_config) @desired_vertical_pod_autoscaling = args[:desired_vertical_pod_autoscaling] if args.key?(:desired_vertical_pod_autoscaling) @desired_workload_identity_config = args[:desired_workload_identity_config] if args.key?(:desired_workload_identity_config) end @@ -1410,38 +1431,12 @@ module Google end end - # FeatureConfig is the configuration for a specific feature including the - # definition of the feature as well as the tier in which it resides. - class FeatureConfig - include Google::Apis::Core::Hashable - - # The feature that is being configured with this value. - # Corresponds to the JSON property `feature` - # @return [String] - attr_accessor :feature - - # The tier in which the configured feature resides. - # Corresponds to the JSON property `tier` - # @return [String] - attr_accessor :tier - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @feature = args[:feature] if args.key?(:feature) - @tier = args[:tier] if args.key?(:tier) - end - end - - # Configuration for the GCE PD CSI driver. This option can only be enabled - # at cluster creation time. + # Configuration for the Compute Engine PD CSI driver. This option can only be + # enabled at cluster creation time. class GcePersistentDiskCsiDriverConfig include Google::Apis::Core::Hashable - # Whether the GCE PD CSI driver is enabled for this cluster. + # Whether the Compute Engine PD CSI driver is enabled for this cluster. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled @@ -1747,6 +1742,7 @@ module Google # notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. # `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range # to use. + # This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. # Corresponds to the JSON property `tpuIpv4CidrBlock` # @return [String] attr_accessor :tpu_ipv4_cidr_block @@ -3042,41 +3038,10 @@ module Google end end - # PremiumConfig is the configuration for all premium features and tiers. - class PremiumConfig - include Google::Apis::Core::Hashable - - # The features that GKE provides. - # Corresponds to the JSON property `features` - # @return [Array] - attr_accessor :features - - # The tiers that are part of the premium offering. - # Corresponds to the JSON property `tiers` - # @return [Array] - attr_accessor :tiers - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @features = args[:features] if args.key?(:features) - @tiers = args[:tiers] if args.key?(:tiers) - end - end - # Configuration options for private clusters. class PrivateClusterConfig include Google::Apis::Core::Hashable - # Whether to enable route sharing over the network peering. - # Corresponds to the JSON property `enablePeeringRouteSharing` - # @return [Boolean] - attr_accessor :enable_peering_route_sharing - alias_method :enable_peering_route_sharing?, :enable_peering_route_sharing - # Whether the master's internal IP address is used as the cluster endpoint. # Corresponds to the JSON property `enablePrivateEndpoint` # @return [Boolean] @@ -3091,6 +3056,11 @@ module Google attr_accessor :enable_private_nodes alias_method :enable_private_nodes?, :enable_private_nodes + # Configuration for controlling master global access settings. + # Corresponds to the JSON property `masterGlobalAccessConfig` + # @return [Google::Apis::ContainerV1beta1::PrivateClusterMasterGlobalAccessConfig] + attr_accessor :master_global_access_config + # The IP range in CIDR notation to use for the hosted master network. This # range will be used for assigning internal IP addresses to the master or # set of masters, as well as the ILB VIP. This range must not overlap with @@ -3120,9 +3090,9 @@ module Google # Update properties of this object def update!(**args) - @enable_peering_route_sharing = args[:enable_peering_route_sharing] if args.key?(:enable_peering_route_sharing) @enable_private_endpoint = args[:enable_private_endpoint] if args.key?(:enable_private_endpoint) @enable_private_nodes = args[:enable_private_nodes] if args.key?(:enable_private_nodes) + @master_global_access_config = args[:master_global_access_config] if args.key?(:master_global_access_config) @master_ipv4_cidr_block = args[:master_ipv4_cidr_block] if args.key?(:master_ipv4_cidr_block) @peering_name = args[:peering_name] if args.key?(:peering_name) @private_endpoint = args[:private_endpoint] if args.key?(:private_endpoint) @@ -3130,6 +3100,26 @@ module Google end end + # Configuration for controlling master global access settings. + class PrivateClusterMasterGlobalAccessConfig + include Google::Apis::Core::Hashable + + # Whenever master is accessible globally or not. + # Corresponds to the JSON property `enabled` + # @return [Boolean] + attr_accessor :enabled + alias_method :enabled?, :enabled + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @enabled = args[:enabled] if args.key?(:enabled) + end + end + # Represents an arbitrary window of time that recurs. class RecurringTimeWindow include Google::Apis::Core::Hashable @@ -3434,11 +3424,6 @@ module Google # @return [String] attr_accessor :default_image_type - # PremiumConfig is the configuration for all premium features and tiers. - # Corresponds to the JSON property `premiumConfig` - # @return [Google::Apis::ContainerV1beta1::PremiumConfig] - attr_accessor :premium_config - # List of valid image types. # Corresponds to the JSON property `validImageTypes` # @return [Array] @@ -3463,7 +3448,6 @@ module Google @channels = args[:channels] if args.key?(:channels) @default_cluster_version = args[:default_cluster_version] if args.key?(:default_cluster_version) @default_image_type = args[:default_image_type] if args.key?(:default_image_type) - @premium_config = args[:premium_config] if args.key?(:premium_config) @valid_image_types = args[:valid_image_types] if args.key?(:valid_image_types) @valid_master_versions = args[:valid_master_versions] if args.key?(:valid_master_versions) @valid_node_versions = args[:valid_node_versions] if args.key?(:valid_node_versions) @@ -3701,10 +3685,15 @@ module Google # @return [String] attr_accessor :cluster_id - # Required. The logging service the cluster should use to write metrics. + # Required. The logging service the cluster should use to write logs. # Currently available options: - # * "logging.googleapis.com" - the Google Cloud Logging service - # * "none" - no metrics will be exported from the cluster + # * `logging.googleapis.com/kubernetes` - The Cloud Logging + # service with a Kubernetes-native resource model + # * `logging.googleapis.com` - The legacy Cloud Logging service (no longer + # available as of GKE 1.15). + # * `none` - no logs will be exported from the cluster. + # If left as an empty string,`logging.googleapis.com/kubernetes` will be + # used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. # Corresponds to the JSON property `loggingService` # @return [String] attr_accessor :logging_service @@ -3862,8 +3851,13 @@ module Google # Required. The monitoring service the cluster should use to write metrics. # Currently available options: - # * "monitoring.googleapis.com" - the Google Cloud Monitoring service - # * "none" - no metrics will be exported from the cluster + # * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring + # service with a Kubernetes-native resource model + # * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no + # longer available as of GKE 1.15). + # * `none` - No metrics will be exported from the cluster. + # If left as an empty string,`monitoring.googleapis.com/kubernetes` will be + # used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. # Corresponds to the JSON property `monitoringService` # @return [String] attr_accessor :monitoring_service @@ -4264,53 +4258,6 @@ module Google end end - # TierConfig is the configuration for a tier offering. For example the GKE - # standard or advanced offerings which contain different levels of - # functionality and possibly cost. - class TierConfig - include Google::Apis::Core::Hashable - - # The tier from which the tier being configured inherits. The configured - # tier will inherit all the features from its parent tier. - # Corresponds to the JSON property `parent` - # @return [String] - attr_accessor :parent - - # The tier that is being configured with this value. - # Corresponds to the JSON property `tier` - # @return [String] - attr_accessor :tier - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @parent = args[:parent] if args.key?(:parent) - @tier = args[:tier] if args.key?(:tier) - end - end - - # Cluster tier settings. - class TierSettings - include Google::Apis::Core::Hashable - - # Cluster tier. - # Corresponds to the JSON property `tier` - # @return [String] - attr_accessor :tier - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @tier = args[:tier] if args.key?(:tier) - end - end - # Represents an arbitrary window of time. class TimeWindow include Google::Apis::Core::Hashable @@ -4337,6 +4284,39 @@ module Google end end + # Configuration for Cloud TPU. + class TpuConfig + include Google::Apis::Core::Hashable + + # Whether Cloud TPU integration is enabled or not. + # Corresponds to the JSON property `enabled` + # @return [Boolean] + attr_accessor :enabled + alias_method :enabled?, :enabled + + # IPv4 CIDR block reserved for Cloud TPU in the VPC. + # Corresponds to the JSON property `ipv4CidrBlock` + # @return [String] + attr_accessor :ipv4_cidr_block + + # Whether to use service networking for Cloud TPU or not. + # Corresponds to the JSON property `useServiceNetworking` + # @return [Boolean] + attr_accessor :use_service_networking + alias_method :use_service_networking?, :use_service_networking + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @enabled = args[:enabled] if args.key?(:enabled) + @ipv4_cidr_block = args[:ipv4_cidr_block] if args.key?(:ipv4_cidr_block) + @use_service_networking = args[:use_service_networking] if args.key?(:use_service_networking) + end + end + # UpdateClusterRequest updates the settings of a cluster. class UpdateClusterRequest include Google::Apis::Core::Hashable diff --git a/generated/google/apis/container_v1beta1/representations.rb b/generated/google/apis/container_v1beta1/representations.rb index 80161ec33..ed15d572b 100644 --- a/generated/google/apis/container_v1beta1/representations.rb +++ b/generated/google/apis/container_v1beta1/representations.rb @@ -166,12 +166,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class FeatureConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GcePersistentDiskCsiDriverConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -388,13 +382,13 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class PremiumConfig + class PrivateClusterConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class PrivateClusterConfig + class PrivateClusterMasterGlobalAccessConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -550,24 +544,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class TierConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TierSettings - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class TimeWindow class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class TpuConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class UpdateClusterRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -813,7 +801,7 @@ module Google property :status, as: 'status' property :status_message, as: 'statusMessage' property :subnetwork, as: 'subnetwork' - property :tier_settings, as: 'tierSettings', class: Google::Apis::ContainerV1beta1::TierSettings, decorator: Google::Apis::ContainerV1beta1::TierSettings::Representation + property :tpu_config, as: 'tpuConfig', class: Google::Apis::ContainerV1beta1::TpuConfig, decorator: Google::Apis::ContainerV1beta1::TpuConfig::Representation property :tpu_ipv4_cidr_block, as: 'tpuIpv4CidrBlock' property :vertical_pod_autoscaling, as: 'verticalPodAutoscaling', class: Google::Apis::ContainerV1beta1::VerticalPodAutoscaling, decorator: Google::Apis::ContainerV1beta1::VerticalPodAutoscaling::Representation @@ -880,6 +868,8 @@ module Google property :desired_shielded_nodes, as: 'desiredShieldedNodes', class: Google::Apis::ContainerV1beta1::ShieldedNodes, decorator: Google::Apis::ContainerV1beta1::ShieldedNodes::Representation + property :desired_tpu_config, as: 'desiredTpuConfig', class: Google::Apis::ContainerV1beta1::TpuConfig, decorator: Google::Apis::ContainerV1beta1::TpuConfig::Representation + property :desired_vertical_pod_autoscaling, as: 'desiredVerticalPodAutoscaling', class: Google::Apis::ContainerV1beta1::VerticalPodAutoscaling, decorator: Google::Apis::ContainerV1beta1::VerticalPodAutoscaling::Representation property :desired_workload_identity_config, as: 'desiredWorkloadIdentityConfig', class: Google::Apis::ContainerV1beta1::WorkloadIdentityConfig, decorator: Google::Apis::ContainerV1beta1::WorkloadIdentityConfig::Representation @@ -956,14 +946,6 @@ module Google end end - class FeatureConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :feature, as: 'feature' - property :tier, as: 'tier' - end - end - class GcePersistentDiskCsiDriverConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1355,22 +1337,13 @@ module Google end end - class PremiumConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :features, as: 'features', class: Google::Apis::ContainerV1beta1::FeatureConfig, decorator: Google::Apis::ContainerV1beta1::FeatureConfig::Representation - - collection :tiers, as: 'tiers', class: Google::Apis::ContainerV1beta1::TierConfig, decorator: Google::Apis::ContainerV1beta1::TierConfig::Representation - - end - end - class PrivateClusterConfig # @private class Representation < Google::Apis::Core::JsonRepresentation - property :enable_peering_route_sharing, as: 'enablePeeringRouteSharing' property :enable_private_endpoint, as: 'enablePrivateEndpoint' property :enable_private_nodes, as: 'enablePrivateNodes' + property :master_global_access_config, as: 'masterGlobalAccessConfig', class: Google::Apis::ContainerV1beta1::PrivateClusterMasterGlobalAccessConfig, decorator: Google::Apis::ContainerV1beta1::PrivateClusterMasterGlobalAccessConfig::Representation + property :master_ipv4_cidr_block, as: 'masterIpv4CidrBlock' property :peering_name, as: 'peeringName' property :private_endpoint, as: 'privateEndpoint' @@ -1378,6 +1351,13 @@ module Google end end + class PrivateClusterMasterGlobalAccessConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :enabled, as: 'enabled' + end + end + class RecurringTimeWindow # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1459,8 +1439,6 @@ module Google property :default_cluster_version, as: 'defaultClusterVersion' property :default_image_type, as: 'defaultImageType' - property :premium_config, as: 'premiumConfig', class: Google::Apis::ContainerV1beta1::PremiumConfig, decorator: Google::Apis::ContainerV1beta1::PremiumConfig::Representation - collection :valid_image_types, as: 'validImageTypes' collection :valid_master_versions, as: 'validMasterVersions' collection :valid_node_versions, as: 'validNodeVersions' @@ -1644,21 +1622,6 @@ module Google end end - class TierConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :parent, as: 'parent' - property :tier, as: 'tier' - end - end - - class TierSettings - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :tier, as: 'tier' - end - end - class TimeWindow # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1667,6 +1630,15 @@ module Google end end + class TpuConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :enabled, as: 'enabled' + property :ipv4_cidr_block, as: 'ipv4CidrBlock' + property :use_service_networking, as: 'useServiceNetworking' + end + end + class UpdateClusterRequest # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/container_v1beta1/service.rb b/generated/google/apis/container_v1beta1/service.rb index 913a4aeb2..05164a4a7 100644 --- a/generated/google/apis/container_v1beta1/service.rb +++ b/generated/google/apis/container_v1beta1/service.rb @@ -491,7 +491,7 @@ module Google # Sets the locations for a specific cluster. # Deprecated. Use # [projects.locations.clusters.update](/kubernetes-engine/docs/reference/rest/ - # v1beta1/projects.locations.clusters.update) + # v1beta1/projects.locations.clusters/update) # instead. # @param [String] name # The name (project, location, cluster) of the cluster to set locations. @@ -1724,7 +1724,7 @@ module Google # Sets the locations for a specific cluster. # Deprecated. Use # [projects.locations.clusters.update](/kubernetes-engine/docs/reference/rest/ - # v1beta1/projects.locations.clusters.update) + # v1beta1/projects.locations.clusters/update) # instead. # @param [String] project_id # Required. Deprecated. The Google Developers Console [project ID or project diff --git a/generated/google/apis/content_v2.rb b/generated/google/apis/content_v2.rb index fa4675f8c..cd18c993d 100644 --- a/generated/google/apis/content_v2.rb +++ b/generated/google/apis/content_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/shopping-content module ContentV2 VERSION = 'V2' - REVISION = '20200226' + REVISION = '20200310' # Manage your product listings and accounts for Google Shopping AUTH_CONTENT = 'https://www.googleapis.com/auth/content' diff --git a/generated/google/apis/content_v2/classes.rb b/generated/google/apis/content_v2/classes.rb index 7fb2bed2f..da6a5fd77 100644 --- a/generated/google/apis/content_v2/classes.rb +++ b/generated/google/apis/content_v2/classes.rb @@ -54,7 +54,7 @@ module Google # @return [Google::Apis::ContentV2::AccountGoogleMyBusinessLink] attr_accessor :google_my_business_link - # Merchant Center account ID. + # Required for update. Merchant Center account ID. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id @@ -65,7 +65,7 @@ module Google # @return [String] attr_accessor :kind - # Display name for the account. + # Required. Display name for the account. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -184,6 +184,9 @@ module Google # remain unchanged. Re-uploading a link with deprecated status inactive is # equivalent to not submitting the link at all and will delete the link if it # was active or cancel the link request if it was pending. + # Acceptable values are: + # - "active" + # - "pending" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -273,6 +276,9 @@ module Google attr_accessor :gmb_email # Status of the link between this Merchant Center account and the GMB account. + # Acceptable values are: + # - "active" + # - "pending" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -397,6 +403,10 @@ module Google attr_accessor :id # Severity of the issue. + # Acceptable values are: + # - "critical" + # - "error" + # - "suggestion" # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity @@ -471,7 +481,10 @@ module Google # @return [Fixnum] attr_accessor :num_items - # + # Acceptable values are: + # - "critical" + # - "error" + # - "suggestion" # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity @@ -610,6 +623,9 @@ module Google include Google::Apis::Core::Hashable # The channel the data applies to. + # Acceptable values are: + # - "local" + # - "online" # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel @@ -689,7 +705,7 @@ module Google class AccountTax include Google::Apis::Core::Hashable - # The ID of the account to which these account tax settings belong. + # Required. The ID of the account to which these account tax settings belong. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id @@ -727,8 +743,8 @@ module Google # @return [String] attr_accessor :country - # State (or province) is which the tax is applicable, described by its location - # ID (also called criteria ID). + # Required. State (or province) is which the tax is applicable, described by its + # location ID (also called criteria ID). # Corresponds to the JSON property `locationId` # @return [Fixnum] attr_accessor :location_id @@ -953,6 +969,13 @@ module Google attr_accessor :merchant_id # The method of the batch entry. + # Acceptable values are: + # - "claimWebsite" + # - "delete" + # - "get" + # - "insert" + # - "link" + # - "update" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method @@ -987,11 +1010,18 @@ module Google # Action to perform for this link. The "request" action is only available to # select merchants. + # Acceptable values are: + # - "approve" + # - "remove" + # - "request" # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # Type of the link between the two accounts. + # Acceptable values are: + # - "channelPartner" + # - "eCommercePlatform" # Corresponds to the JSON property `linkType` # @return [String] attr_accessor :link_type @@ -1067,6 +1097,10 @@ module Google attr_accessor :kind # Deprecated. This field is never set. + # Acceptable values are: + # - "active" + # - "inactive" + # - "pending" # Corresponds to the JSON property `linkStatus` # @return [String] attr_accessor :link_status @@ -1091,11 +1125,18 @@ module Google # Action to perform for this link. The "request" action is only available to # select merchants. + # Acceptable values are: + # - "approve" + # - "remove" + # - "request" # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # Type of the link between the two accounts. + # Acceptable values are: + # - "channelPartner" + # - "eCommercePlatform" # Corresponds to the JSON property `linkType` # @return [String] attr_accessor :link_type @@ -1213,7 +1254,9 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # The method (get). + # The method of the batch entry. + # Acceptable values are: + # - "get" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method @@ -1365,7 +1408,10 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # The method of the batch entry. + # Acceptable values are: + # - "get" + # - "update" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method @@ -1622,6 +1668,16 @@ module Google attr_accessor :name # The type of the attribute. + # Acceptable values are: + # - "boolean" + # - "datetimerange" + # - "float" + # - "group" + # - "int" + # - "price" + # - "text" + # - "time" + # - "url" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -1685,6 +1741,21 @@ module Google attr_accessor :description # Code of the return reason. + # Acceptable values are: + # - "betterPriceFound" + # - "changedMind" + # - "damagedOrDefectiveItem" + # - "didNotMatchDescription" + # - "doesNotFit" + # - "expiredItem" + # - "incorrectItemReceived" + # - "noLongerNeeded" + # - "notSpecified" + # - "orderedWrongItem" + # - "other" + # - "qualityNotExpected" + # - "receivedTooLate" + # - "undeliverable" # Corresponds to the JSON property `reasonCode` # @return [String] attr_accessor :reason_code @@ -1750,8 +1821,12 @@ module Google # @return [String] attr_accessor :content_language - # The type of data feed. For product inventory feeds, only feeds for local - # stores, not online stores, are supported. + # Required. The type of data feed. For product inventory feeds, only feeds for + # local stores, not online stores, are supported. + # Acceptable values are: + # - "local products" + # - "product inventory" + # - "products" # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type @@ -1764,7 +1839,7 @@ module Google # @return [Google::Apis::ContentV2::DatafeedFetchSchedule] attr_accessor :fetch_schedule - # The filename of the feed. All feeds must have a unique file name. + # Required. The filename of the feed. All feeds must have a unique file name. # Corresponds to the JSON property `fileName` # @return [String] attr_accessor :file_name @@ -1774,7 +1849,7 @@ module Google # @return [Google::Apis::ContentV2::DatafeedFormat] attr_accessor :format - # The ID of the data feed. + # Required for update. The ID of the data feed. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id @@ -1791,7 +1866,7 @@ module Google # @return [String] attr_accessor :kind - # A descriptive name of the data feed. + # Required for insert. A descriptive name of the data feed. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1881,6 +1956,14 @@ module Google attr_accessor :username # The day of the week the feed file should be fetched. + # Acceptable values are: + # - "monday" + # - "tuesday" + # - "wednesday" + # - "thursday" + # - "friday" + # - "saturday" + # - "sunday" # Corresponds to the JSON property `weekday` # @return [String] attr_accessor :weekday @@ -1910,18 +1993,31 @@ module Google # Delimiter for the separation of values in a delimiter-separated values feed. # If not specified, the delimiter will be auto-detected. Ignored for non-DSV # data feeds. + # Acceptable values are: + # - "pipe" + # - "tab" + # - "tilde" # Corresponds to the JSON property `columnDelimiter` # @return [String] attr_accessor :column_delimiter # Character encoding scheme of the data feed. If not specified, the encoding # will be auto-detected. + # Acceptable values are: + # - "latin-1" + # - "utf-16be" + # - "utf-16le" + # - "utf-8" + # - "windows-1252" # Corresponds to the JSON property `fileEncoding` # @return [String] attr_accessor :file_encoding # Specifies how double quotes are interpreted. If not specified, the mode will # be auto-detected. Ignored for non-DSV data feeds. + # Acceptable values are: + # - "normal character" + # - "value quoting" # Corresponds to the JSON property `quotingMode` # @return [String] attr_accessor :quoting_mode @@ -1986,6 +2082,13 @@ module Google attr_accessor :last_upload_date # The processing status of the feed. + # Acceptable values are: + # - ""failure": The feed could not be processed or all items had errors." + # - "in progress": The feed is being processed. + # - "none": The feed has not yet been processed. For example, a feed that has + # never been uploaded will have this processing status. + # - "success": The feed was processed successfully, though some items might have + # had errors. # Corresponds to the JSON property `processingStatus` # @return [String] attr_accessor :processing_status @@ -2172,7 +2275,13 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # The method of the batch entry. + # Acceptable values are: + # - "delete" + # - "fetchNow" + # - "get" + # - "insert" + # - "update" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method @@ -2352,7 +2461,9 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # The method of the batch entry. + # Acceptable values are: + # - "get" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method @@ -2810,6 +2921,15 @@ module Google attr_accessor :id # The holiday type. Always present. + # Acceptable values are: + # - "Christmas" + # - "Easter" + # - "Father's Day" + # - "Halloween" + # - "Independence Day (USA)" + # - "Mother's Day" + # - "Thanksgiving" + # - "Valentine's Day" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -2859,6 +2979,10 @@ module Google include Google::Apis::Core::Hashable # The availability of the product. + # Acceptable values are: + # - "in stock" + # - "out of stock" + # - "preorder" # Corresponds to the JSON property `availability` # @return [String] attr_accessor :availability @@ -3105,6 +3229,11 @@ module Google # should be shown as buy, reserve, or not supported. Only supported for local # inventory. Unless the value is "not supported", must be submitted together # with pickupSla. + # Acceptable values are: + # - "buy" + # - "not supported" + # - "reserve" + # - "ship to store" # Corresponds to the JSON property `pickupMethod` # @return [String] attr_accessor :pickup_method @@ -3112,6 +3241,17 @@ module Google # The expected date that an order will be ready for pickup, relative to when the # order is placed. Only supported for local inventory. Must be submitted # together with pickupMethod. + # Acceptable values are: + # - "five day" + # - "four day" + # - "multi day" + # - "multi week" + # - "next day" + # - "same day" + # - "seven day" + # - "six day" + # - "three day" + # - "two day" # Corresponds to the JSON property `pickupSla` # @return [String] attr_accessor :pickup_sla @@ -3132,6 +3272,10 @@ module Google include Google::Apis::Core::Hashable # The availability of the product. + # Acceptable values are: + # - "in stock" + # - "out of stock" + # - "preorder" # Corresponds to the JSON property `availability` # @return [String] attr_accessor :availability @@ -3321,6 +3465,8 @@ module Google attr_accessor :total_amount # [required] Type of the additional charge. + # Acceptable values are: + # - "shipping" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -3341,6 +3487,10 @@ module Google include Google::Apis::Core::Hashable # The status of the verification process for the About page. + # Acceptable values are: + # - "active" + # - "inactive" + # - "pending" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -3370,7 +3520,7 @@ module Google # @return [Google::Apis::ContentV2::LiaAboutPageSettings] attr_accessor :about - # CLDR country code (e.g. "US"). + # Required. CLDR country code (e.g. "US"). # Corresponds to the JSON property `country` # @return [String] attr_accessor :country @@ -3433,11 +3583,19 @@ module Google attr_accessor :inventory_verification_contact_name # The status of the verification contact. + # Acceptable values are: + # - "active" + # - "inactive" + # - "pending" # Corresponds to the JSON property `inventoryVerificationContactStatus` # @return [String] attr_accessor :inventory_verification_contact_status # The status of the inventory verification process. + # Acceptable values are: + # - "active" + # - "inactive" + # - "pending" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -3465,6 +3623,10 @@ module Google attr_accessor :shipping_cost_policy_url # The status of the ?On display to order? feature. + # Acceptable values are: + # - "active" + # - "inactive" + # - "pending" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -3605,7 +3767,14 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # The method of the batch entry. + # Acceptable values are: + # - "get" + # - "getAccessibleGmbAccounts" + # - "requestGmbAccess" + # - "requestInventoryVerification" + # - "setInventoryVerificationContact" + # - "update" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -4021,6 +4190,12 @@ module Google attr_accessor :return_shipment_ids # State of the item. + # Acceptable values are: + # - "canceled" + # - "new" + # - "received" + # - "refunded" + # - "rejected" # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -4052,6 +4227,9 @@ module Google alias_method :acknowledged?, :acknowledged # Deprecated. + # Acceptable values are: + # - "googleExpress" + # - "purchasesOnGoogle" # Corresponds to the JSON property `channelType` # @return [String] attr_accessor :channel_type @@ -4105,6 +4283,11 @@ module Google attr_accessor :payment_method # The status of the payment. + # Acceptable values are: + # - "paymentCaptured" + # - "paymentRejected" + # - "paymentSecured" + # - "pendingAuthorization" # Corresponds to the JSON property `paymentStatus` # @return [String] attr_accessor :payment_status @@ -4162,16 +4345,36 @@ module Google attr_accessor :shipping_cost_tax # Deprecated. Shipping details are provided with line items instead. + # Acceptable values are: + # - "economy" + # - "expedited" + # - "oneDay" + # - "sameDay" + # - "standard" + # - "twoDay" # Corresponds to the JSON property `shippingOption` # @return [String] attr_accessor :shipping_option # The status of the order. + # Acceptable values are: + # - "canceled" + # - "delivered" + # - "inProgress" + # - "partiallyDelivered" + # - "partiallyReturned" + # - "partiallyShipped" + # - "pendingShipment" + # - "returned" + # - "shipped" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The party responsible for collecting and remitting taxes. + # Acceptable values are: + # - "marketplaceFacilitator" + # - "merchant" # Corresponds to the JSON property `taxCollector` # @return [String] attr_accessor :tax_collector @@ -4281,6 +4484,13 @@ module Google include Google::Apis::Core::Hashable # The actor that created the cancellation. + # Acceptable values are: + # - "customer" + # - "googleBot" + # - "googleCustomerService" + # - "googlePayments" + # - "googleSabre" + # - "merchant" # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor @@ -4298,6 +4508,35 @@ module Google # The reason for the cancellation. Orders that are canceled with a noInventory # reason will lead to the removal of the product from Shopping Actions until you # make an update to that product. This will not affect your Shopping ads. + # Acceptable values are: + # - "autoPostInternal" + # - "autoPostInvalidBillingAddress" + # - "autoPostNoInventory" + # - "autoPostPriceError" + # - "autoPostUndeliverableShippingAddress" + # - "couponAbuse" + # - "customerCanceled" + # - "customerInitiatedCancel" + # - "customerSupportRequested" + # - "failToPushOrderGoogleError" + # - "failToPushOrderMerchantError" + # - "failToPushOrderMerchantFulfillmentError" + # - "failToPushOrderToMerchant" + # - "failToPushOrderToMerchantOutOfStock" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "merchantDidNotShipOnTime" + # - "noInventory" + # - "orderTimeout" + # - "other" + # - "paymentAbuse" + # - "paymentDeclined" + # - "priceError" + # - "returnRefundAbuse" + # - "shippingPriceError" + # - "taxError" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -4379,6 +4618,9 @@ module Google # customer selected granted in their most recent order, they can be subscribed # to marketing emails. Customers who have chosen denied must not be subscribed, # or must be unsubscribed if already opted-in. + # Acceptable values are: + # - "denied" + # - "granted" # Corresponds to the JSON property `explicitMarketingPreference` # @return [String] attr_accessor :explicit_marketing_preference @@ -4470,11 +4712,16 @@ module Google attr_accessor :long_title # Whether the promotion is applicable to all products or only specific products. + # Acceptable values are: + # - "allProducts" + # - "specificProducts" # Corresponds to the JSON property `productApplicability` # @return [String] attr_accessor :product_applicability # Indicates that the promotion is valid online. + # Acceptable values are: + # - "online" # Corresponds to the JSON property `redemptionChannel` # @return [String] attr_accessor :redemption_channel @@ -4512,6 +4759,21 @@ module Google # Further describes the benefit of the promotion. Note that we will expand on # this enumeration as we support new promotion sub-types. + # Acceptable values are: + # - "buyMGetMoneyOff" + # - "buyMGetNMoneyOff" + # - "buyMGetNPercentOff" + # - "buyMGetPercentOff" + # - "freeGift" + # - "freeGiftWithItemId" + # - "freeGiftWithValue" + # - "freeOvernightShipping" + # - "freeShipping" + # - "freeTwoDayShipping" + # - "moneyOff" + # - "percentageOff" + # - "rewardPoints" + # - "salePrice" # Corresponds to the JSON property `subType` # @return [String] attr_accessor :sub_type @@ -4523,6 +4785,9 @@ module Google # Describes whether the promotion applies to products (e.g. 20% off) or to # shipping (e.g. Free Shipping). + # Acceptable values are: + # - "product" + # - "shipping" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -4664,11 +4929,18 @@ module Google attr_accessor :brand # The item's channel (online or local). + # Acceptable values are: + # - "local" + # - "online" # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel # Condition or state of the item. + # Acceptable values are: + # - "new" + # - "refurbished" + # - "used" # Corresponds to the JSON property `condition` # @return [String] attr_accessor :condition @@ -4819,18 +5091,18 @@ module Google class OrderLineItemReturnInfo include Google::Apis::Core::Hashable - # How many days later the item can be returned. + # Required. How many days later the item can be returned. # Corresponds to the JSON property `daysToReturn` # @return [Fixnum] attr_accessor :days_to_return - # Whether the item is returnable. + # Required. Whether the item is returnable. # Corresponds to the JSON property `isReturnable` # @return [Boolean] attr_accessor :is_returnable alias_method :is_returnable?, :is_returnable - # URL of the item return policy. + # Required. URL of the item return policy. # Corresponds to the JSON property `policyUrl` # @return [String] attr_accessor :policy_url @@ -4851,23 +5123,26 @@ module Google class OrderLineItemShippingDetails include Google::Apis::Core::Hashable - # The delivery by date, in ISO 8601 format. + # Required. The delivery by date, in ISO 8601 format. # Corresponds to the JSON property `deliverByDate` # @return [String] attr_accessor :deliver_by_date - # Details of the shipping method. + # Required. Details of the shipping method. # Corresponds to the JSON property `method` # @return [Google::Apis::ContentV2::OrderLineItemShippingDetailsMethod] attr_accessor :method_prop - # The ship by date, in ISO 8601 format. + # Required. The ship by date, in ISO 8601 format. # Corresponds to the JSON property `shipByDate` # @return [String] attr_accessor :ship_by_date # Type of shipment. Indicates whether deliveryDetails or pickupDetails is # applicable for this shipment. + # Acceptable values are: + # - "delivery" + # - "pickup" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -4895,17 +5170,17 @@ module Google # @return [String] attr_accessor :carrier - # Maximum transit time. + # Required. Maximum transit time. # Corresponds to the JSON property `maxDaysInTransit` # @return [Fixnum] attr_accessor :max_days_in_transit - # The name of the shipping method. + # Required. The name of the shipping method. # Corresponds to the JSON property `methodName` # @return [String] attr_accessor :method_name - # Minimum transit time. + # Required. Minimum transit time. # Corresponds to the JSON property `minDaysInTransit` # @return [Fixnum] attr_accessor :min_days_in_transit @@ -5070,6 +5345,13 @@ module Google include Google::Apis::Core::Hashable # The actor that created the refund. + # Acceptable values are: + # - "customer" + # - "googleBot" + # - "googleCustomerService" + # - "googlePayments" + # - "googleSabre" + # - "merchant" # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor @@ -5085,6 +5367,51 @@ module Google attr_accessor :creation_date # The reason for the refund. + # Acceptable values are: + # - "adjustment" + # - "autoPostInternal" + # - "autoPostInvalidBillingAddress" + # - "autoPostNoInventory" + # - "autoPostPriceError" + # - "autoPostUndeliverableShippingAddress" + # - "couponAbuse" + # - "courtesyAdjustment" + # - "customerCanceled" + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "customerSupportRequested" + # - "deliveredLateByCarrier" + # - "deliveredTooLate" + # - "expiredItem" + # - "failToPushOrderGoogleError" + # - "failToPushOrderMerchantError" + # - "failToPushOrderMerchantFulfillmentError" + # - "failToPushOrderToMerchant" + # - "failToPushOrderToMerchantOutOfStock" + # - "feeAdjustment" + # - "invalidCoupon" + # - "lateShipmentCredit" + # - "malformedShippingAddress" + # - "merchantDidNotShipOnTime" + # - "noInventory" + # - "orderTimeout" + # - "other" + # - "paymentAbuse" + # - "paymentDeclined" + # - "priceAdjustment" + # - "priceError" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "promoReallocation" + # - "qualityNotAsExpected" + # - "returnRefundAbuse" + # - "shippingCostAdjustment" + # - "shippingPriceError" + # - "taxAdjustment" + # - "taxError" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5229,6 +5556,13 @@ module Google include Google::Apis::Core::Hashable # The actor that created the refund. + # Acceptable values are: + # - "customer" + # - "googleBot" + # - "googleCustomerService" + # - "googlePayments" + # - "googleSabre" + # - "merchant" # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor @@ -5244,6 +5578,20 @@ module Google attr_accessor :quantity # The reason for the return. + # Acceptable values are: + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "deliveredTooLate" + # - "expiredItem" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "other" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "qualityNotAsExpected" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5341,6 +5689,11 @@ module Google attr_accessor :line_items # The status of the shipment. + # Acceptable values are: + # - "delivered" + # - "readyForPickup" + # - "shipped" + # - "undeliverable" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -5450,6 +5803,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5522,6 +5878,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5553,6 +5912,51 @@ module Google attr_accessor :description # [required] Reason for the refund. + # Acceptable values are: + # - "adjustment" + # - "autoPostInternal" + # - "autoPostInvalidBillingAddress" + # - "autoPostNoInventory" + # - "autoPostPriceError" + # - "autoPostUndeliverableShippingAddress" + # - "couponAbuse" + # - "courtesyAdjustment" + # - "customerCanceled" + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "customerSupportRequested" + # - "deliveredLateByCarrier" + # - "deliveredTooLate" + # - "expiredItem" + # - "failToPushOrderGoogleError" + # - "failToPushOrderMerchantError" + # - "failToPushOrderMerchantFulfillmentError" + # - "failToPushOrderToMerchant" + # - "failToPushOrderToMerchantOutOfStock" + # - "feeAdjustment" + # - "invalidCoupon" + # - "lateShipmentCredit" + # - "malformedShippingAddress" + # - "merchantDidNotShipOnTime" + # - "noInventory" + # - "orderTimeout" + # - "other" + # - "paymentAbuse" + # - "paymentDeclined" + # - "priceAdjustment" + # - "priceError" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "promoReallocation" + # - "qualityNotAsExpected" + # - "returnRefundAbuse" + # - "shippingCostAdjustment" + # - "shippingPriceError" + # - "taxAdjustment" + # - "taxError" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5578,6 +5982,20 @@ module Google attr_accessor :description # [required] Reason for the return. + # Acceptable values are: + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "deliveredTooLate" + # - "expiredItem" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "other" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "qualityNotAsExpected" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5713,6 +6131,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5799,6 +6220,17 @@ module Google attr_accessor :quantity # The reason for the cancellation. + # Acceptable values are: + # - "customerInitiatedCancel" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "noInventory" + # - "other" + # - "priceError" + # - "shippingPriceError" + # - "taxError" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5831,6 +6263,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5862,6 +6297,17 @@ module Google attr_accessor :operation_id # The reason for the cancellation. + # Acceptable values are: + # - "customerInitiatedCancel" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "noInventory" + # - "other" + # - "priceError" + # - "shippingPriceError" + # - "taxError" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5888,6 +6334,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5914,6 +6363,10 @@ module Google include Google::Apis::Core::Hashable # The reason for the cancellation. + # Acceptable values are: + # - "changedMind" + # - "orderedWrongItem" + # - "other" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5965,6 +6418,12 @@ module Google # The test order template to use. Specify as an alternative to testOrder as a # shortcut for retrieving a template and then creating an order using that # template. + # Acceptable values are: + # - "template1" + # - "template1a" + # - "template1b" + # - "template2" + # - "template3" # Corresponds to the JSON property `templateName` # @return [String] attr_accessor :template_name @@ -6111,7 +6570,23 @@ module Google # @return [String] attr_accessor :merchant_order_id - # The method to apply. + # The method of the batch entry. + # Acceptable values are: + # - "acknowledge" + # - "cancel" + # - "cancelLineItem" + # - "get" + # - "getByMerchantOrderId" + # - "inStoreRefundLineItem" + # - "refund" + # - "rejectReturnLineItem" + # - "returnLineItem" + # - "returnRefundLineItem" + # - "setLineItemMetadata" + # - "shipLineItems" + # - "updateLineItemShippingDetails" + # - "updateMerchantOrderId" + # - "updateShipment" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -6198,6 +6673,17 @@ module Google include Google::Apis::Core::Hashable # The reason for the cancellation. + # Acceptable values are: + # - "customerInitiatedCancel" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "noInventory" + # - "other" + # - "priceError" + # - "shippingPriceError" + # - "taxError" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6258,6 +6744,17 @@ module Google attr_accessor :quantity # The reason for the cancellation. + # Acceptable values are: + # - "customerInitiatedCancel" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "noInventory" + # - "other" + # - "priceError" + # - "shippingPriceError" + # - "taxError" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6340,6 +6837,20 @@ module Google attr_accessor :quantity # The reason for the return. + # Acceptable values are: + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "deliveredTooLate" + # - "expiredItem" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "other" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "qualityNotAsExpected" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6386,6 +6897,23 @@ module Google attr_accessor :amount_tax # The reason for the refund. + # Acceptable values are: + # - "adjustment" + # - "courtesyAdjustment" + # - "customerCanceled" + # - "customerDiscretionaryReturn" + # - "deliveredLateByCarrier" + # - "feeAdjustment" + # - "lateShipmentCredit" + # - "noInventory" + # - "other" + # - "priceError" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "shippingCostAdjustment" + # - "taxAdjustment" + # - "undeliverableShippingAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6430,6 +6958,12 @@ module Google attr_accessor :quantity # The reason for the return. + # Acceptable values are: + # - "damagedOrUsed" + # - "missingComponent" + # - "notEligible" + # - "other" + # - "outOfReturnWindow" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6474,6 +7008,20 @@ module Google attr_accessor :quantity # The reason for the return. + # Acceptable values are: + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "deliveredTooLate" + # - "expiredItem" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "other" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "qualityNotAsExpected" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6531,6 +7079,20 @@ module Google attr_accessor :quantity # The reason for the return. + # Acceptable values are: + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "deliveredTooLate" + # - "expiredItem" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "other" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "qualityNotAsExpected" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6652,8 +7214,8 @@ module Google # @return [String] attr_accessor :carrier - # The ID of the shipment. This is assigned by the merchant and is unique to each - # shipment. + # Required. The ID of the shipment. This is assigned by the merchant and is + # unique to each shipment. # Corresponds to the JSON property `shipmentId` # @return [String] attr_accessor :shipment_id @@ -6742,6 +7304,9 @@ module Google attr_accessor :shipment_id # New status for the shipment. Not updated if missing. + # Acceptable values are: + # - "delivered" + # - "undeliverable" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -6808,6 +7373,9 @@ module Google # The status of the execution. Only defined if # - the request was successful; and # - the method is not get, getByMerchantOrderId, or one of the test methods. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -6927,6 +7495,20 @@ module Google attr_accessor :quantity # The reason for the return. + # Acceptable values are: + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "deliveredTooLate" + # - "expiredItem" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "other" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "qualityNotAsExpected" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -6958,6 +7540,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -7037,6 +7622,23 @@ module Google attr_accessor :operation_id # The reason for the refund. + # Acceptable values are: + # - "adjustment" + # - "courtesyAdjustment" + # - "customerCanceled" + # - "customerDiscretionaryReturn" + # - "deliveredLateByCarrier" + # - "feeAdjustment" + # - "lateShipmentCredit" + # - "noInventory" + # - "other" + # - "priceError" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "shippingCostAdjustment" + # - "taxAdjustment" + # - "undeliverableShippingAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -7066,6 +7668,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -7113,6 +7718,12 @@ module Google attr_accessor :quantity # The reason for the return. + # Acceptable values are: + # - "damagedOrUsed" + # - "missingComponent" + # - "notEligible" + # - "other" + # - "outOfReturnWindow" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -7142,6 +7753,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -7189,6 +7803,20 @@ module Google attr_accessor :quantity # The reason for the return. + # Acceptable values are: + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "deliveredTooLate" + # - "expiredItem" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "other" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "qualityNotAsExpected" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -7218,6 +7846,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -7278,6 +7909,20 @@ module Google attr_accessor :quantity # The reason for the return. + # Acceptable values are: + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "deliveredTooLate" + # - "expiredItem" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "other" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "qualityNotAsExpected" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -7309,6 +7954,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -7374,6 +8022,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -7459,6 +8110,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -7536,6 +8190,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -7587,6 +8244,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -7635,6 +8295,9 @@ module Google attr_accessor :shipment_id # New status for the shipment. Not updated if missing. + # Acceptable values are: + # - "delivered" + # - "undeliverable" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -7664,6 +8327,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -7779,7 +8445,13 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # The method of the batch entry. + # Acceptable values are: + # - "delete" + # - "get" + # - "insert" + # - "inventory" + # - "sale" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -7957,7 +8629,7 @@ module Google class PosInventory include Google::Apis::Core::Hashable - # The two-letter ISO 639-1 language code for the item. + # Required. The two-letter ISO 639-1 language code for the item. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -7967,7 +8639,7 @@ module Google # @return [String] attr_accessor :gtin - # A unique identifier for the item. + # Required. A unique identifier for the item. # Corresponds to the JSON property `itemId` # @return [String] attr_accessor :item_id @@ -7978,28 +8650,28 @@ module Google # @return [String] attr_accessor :kind - # The current price of the item. + # Required. The current price of the item. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2::Price] attr_accessor :price - # The available quantity of the item. + # Required. The available quantity of the item. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity - # The identifier of the merchant's store. Either a storeCode inserted via the - # API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a storeCode inserted + # via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code - # The CLDR territory code for the item. + # Required. The CLDR territory code for the item. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country - # The inventory timestamp, in ISO 8601 format. + # Required. The inventory timestamp, in ISO 8601 format. # Corresponds to the JSON property `timestamp` # @return [String] attr_accessor :timestamp @@ -8026,7 +8698,7 @@ module Google class PosInventoryRequest include Google::Apis::Core::Hashable - # The two-letter ISO 639-1 language code for the item. + # Required. The two-letter ISO 639-1 language code for the item. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -8036,33 +8708,33 @@ module Google # @return [String] attr_accessor :gtin - # A unique identifier for the item. + # Required. A unique identifier for the item. # Corresponds to the JSON property `itemId` # @return [String] attr_accessor :item_id - # The current price of the item. + # Required. The current price of the item. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2::Price] attr_accessor :price - # The available quantity of the item. + # Required. The available quantity of the item. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity - # The identifier of the merchant's store. Either a storeCode inserted via the - # API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a storeCode inserted + # via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code - # The CLDR territory code for the item. + # Required. The CLDR territory code for the item. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country - # The inventory timestamp, in ISO 8601 format. + # Required. The inventory timestamp, in ISO 8601 format. # Corresponds to the JSON property `timestamp` # @return [String] attr_accessor :timestamp @@ -8088,7 +8760,7 @@ module Google class PosInventoryResponse include Google::Apis::Core::Hashable - # The two-letter ISO 639-1 language code for the item. + # Required. The two-letter ISO 639-1 language code for the item. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -8098,7 +8770,7 @@ module Google # @return [String] attr_accessor :gtin - # A unique identifier for the item. + # Required. A unique identifier for the item. # Corresponds to the JSON property `itemId` # @return [String] attr_accessor :item_id @@ -8109,28 +8781,28 @@ module Google # @return [String] attr_accessor :kind - # The current price of the item. + # Required. The current price of the item. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2::Price] attr_accessor :price - # The available quantity of the item. + # Required. The available quantity of the item. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity - # The identifier of the merchant's store. Either a storeCode inserted via the - # API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a storeCode inserted + # via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code - # The CLDR territory code for the item. + # Required. The CLDR territory code for the item. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country - # The inventory timestamp, in ISO 8601 format. + # Required. The inventory timestamp, in ISO 8601 format. # Corresponds to the JSON property `timestamp` # @return [String] attr_accessor :timestamp @@ -8183,7 +8855,7 @@ module Google class PosSale include Google::Apis::Core::Hashable - # The two-letter ISO 639-1 language code for the item. + # Required. The two-letter ISO 639-1 language code for the item. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -8193,7 +8865,7 @@ module Google # @return [String] attr_accessor :gtin - # A unique identifier for the item. + # Required. A unique identifier for the item. # Corresponds to the JSON property `itemId` # @return [String] attr_accessor :item_id @@ -8204,12 +8876,13 @@ module Google # @return [String] attr_accessor :kind - # The price of the item. + # Required. The price of the item. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2::Price] attr_accessor :price - # The relative change of the available quantity. Negative for items returned. + # Required. The relative change of the available quantity. Negative for items + # returned. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity @@ -8219,18 +8892,18 @@ module Google # @return [String] attr_accessor :sale_id - # The identifier of the merchant's store. Either a storeCode inserted via the - # API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a storeCode inserted + # via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code - # The CLDR territory code for the item. + # Required. The CLDR territory code for the item. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country - # The inventory timestamp, in ISO 8601 format. + # Required. The inventory timestamp, in ISO 8601 format. # Corresponds to the JSON property `timestamp` # @return [String] attr_accessor :timestamp @@ -8258,7 +8931,7 @@ module Google class PosSaleRequest include Google::Apis::Core::Hashable - # The two-letter ISO 639-1 language code for the item. + # Required. The two-letter ISO 639-1 language code for the item. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -8268,17 +8941,18 @@ module Google # @return [String] attr_accessor :gtin - # A unique identifier for the item. + # Required. A unique identifier for the item. # Corresponds to the JSON property `itemId` # @return [String] attr_accessor :item_id - # The price of the item. + # Required. The price of the item. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2::Price] attr_accessor :price - # The relative change of the available quantity. Negative for items returned. + # Required. The relative change of the available quantity. Negative for items + # returned. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity @@ -8288,18 +8962,18 @@ module Google # @return [String] attr_accessor :sale_id - # The identifier of the merchant's store. Either a storeCode inserted via the - # API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a storeCode inserted + # via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code - # The CLDR territory code for the item. + # Required. The CLDR territory code for the item. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country - # The inventory timestamp, in ISO 8601 format. + # Required. The inventory timestamp, in ISO 8601 format. # Corresponds to the JSON property `timestamp` # @return [String] attr_accessor :timestamp @@ -8326,7 +9000,7 @@ module Google class PosSaleResponse include Google::Apis::Core::Hashable - # The two-letter ISO 639-1 language code for the item. + # Required. The two-letter ISO 639-1 language code for the item. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -8336,7 +9010,7 @@ module Google # @return [String] attr_accessor :gtin - # A unique identifier for the item. + # Required. A unique identifier for the item. # Corresponds to the JSON property `itemId` # @return [String] attr_accessor :item_id @@ -8347,12 +9021,13 @@ module Google # @return [String] attr_accessor :kind - # The price of the item. + # Required. The price of the item. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2::Price] attr_accessor :price - # The relative change of the available quantity. Negative for items returned. + # Required. The relative change of the available quantity. Negative for items + # returned. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity @@ -8362,18 +9037,18 @@ module Google # @return [String] attr_accessor :sale_id - # The identifier of the merchant's store. Either a storeCode inserted via the - # API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a storeCode inserted + # via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code - # The CLDR territory code for the item. + # Required. The CLDR territory code for the item. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country - # The inventory timestamp, in ISO 8601 format. + # Required. The inventory timestamp, in ISO 8601 format. # Corresponds to the JSON property `timestamp` # @return [String] attr_accessor :timestamp @@ -8407,12 +9082,12 @@ module Google # @return [String] attr_accessor :kind - # The street address of the store. + # Required. The street address of the store. # Corresponds to the JSON property `storeAddress` # @return [String] attr_accessor :store_address - # A store identifier that is unique for the given merchant. + # Required. A store identifier that is unique for the given merchant. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code @@ -8558,6 +9233,13 @@ module Google attr_accessor :adwords_redirect # Target age group of the item. + # Acceptable values are: + # - "adult" + # - "infant" + # - "kids" + # - "newborn" + # - "toddler" + # - "youngAdult" # Corresponds to the JSON property `ageGroup` # @return [String] attr_accessor :age_group @@ -8568,6 +9250,10 @@ module Google attr_accessor :aspects # Availability status of the item. + # Acceptable values are: + # - "in stock" + # - "out of stock" + # - "preorder" # Corresponds to the JSON property `availability` # @return [String] attr_accessor :availability @@ -8583,7 +9269,10 @@ module Google # @return [String] attr_accessor :brand - # The item's channel (online or local). + # Required. The item's channel (online or local). + # Acceptable values are: + # - "local" + # - "online" # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel @@ -8594,11 +9283,14 @@ module Google attr_accessor :color # Condition or state of the item. + # Acceptable values are: + # - "local" + # - "online" # Corresponds to the JSON property `condition` # @return [String] attr_accessor :condition - # The two-letter ISO 639-1 language code for the item. + # Required. The two-letter ISO 639-1 language code for the item. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -8683,6 +9375,17 @@ module Google attr_accessor :display_ads_value # The energy efficiency class as defined in EU directive 2010/30/EU. + # Acceptable values are: + # - "A" + # - "A+" + # - "A++" + # - "A+++" + # - "B" + # - "C" + # - "D" + # - "E" + # - "F" + # - "G" # Corresponds to the JSON property `energyEfficiencyClass` # @return [String] attr_accessor :energy_efficiency_class @@ -8696,6 +9399,10 @@ module Google attr_accessor :expiration_date # Target gender of the item. + # Acceptable values are: + # - "female" + # - "male" + # - "unisex" # Corresponds to the JSON property `gender` # @return [String] attr_accessor :gender @@ -8770,6 +9477,17 @@ module Google attr_accessor :material # The energy efficiency class as defined in EU directive 2010/30/EU. + # Acceptable values are: + # - "A" + # - "A+" + # - "A++" + # - "A+++" + # - "B" + # - "C" + # - "D" + # - "E" + # - "F" + # - "G" # Corresponds to the JSON property `maxEnergyEfficiencyClass` # @return [String] attr_accessor :max_energy_efficiency_class @@ -8780,6 +9498,17 @@ module Google attr_accessor :max_handling_time # The energy efficiency class as defined in EU directive 2010/30/EU. + # Acceptable values are: + # - "A" + # - "A+" + # - "A++" + # - "A+++" + # - "B" + # - "C" + # - "D" + # - "E" + # - "F" + # - "G" # Corresponds to the JSON property `minEnergyEfficiencyClass` # @return [String] attr_accessor :min_energy_efficiency_class @@ -8804,8 +9533,8 @@ module Google # @return [Fixnum] attr_accessor :multipack - # A unique identifier for the item. Leading and trailing whitespaces are - # stripped and multiple whitespaces are replaced by a single whitespace upon + # Required. A unique identifier for the item. Leading and trailing whitespaces + # are stripped and multiple whitespaces are replaced by a single whitespace upon # submission. Only valid unicode characters are accepted. See the products feed # specification for details. # Note: Content API methods that operate on products take the REST ID of the @@ -8888,11 +9617,30 @@ module Google attr_accessor :shipping_width # System in which the size is specified. Recommended for apparel items. + # Acceptable values are: + # - "AU" + # - "BR" + # - "CN" + # - "DE" + # - "EU" + # - "FR" + # - "IT" + # - "JP" + # - "MEX" + # - "UK" + # - "US" # Corresponds to the JSON property `sizeSystem` # @return [String] attr_accessor :size_system # The cut of the item. Recommended for apparel items. + # Acceptable values are: + # - "big and tall" + # - "maternity" + # - "oversize" + # - "petite" + # - "plus" + # - "regular" # Corresponds to the JSON property `sizeType` # @return [String] attr_accessor :size_type @@ -8905,11 +9653,15 @@ module Google attr_accessor :sizes # The source of the offer, i.e., how the offer was created. + # Acceptable values are: + # - "api" + # - "crawl" + # - "feed" # Corresponds to the JSON property `source` # @return [String] attr_accessor :source - # The CLDR territory code for the item. + # Required. The CLDR territory code for the item. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country @@ -9104,6 +9856,11 @@ module Google attr_accessor :destination_name # Whether the destination is required, excluded or should be validated. + # Acceptable values are: + # - "default" + # - "excluded" + # - "optional" + # - "required" # Corresponds to the JSON property `intention` # @return [String] attr_accessor :intention @@ -9388,6 +10145,9 @@ module Google alias_method :approval_pending?, :approval_pending # The destination's approval status. + # Acceptable values are: + # - "approved" + # - "disapproved" # Corresponds to the JSON property `approvalStatus` # @return [String] attr_accessor :approval_status @@ -9398,6 +10158,11 @@ module Google attr_accessor :destination # Provided for backward compatibility only. Always set to "required". + # Acceptable values are: + # - "default" + # - "excluded" + # - "optional" + # - "required" # Corresponds to the JSON property `intention` # @return [String] attr_accessor :intention @@ -9612,7 +10377,11 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # The method of the batch entry. + # Acceptable values are: + # - "delete" + # - "get" + # - "insert" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method @@ -9785,7 +10554,9 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # The method of the batch entry. + # Acceptable values are: + # - "get" # Corresponds to the JSON property `method` # @return [String] attr_accessor :request_method @@ -10000,6 +10771,51 @@ module Google attr_accessor :description # Code of the refund reason. + # Acceptable values are: + # - "adjustment" + # - "autoPostInternal" + # - "autoPostInvalidBillingAddress" + # - "autoPostNoInventory" + # - "autoPostPriceError" + # - "autoPostUndeliverableShippingAddress" + # - "couponAbuse" + # - "courtesyAdjustment" + # - "customerCanceled" + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "customerSupportRequested" + # - "deliveredLateByCarrier" + # - "deliveredTooLate" + # - "expiredItem" + # - "failToPushOrderGoogleError" + # - "failToPushOrderMerchantError" + # - "failToPushOrderMerchantFulfillmentError" + # - "failToPushOrderToMerchant" + # - "failToPushOrderToMerchantOutOfStock" + # - "feeAdjustment" + # - "invalidCoupon" + # - "lateShipmentCredit" + # - "malformedShippingAddress" + # - "merchantDidNotShipOnTime" + # - "noInventory" + # - "orderTimeout" + # - "other" + # - "paymentAbuse" + # - "paymentDeclined" + # - "priceAdjustment" + # - "priceError" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "promoReallocation" + # - "qualityNotAsExpected" + # - "returnRefundAbuse" + # - "shippingCostAdjustment" + # - "shippingPriceError" + # - "taxAdjustment" + # - "taxError" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reasonCode` # @return [String] attr_accessor :reason_code @@ -10030,6 +10846,10 @@ module Google attr_accessor :delivery_date # Type of the return method. + # Acceptable values are: + # - "byMail" + # - "contactCustomerSupport" + # - "returnless" # Corresponds to the JSON property `returnMethodType` # @return [String] attr_accessor :return_method_type @@ -10051,6 +10871,11 @@ module Google attr_accessor :shipping_date # State of the shipment. + # Acceptable values are: + # - "completed" + # - "new" + # - "shipped" + # - "undeliverable" # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -10120,6 +10945,10 @@ module Google attr_accessor :delivery_time # Eligibility for this service. + # Acceptable values are: + # - "All scenarios" + # - "All scenarios except Shopping Actions" + # - "Shopping Actions" # Corresponds to the JSON property `eligibility` # @return [String] attr_accessor :eligibility @@ -10151,6 +10980,9 @@ module Google attr_accessor :rate_groups # Type of locations this service ships orders to. + # Acceptable values are: + # - "delivery" + # - "pickup" # Corresponds to the JSON property `shipmentType` # @return [String] attr_accessor :shipment_type @@ -10253,6 +11085,37 @@ module Google include Google::Apis::Core::Hashable # The shipping carrier that handles the package. + # Acceptable values are: + # - "boxtal" + # - "bpost" + # - "chronopost" + # - "colisPrive" + # - "colissimo" + # - "cxt" + # - "deliv" + # - "dhl" + # - "dpd" + # - "dynamex" + # - "eCourier" + # - "easypost" + # - "efw" + # - "fedex" + # - "fedexSmartpost" + # - "geodis" + # - "gls" + # - "googleCourier" + # - "gsx" + # - "jdLogistics" + # - "laPoste" + # - "lasership" + # - "manual" + # - "mpx" + # - "onTrac" + # - "other" + # - "tnt" + # - "uds" + # - "ups" + # - "usps" # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier @@ -10344,7 +11207,10 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # The method of the batch entry. + # Acceptable values are: + # - "get" + # - "update" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -10588,7 +11454,7 @@ module Google class TestOrder include Google::Apis::Core::Hashable - # The details of the customer who placed the order. + # Required. The details of the customer who placed the order. # Corresponds to the JSON property `customer` # @return [Google::Apis::ContentV2::TestOrderCustomer] attr_accessor :customer @@ -10605,13 +11471,16 @@ module Google # @return [String] attr_accessor :kind - # Line items that are ordered. At least one line item must be provided. + # Required. Line items that are ordered. At least one line item must be provided. # Corresponds to the JSON property `lineItems` # @return [Array] attr_accessor :line_items # Determines if test order must be pulled by merchant or pushed to merchant via # push integration. + # Acceptable values are: + # - "checkoutIntegration" + # - "merchantPull" # Corresponds to the JSON property `notificationMode` # @return [String] attr_accessor :notification_mode @@ -10621,13 +11490,22 @@ module Google # @return [Google::Apis::ContentV2::TestOrderPaymentMethod] attr_accessor :payment_method - # Identifier of one of the predefined delivery addresses for the delivery. + # Required. Identifier of one of the predefined delivery addresses for the + # delivery. + # Acceptable values are: + # - "dwight" + # - "jim" + # - "pam" # Corresponds to the JSON property `predefinedDeliveryAddress` # @return [String] attr_accessor :predefined_delivery_address # Identifier of one of the predefined pickup details. Required for orders # containing line items with shipping type pickup. + # Acceptable values are: + # - "dwight" + # - "jim" + # - "pam" # Corresponds to the JSON property `predefinedPickupDetails` # @return [String] attr_accessor :predefined_pickup_details @@ -10637,10 +11515,10 @@ module Google # @return [Array] attr_accessor :promotions - # The price of shipping for all items. Shipping tax is automatically calculated - # for orders where marketplace facilitator tax laws are applicable. Otherwise, - # tax settings from Merchant Center are applied. Note that shipping is not taxed - # in certain states. + # Required. The price of shipping for all items. Shipping tax is automatically + # calculated for orders where marketplace facilitator tax laws are applicable. + # Otherwise, tax settings from Merchant Center are applied. Note that shipping + # is not taxed in certain states. # Corresponds to the JSON property `shippingCost` # @return [Google::Apis::ContentV2::Price] attr_accessor :shipping_cost @@ -10650,7 +11528,14 @@ module Google # @return [Google::Apis::ContentV2::Price] attr_accessor :shipping_cost_tax - # The requested shipping option. + # Required. The requested shipping option. + # Acceptable values are: + # - "economy" + # - "expedited" + # - "oneDay" + # - "sameDay" + # - "standard" + # - "twoDay" # Corresponds to the JSON property `shippingOption` # @return [String] attr_accessor :shipping_option @@ -10680,7 +11565,11 @@ module Google class TestOrderCustomer include Google::Apis::Core::Hashable - # Email address of the customer. + # Required. Email address of the customer. + # Acceptable values are: + # - "pog.dwight.schrute@gmail.com" + # - "pog.jim.halpert@gmail.com" + # - "penpog.pam.beesly@gmail.comding" # Corresponds to the JSON property `email` # @return [String] attr_accessor :email @@ -10720,6 +11609,9 @@ module Google # Last know user use selection regards marketing preferences. In certain cases # selection might not be known, so this field would be empty. + # Acceptable values are: + # - "denied" + # - "granted" # Corresponds to the JSON property `explicitMarketingPreference` # @return [String] attr_accessor :explicit_marketing_preference @@ -10745,22 +11637,22 @@ module Google class TestOrderLineItem include Google::Apis::Core::Hashable - # Product data from the time of the order placement. + # Required. Product data from the time of the order placement. # Corresponds to the JSON property `product` # @return [Google::Apis::ContentV2::TestOrderLineItemProduct] attr_accessor :product - # Number of items ordered. + # Required. Number of items ordered. # Corresponds to the JSON property `quantityOrdered` # @return [Fixnum] attr_accessor :quantity_ordered - # Details of the return policy for the line item. + # Required. Details of the return policy for the line item. # Corresponds to the JSON property `returnInfo` # @return [Google::Apis::ContentV2::OrderLineItemReturnInfo] attr_accessor :return_info - # Details of the requested shipping for the line item. + # Required. Details of the requested shipping for the line item. # Corresponds to the JSON property `shippingDetails` # @return [Google::Apis::ContentV2::OrderLineItemShippingDetails] attr_accessor :shipping_details @@ -10788,22 +11680,29 @@ module Google class TestOrderLineItemProduct include Google::Apis::Core::Hashable - # Brand of the item. + # Required. Brand of the item. # Corresponds to the JSON property `brand` # @return [String] attr_accessor :brand # Deprecated. + # Acceptable values are: + # - "online" # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel - # Condition or state of the item. + # Required. Condition or state of the item. + # Acceptable values are: + # - "new" # Corresponds to the JSON property `condition` # @return [String] attr_accessor :condition - # The two-letter ISO 639-1 language code for the item. + # Required. The two-letter ISO 639-1 language code for the item. + # Acceptable values are: + # - "en" + # - "fr" # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -10818,7 +11717,7 @@ module Google # @return [String] attr_accessor :gtin - # URL of an image of the item. + # Required. URL of an image of the item. # Corresponds to the JSON property `imageLink` # @return [String] attr_accessor :image_link @@ -10833,24 +11732,24 @@ module Google # @return [String] attr_accessor :mpn - # An identifier of the item. + # Required. An identifier of the item. # Corresponds to the JSON property `offerId` # @return [String] attr_accessor :offer_id - # The price for the product. Tax is automatically calculated for orders where - # marketplace facilitator tax laws are applicable. Otherwise, tax settings from - # Merchant Center are applied. + # Required. The price for the product. Tax is automatically calculated for + # orders where marketplace facilitator tax laws are applicable. Otherwise, tax + # settings from Merchant Center are applied. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2::Price] attr_accessor :price - # The CLDR territory code of the target country of the product. + # Required. The CLDR territory code of the target country of the product. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country - # The title of the product. + # Required. The title of the product. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -10903,12 +11802,21 @@ module Google attr_accessor :last_four_digits # The billing address. + # Acceptable values are: + # - "dwight" + # - "jim" + # - "pam" # Corresponds to the JSON property `predefinedBillingAddress` # @return [String] attr_accessor :predefined_billing_address # The type of instrument. Note that real orders might have different values than # the four values accepted by createTestOrder. + # Acceptable values are: + # - "AMEX" + # - "DISCOVER" + # - "MASTERCARD" + # - "VISA" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -11058,6 +11966,8 @@ module Google attr_accessor :additional_charge_promotions # [required] Type of the additional charge. + # Acceptable values are: + # - "shipping" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -11090,6 +12000,10 @@ module Google attr_accessor :tax_name # [required] Type of the tax. + # Acceptable values are: + # - "otherFee" + # - "otherFeeTax" + # - "sales" # Corresponds to the JSON property `taxType` # @return [String] attr_accessor :tax_type @@ -11160,12 +12074,15 @@ module Google class Weight include Google::Apis::Core::Hashable - # The weight unit. + # Required. The weight unit. + # Acceptable values are: + # - "kg" + # - "lb" # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit - # The weight represented as a number. + # Required. The weight represented as a number. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value diff --git a/generated/google/apis/content_v2_1.rb b/generated/google/apis/content_v2_1.rb index 4be33716d..24f23e9b4 100644 --- a/generated/google/apis/content_v2_1.rb +++ b/generated/google/apis/content_v2_1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/shopping-content module ContentV2_1 VERSION = 'V2_1' - REVISION = '20200226' + REVISION = '20200310' # Manage your product listings and accounts for Google Shopping AUTH_CONTENT = 'https://www.googleapis.com/auth/content' diff --git a/generated/google/apis/content_v2_1/classes.rb b/generated/google/apis/content_v2_1/classes.rb index 0ae23f69c..78c919d9e 100644 --- a/generated/google/apis/content_v2_1/classes.rb +++ b/generated/google/apis/content_v2_1/classes.rb @@ -54,7 +54,7 @@ module Google # @return [Google::Apis::ContentV2_1::AccountGoogleMyBusinessLink] attr_accessor :google_my_business_link - # Merchant Center account ID. + # Required for update. Merchant Center account ID. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id @@ -65,7 +65,7 @@ module Google # @return [String] attr_accessor :kind - # Display name for the account. + # Required. Display name for the account. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -178,6 +178,9 @@ module Google # uploading a link with deprecated status inactive is equivalent to not # submitting the link at all and will delete the link if it was active or cancel # the link request if it was pending. + # Acceptable values are: + # - "active" + # - "pending" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -267,6 +270,9 @@ module Google attr_accessor :gmb_email # Status of the link between this Merchant Center account and the GMB account. + # Acceptable values are: + # - "active" + # - "pending" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -385,6 +391,10 @@ module Google attr_accessor :id # Severity of the issue. + # Acceptable values are: + # - "critical" + # - "error" + # - "suggestion" # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity @@ -476,6 +486,9 @@ module Google include Google::Apis::Core::Hashable # The channel the data applies to. + # Acceptable values are: + # - "local" + # - "online" # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel @@ -555,7 +568,7 @@ module Google class AccountTax include Google::Apis::Core::Hashable - # The ID of the account to which these account tax settings belong. + # Required. The ID of the account to which these account tax settings belong. # Corresponds to the JSON property `accountId` # @return [Fixnum] attr_accessor :account_id @@ -593,8 +606,8 @@ module Google # @return [String] attr_accessor :country - # State (or province) is which the tax is applicable, described by its location - # ID (also called criteria ID). + # Required. State (or province) is which the tax is applicable, described by its + # location ID (also called criteria ID). # Corresponds to the JSON property `locationId` # @return [Fixnum] attr_accessor :location_id @@ -819,6 +832,13 @@ module Google attr_accessor :merchant_id # The method of the batch entry. + # Acceptable values are: + # - "claimWebsite" + # - "delete" + # - "get" + # - "insert" + # - "link" + # - "update" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -853,11 +873,18 @@ module Google # Action to perform for this link. The "request" action is only available to # select merchants. + # Acceptable values are: + # - "approve" + # - "remove" + # - "request" # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # Type of the link between the two accounts. + # Acceptable values are: + # - "channelPartner" + # - "eCommercePlatform" # Corresponds to the JSON property `linkType` # @return [String] attr_accessor :link_type @@ -957,11 +984,18 @@ module Google # Action to perform for this link. The "request" action is only available to # select merchants. + # Acceptable values are: + # - "approve" + # - "remove" + # - "request" # Corresponds to the JSON property `action` # @return [String] attr_accessor :action # Type of the link between the two accounts. + # Acceptable values are: + # - "channelPartner" + # - "eCommercePlatform" # Corresponds to the JSON property `linkType` # @return [String] attr_accessor :link_type @@ -1117,7 +1151,9 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # The method (get). + # The method of the batch entry. + # Acceptable values are: + # - "get" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -1269,7 +1305,10 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # The method of the batch entry. + # Acceptable values are: + # - "get" + # - "update" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -1559,6 +1598,21 @@ module Google attr_accessor :description # Code of the return reason. + # Acceptable values are: + # - "betterPriceFound" + # - "changedMind" + # - "damagedOrDefectiveItem" + # - "didNotMatchDescription" + # - "doesNotFit" + # - "expiredItem" + # - "incorrectItemReceived" + # - "noLongerNeeded" + # - "notSpecified" + # - "orderedWrongItem" + # - "other" + # - "qualityNotExpected" + # - "receivedTooLate" + # - "undeliverable" # Corresponds to the JSON property `reasonCode` # @return [String] attr_accessor :reason_code @@ -1618,8 +1672,12 @@ module Google # @return [String] attr_accessor :attribute_language - # The type of data feed. For product inventory feeds, only feeds for local - # stores, not online stores, are supported. + # Required. The type of data feed. For product inventory feeds, only feeds for + # local stores, not online stores, are supported. + # Acceptable values are: + # - "local products" + # - "product inventory" + # - "products" # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type @@ -1632,7 +1690,7 @@ module Google # @return [Google::Apis::ContentV2_1::DatafeedFetchSchedule] attr_accessor :fetch_schedule - # The filename of the feed. All feeds must have a unique file name. + # Required. The filename of the feed. All feeds must have a unique file name. # Corresponds to the JSON property `fileName` # @return [String] attr_accessor :file_name @@ -1642,7 +1700,7 @@ module Google # @return [Google::Apis::ContentV2_1::DatafeedFormat] attr_accessor :format - # The ID of the data feed. + # Required for update. The ID of the data feed. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id @@ -1653,7 +1711,7 @@ module Google # @return [String] attr_accessor :kind - # A descriptive name of the data feed. + # Required for insert. A descriptive name of the data feed. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1733,6 +1791,14 @@ module Google attr_accessor :username # The day of the week the feed file should be fetched. + # Acceptable values are: + # - "monday" + # - "tuesday" + # - "wednesday" + # - "thursday" + # - "friday" + # - "saturday" + # - "sunday" # Corresponds to the JSON property `weekday` # @return [String] attr_accessor :weekday @@ -1762,18 +1828,31 @@ module Google # Delimiter for the separation of values in a delimiter-separated values feed. # If not specified, the delimiter will be auto-detected. Ignored for non-DSV # data feeds. + # Acceptable values are: + # - "pipe" + # - "tab" + # - "tilde" # Corresponds to the JSON property `columnDelimiter` # @return [String] attr_accessor :column_delimiter # Character encoding scheme of the data feed. If not specified, the encoding # will be auto-detected. + # Acceptable values are: + # - "latin-1" + # - "utf-16be" + # - "utf-16le" + # - "utf-8" + # - "windows-1252" # Corresponds to the JSON property `fileEncoding` # @return [String] attr_accessor :file_encoding # Specifies how double quotes are interpreted. If not specified, the mode will # be auto-detected. Ignored for non-DSV data feeds. + # Acceptable values are: + # - "normal character" + # - "value quoting" # Corresponds to the JSON property `quotingMode` # @return [String] attr_accessor :quoting_mode @@ -1838,6 +1917,13 @@ module Google attr_accessor :last_upload_date # The processing status of the feed. + # Acceptable values are: + # - ""failure": The feed could not be processed or all items had errors." + # - "in progress": The feed is being processed. + # - "none": The feed has not yet been processed. For example, a feed that has + # never been uploaded will have this processing status. + # - "success": The feed was processed successfully, though some items might have + # had errors. # Corresponds to the JSON property `processingStatus` # @return [String] attr_accessor :processing_status @@ -2024,7 +2110,13 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # The method of the batch entry. + # Acceptable values are: + # - "delete" + # - "fetchNow" + # - "get" + # - "insert" + # - "update" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -2204,7 +2296,9 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # The method of the batch entry. + # Acceptable values are: + # - "get" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -2662,6 +2756,15 @@ module Google attr_accessor :id # The holiday type. Always present. + # Acceptable values are: + # - "Christmas" + # - "Easter" + # - "Father's Day" + # - "Halloween" + # - "Independence Day (USA)" + # - "Mother's Day" + # - "Thanksgiving" + # - "Valentine's Day" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -2741,6 +2844,8 @@ module Google attr_accessor :total_amount # [required] Type of the additional charge. + # Acceptable values are: + # - "shipping" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -2761,6 +2866,10 @@ module Google include Google::Apis::Core::Hashable # The status of the verification process for the About page. + # Acceptable values are: + # - "active" + # - "inactive" + # - "pending" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -2790,7 +2899,7 @@ module Google # @return [Google::Apis::ContentV2_1::LiaAboutPageSettings] attr_accessor :about - # CLDR country code (e.g. "US"). + # Required. CLDR country code (e.g. "US"). # Corresponds to the JSON property `country` # @return [String] attr_accessor :country @@ -2853,11 +2962,19 @@ module Google attr_accessor :inventory_verification_contact_name # The status of the verification contact. + # Acceptable values are: + # - "active" + # - "inactive" + # - "pending" # Corresponds to the JSON property `inventoryVerificationContactStatus` # @return [String] attr_accessor :inventory_verification_contact_status # The status of the inventory verification process. + # Acceptable values are: + # - "active" + # - "inactive" + # - "pending" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -2885,6 +3002,10 @@ module Google attr_accessor :shipping_cost_policy_url # The status of the ?On display to order? feature. + # Acceptable values are: + # - "active" + # - "inactive" + # - "pending" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -3025,7 +3146,14 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # The method of the batch entry. + # Acceptable values are: + # - "get" + # - "getAccessibleGmbAccounts" + # - "requestGmbAccess" + # - "requestInventoryVerification" + # - "setInventoryVerificationContact" + # - "update" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -3312,11 +3440,19 @@ module Google include Google::Apis::Core::Hashable # Service provided to or by the linked account. + # Acceptable values are: + # - "shoppingActionsOrderManagement" + # - "shoppingActionsProductManagement" + # - "shoppingAdsProductManagement" # Corresponds to the JSON property `service` # @return [String] attr_accessor :service # Status of the link + # Acceptable values are: + # - "active" + # - "inactive" + # - "pending" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -3357,6 +3493,207 @@ module Google end end + # Local inventory resource. For accepted attribute values, see the local product + # inventory feed specification. + class LocalInventory + include Google::Apis::Core::Hashable + + # Availability of the product. + # Corresponds to the JSON property `availability` + # @return [String] + attr_accessor :availability + + # In-store product location. + # Corresponds to the JSON property `instoreProductLocation` + # @return [String] + attr_accessor :instore_product_location + + # Identifies what kind of resource this is. Value: the fixed string "content# + # localInventory". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Supported pickup method for this offer. Unless the value is "not supported", + # this field must be submitted together with pickupSla. + # Corresponds to the JSON property `pickupMethod` + # @return [String] + attr_accessor :pickup_method + + # Expected date that an order will be ready for pickup relative to the order + # date. Must be submitted together with pickupMethod. + # Corresponds to the JSON property `pickupSla` + # @return [String] + attr_accessor :pickup_sla + + # Price of the product. + # Corresponds to the JSON property `price` + # @return [Google::Apis::ContentV2_1::Price] + attr_accessor :price + + # Quantity of the product. Must be nonnegative. + # Corresponds to the JSON property `quantity` + # @return [Fixnum] + attr_accessor :quantity + + # Sale price of the product. Mandatory if sale_price_effective_date is defined. + # Corresponds to the JSON property `salePrice` + # @return [Google::Apis::ContentV2_1::Price] + attr_accessor :sale_price + + # A date range represented by a pair of ISO 8601 dates separated by a space, + # comma, or slash. Both dates may be specified as 'null' if undecided. + # Corresponds to the JSON property `salePriceEffectiveDate` + # @return [String] + attr_accessor :sale_price_effective_date + + # Required. Store code of this local inventory resource. + # Corresponds to the JSON property `storeCode` + # @return [String] + attr_accessor :store_code + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @availability = args[:availability] if args.key?(:availability) + @instore_product_location = args[:instore_product_location] if args.key?(:instore_product_location) + @kind = args[:kind] if args.key?(:kind) + @pickup_method = args[:pickup_method] if args.key?(:pickup_method) + @pickup_sla = args[:pickup_sla] if args.key?(:pickup_sla) + @price = args[:price] if args.key?(:price) + @quantity = args[:quantity] if args.key?(:quantity) + @sale_price = args[:sale_price] if args.key?(:sale_price) + @sale_price_effective_date = args[:sale_price_effective_date] if args.key?(:sale_price_effective_date) + @store_code = args[:store_code] if args.key?(:store_code) + end + end + + # + class LocalinventoryCustomBatchRequest + include Google::Apis::Core::Hashable + + # The request entries to be processed in the batch. + # Corresponds to the JSON property `entries` + # @return [Array] + attr_accessor :entries + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entries = args[:entries] if args.key?(:entries) + end + end + + # Batch entry encoding a single local inventory update request. + class LocalinventoryCustomBatchRequestEntry + include Google::Apis::Core::Hashable + + # An entry ID, unique within the batch request. + # Corresponds to the JSON property `batchId` + # @return [Fixnum] + attr_accessor :batch_id + + # Local inventory resource. For accepted attribute values, see the local product + # inventory feed specification. + # Corresponds to the JSON property `localInventory` + # @return [Google::Apis::ContentV2_1::LocalInventory] + attr_accessor :local_inventory + + # The ID of the managing account. + # Corresponds to the JSON property `merchantId` + # @return [Fixnum] + attr_accessor :merchant_id + + # Method of the batch request entry. + # Acceptable values are: + # - "insert" + # Corresponds to the JSON property `method` + # @return [String] + attr_accessor :method_prop + + # The ID of the product for which to update local inventory. + # Corresponds to the JSON property `productId` + # @return [String] + attr_accessor :product_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @batch_id = args[:batch_id] if args.key?(:batch_id) + @local_inventory = args[:local_inventory] if args.key?(:local_inventory) + @merchant_id = args[:merchant_id] if args.key?(:merchant_id) + @method_prop = args[:method_prop] if args.key?(:method_prop) + @product_id = args[:product_id] if args.key?(:product_id) + end + end + + # + class LocalinventoryCustomBatchResponse + include Google::Apis::Core::Hashable + + # The result of the execution of the batch requests. + # Corresponds to the JSON property `entries` + # @return [Array] + attr_accessor :entries + + # Identifies what kind of resource this is. Value: the fixed string "content# + # localinventoryCustomBatchResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entries = args[:entries] if args.key?(:entries) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Batch entry encoding a single local inventory update response. + class LocalinventoryCustomBatchResponseEntry + include Google::Apis::Core::Hashable + + # The ID of the request entry this entry responds to. + # Corresponds to the JSON property `batchId` + # @return [Fixnum] + attr_accessor :batch_id + + # A list of errors returned by a failed batch entry. + # Corresponds to the JSON property `errors` + # @return [Google::Apis::ContentV2_1::Errors] + attr_accessor :errors + + # Identifies what kind of resource this is. Value: the fixed string "content# + # localinventoryCustomBatchResponseEntry". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @batch_id = args[:batch_id] if args.key?(:batch_id) + @errors = args[:errors] if args.key?(:errors) + @kind = args[:kind] if args.key?(:kind) + end + end + # class LocationIdSet include Google::Apis::Core::Hashable @@ -3491,6 +3828,12 @@ module Google attr_accessor :return_shipment_ids # State of the item. + # Acceptable values are: + # - "canceled" + # - "new" + # - "received" + # - "refunded" + # - "rejected" # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -3577,6 +3920,11 @@ module Google attr_accessor :net_tax_amount # The status of the payment. + # Acceptable values are: + # - "paymentCaptured" + # - "paymentRejected" + # - "paymentSecured" + # - "pendingAuthorization" # Corresponds to the JSON property `paymentStatus` # @return [String] attr_accessor :payment_status @@ -3635,11 +3983,24 @@ module Google attr_accessor :shipping_cost_tax # The status of the order. + # Acceptable values are: + # - "canceled" + # - "delivered" + # - "inProgress" + # - "partiallyDelivered" + # - "partiallyReturned" + # - "partiallyShipped" + # - "pendingShipment" + # - "returned" + # - "shipped" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The party responsible for collecting and remitting taxes. + # Acceptable values are: + # - "marketplaceFacilitator" + # - "merchant" # Corresponds to the JSON property `taxCollector` # @return [String] attr_accessor :tax_collector @@ -3748,6 +4109,13 @@ module Google include Google::Apis::Core::Hashable # The actor that created the cancellation. + # Acceptable values are: + # - "customer" + # - "googleBot" + # - "googleCustomerService" + # - "googlePayments" + # - "googleSabre" + # - "merchant" # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor @@ -3765,6 +4133,35 @@ module Google # The reason for the cancellation. Orders that are canceled with a noInventory # reason will lead to the removal of the product from Shopping Actions until you # make an update to that product. This will not affect your Shopping ads. + # Acceptable values are: + # - "autoPostInternal" + # - "autoPostInvalidBillingAddress" + # - "autoPostNoInventory" + # - "autoPostPriceError" + # - "autoPostUndeliverableShippingAddress" + # - "couponAbuse" + # - "customerCanceled" + # - "customerInitiatedCancel" + # - "customerSupportRequested" + # - "failToPushOrderGoogleError" + # - "failToPushOrderMerchantError" + # - "failToPushOrderMerchantFulfillmentError" + # - "failToPushOrderToMerchant" + # - "failToPushOrderToMerchantOutOfStock" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "merchantDidNotShipOnTime" + # - "noInventory" + # - "orderTimeout" + # - "other" + # - "paymentAbuse" + # - "paymentDeclined" + # - "priceError" + # - "returnRefundAbuse" + # - "shippingPriceError" + # - "taxError" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -3864,6 +4261,9 @@ module Google # customer selected granted in their most recent order, they can be subscribed # to marketing emails. Customers who have chosen denied must not be subscribed, # or must be unsubscribed if already opted-in. + # Acceptable values are: + # - "denied" + # - "granted" # Corresponds to the JSON property `explicitMarketingPreference` # @return [String] attr_accessor :explicit_marketing_preference @@ -4058,6 +4458,8 @@ module Google attr_accessor :tax_adjustment # Type of this adjustment. + # Acceptable values are: + # - "promotion" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -4084,6 +4486,10 @@ module Google attr_accessor :brand # Condition or state of the item. + # Acceptable values are: + # - "new" + # - "refurbished" + # - "used" # Corresponds to the JSON property `condition` # @return [String] attr_accessor :condition @@ -4233,18 +4639,18 @@ module Google class OrderLineItemReturnInfo include Google::Apis::Core::Hashable - # How many days later the item can be returned. + # Required. How many days later the item can be returned. # Corresponds to the JSON property `daysToReturn` # @return [Fixnum] attr_accessor :days_to_return - # Whether the item is returnable. + # Required. Whether the item is returnable. # Corresponds to the JSON property `isReturnable` # @return [Boolean] attr_accessor :is_returnable alias_method :is_returnable?, :is_returnable - # URL of the item return policy. + # Required. URL of the item return policy. # Corresponds to the JSON property `policyUrl` # @return [String] attr_accessor :policy_url @@ -4265,23 +4671,26 @@ module Google class OrderLineItemShippingDetails include Google::Apis::Core::Hashable - # The delivery by date, in ISO 8601 format. + # Required. The delivery by date, in ISO 8601 format. # Corresponds to the JSON property `deliverByDate` # @return [String] attr_accessor :deliver_by_date - # Details of the shipping method. + # Required. Details of the shipping method. # Corresponds to the JSON property `method` # @return [Google::Apis::ContentV2_1::OrderLineItemShippingDetailsMethod] attr_accessor :method_prop - # The ship by date, in ISO 8601 format. + # Required. The ship by date, in ISO 8601 format. # Corresponds to the JSON property `shipByDate` # @return [String] attr_accessor :ship_by_date # Type of shipment. Indicates whether deliveryDetails or pickupDetails is # applicable for this shipment. + # Acceptable values are: + # - "delivery" + # - "pickup" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -4309,17 +4718,17 @@ module Google # @return [String] attr_accessor :carrier - # Maximum transit time. + # Required. Maximum transit time. # Corresponds to the JSON property `maxDaysInTransit` # @return [Fixnum] attr_accessor :max_days_in_transit - # The name of the shipping method. + # Required. The name of the shipping method. # Corresponds to the JSON property `methodName` # @return [String] attr_accessor :method_name - # Minimum transit time. + # Required. Minimum transit time. # Corresponds to the JSON property `minDaysInTransit` # @return [Fixnum] attr_accessor :min_days_in_transit @@ -4444,13 +4853,17 @@ module Google # @return [String] attr_accessor :end_time - # The party funding the promotion. Only merchant is supported for orders. - # createtestorder. + # Required. The party funding the promotion. Only merchant is supported for + # orders.createtestorder. + # Acceptable values are: + # - "google" + # - "merchant" # Corresponds to the JSON property `funder` # @return [String] attr_accessor :funder - # This field is used to identify promotions within merchants' own systems. + # Required. This field is used to identify promotions within merchants' own + # systems. # Corresponds to the JSON property `merchantPromotionId` # @return [String] attr_accessor :merchant_promotion_id @@ -4473,8 +4886,23 @@ module Google # @return [String] attr_accessor :start_time - # The category of the promotion. Only moneyOff is supported for orders. + # Required. The category of the promotion. Only moneyOff is supported for orders. # createtestorder. + # Acceptable values are: + # - "buyMGetMoneyOff" + # - "buyMGetNMoneyOff" + # - "buyMGetNPercentOff" + # - "buyMGetPercentOff" + # - "freeGift" + # - "freeGiftWithItemId" + # - "freeGiftWithValue" + # - "freeShippingOvernight" + # - "freeShippingStandard" + # - "freeShippingTwoDay" + # - "moneyOff" + # - "percentOff" + # - "rewardPoints" + # - "salePrice" # Corresponds to the JSON property `subtype` # @return [String] attr_accessor :subtype @@ -4485,13 +4913,16 @@ module Google # @return [Google::Apis::ContentV2_1::Price] attr_accessor :tax_value - # The title of the promotion. + # Required. The title of the promotion. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title - # The scope of the promotion. Only product is supported for orders. + # Required. The scope of the promotion. Only product is supported for orders. # createtestorder. + # Acceptable values are: + # - "product" + # - "shipping" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -4526,7 +4957,7 @@ module Google # @return [String] attr_accessor :line_item_id - # Offer ID of a product. Only for orders.createtestorder. + # Required. Offer ID of a product. Only for orders.createtestorder. # Corresponds to the JSON property `offerId` # @return [String] attr_accessor :offer_id @@ -4560,6 +4991,13 @@ module Google include Google::Apis::Core::Hashable # The actor that created the refund. + # Acceptable values are: + # - "customer" + # - "googleBot" + # - "googleCustomerService" + # - "googlePayments" + # - "googleSabre" + # - "merchant" # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor @@ -4575,6 +5013,51 @@ module Google attr_accessor :creation_date # The reason for the refund. + # Acceptable values are: + # - "adjustment" + # - "autoPostInternal" + # - "autoPostInvalidBillingAddress" + # - "autoPostNoInventory" + # - "autoPostPriceError" + # - "autoPostUndeliverableShippingAddress" + # - "couponAbuse" + # - "courtesyAdjustment" + # - "customerCanceled" + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "customerSupportRequested" + # - "deliveredLateByCarrier" + # - "deliveredTooLate" + # - "expiredItem" + # - "failToPushOrderGoogleError" + # - "failToPushOrderMerchantError" + # - "failToPushOrderMerchantFulfillmentError" + # - "failToPushOrderToMerchant" + # - "failToPushOrderToMerchantOutOfStock" + # - "feeAdjustment" + # - "invalidCoupon" + # - "lateShipmentCredit" + # - "malformedShippingAddress" + # - "merchantDidNotShipOnTime" + # - "noInventory" + # - "orderTimeout" + # - "other" + # - "paymentAbuse" + # - "paymentDeclined" + # - "priceAdjustment" + # - "priceError" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "promoReallocation" + # - "qualityNotAsExpected" + # - "returnRefundAbuse" + # - "shippingCostAdjustment" + # - "shippingPriceError" + # - "taxAdjustment" + # - "taxError" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -4713,6 +5196,13 @@ module Google include Google::Apis::Core::Hashable # The actor that created the refund. + # Acceptable values are: + # - "customer" + # - "googleBot" + # - "googleCustomerService" + # - "googlePayments" + # - "googleSabre" + # - "merchant" # Corresponds to the JSON property `actor` # @return [String] attr_accessor :actor @@ -4728,6 +5218,20 @@ module Google attr_accessor :quantity # The reason for the return. + # Acceptable values are: + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "deliveredTooLate" + # - "expiredItem" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "other" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "qualityNotAsExpected" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -4830,6 +5334,11 @@ module Google attr_accessor :shipment_group_id # The status of the shipment. + # Acceptable values are: + # - "delivered" + # - "readyForPickup" + # - "shipped" + # - "undeliverable" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -4940,6 +5449,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5012,6 +5524,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5043,6 +5558,51 @@ module Google attr_accessor :description # [required] Reason for the refund. + # Acceptable values are: + # - "adjustment" + # - "autoPostInternal" + # - "autoPostInvalidBillingAddress" + # - "autoPostNoInventory" + # - "autoPostPriceError" + # - "autoPostUndeliverableShippingAddress" + # - "couponAbuse" + # - "courtesyAdjustment" + # - "customerCanceled" + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "customerSupportRequested" + # - "deliveredLateByCarrier" + # - "deliveredTooLate" + # - "expiredItem" + # - "failToPushOrderGoogleError" + # - "failToPushOrderMerchantError" + # - "failToPushOrderMerchantFulfillmentError" + # - "failToPushOrderToMerchant" + # - "failToPushOrderToMerchantOutOfStock" + # - "feeAdjustment" + # - "invalidCoupon" + # - "lateShipmentCredit" + # - "malformedShippingAddress" + # - "merchantDidNotShipOnTime" + # - "noInventory" + # - "orderTimeout" + # - "other" + # - "paymentAbuse" + # - "paymentDeclined" + # - "priceAdjustment" + # - "priceError" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "promoReallocation" + # - "qualityNotAsExpected" + # - "returnRefundAbuse" + # - "shippingCostAdjustment" + # - "shippingPriceError" + # - "taxAdjustment" + # - "taxError" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5068,6 +5628,20 @@ module Google attr_accessor :description # [required] Reason for the return. + # Acceptable values are: + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "deliveredTooLate" + # - "expiredItem" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "other" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "qualityNotAsExpected" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5203,6 +5777,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5270,6 +5847,17 @@ module Google attr_accessor :quantity # The reason for the cancellation. + # Acceptable values are: + # - "customerInitiatedCancel" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "noInventory" + # - "other" + # - "priceError" + # - "shippingPriceError" + # - "taxError" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5299,6 +5887,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5330,6 +5921,17 @@ module Google attr_accessor :operation_id # The reason for the cancellation. + # Acceptable values are: + # - "customerInitiatedCancel" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "noInventory" + # - "other" + # - "priceError" + # - "shippingPriceError" + # - "taxError" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5356,6 +5958,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5382,6 +5987,10 @@ module Google include Google::Apis::Core::Hashable # The reason for the cancellation. + # Acceptable values are: + # - "changedMind" + # - "orderedWrongItem" + # - "other" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5433,6 +6042,12 @@ module Google # The test order template to use. Specify as an alternative to testOrder as a # shortcut for retrieving a template and then creating an order using that # template. + # Acceptable values are: + # - "template1" + # - "template1a" + # - "template1b" + # - "template2" + # - "template3" # Corresponds to the JSON property `templateName` # @return [String] attr_accessor :template_name @@ -5560,8 +6175,8 @@ module Google # @return [String] attr_accessor :carrier - # The ID of the shipment. This is assigned by the merchant and is unique to each - # shipment. + # Required. The ID of the shipment. This is assigned by the merchant and is + # unique to each shipment. # Corresponds to the JSON property `shipmentId` # @return [String] attr_accessor :shipment_id @@ -5668,6 +6283,20 @@ module Google attr_accessor :quantity # The reason for the return. + # Acceptable values are: + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "deliveredTooLate" + # - "expiredItem" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "other" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "qualityNotAsExpected" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5704,6 +6333,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5783,6 +6415,12 @@ module Google attr_accessor :quantity # The reason for the return. + # Acceptable values are: + # - "damagedOrUsed" + # - "missingComponent" + # - "notEligible" + # - "other" + # - "outOfReturnWindow" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5812,6 +6450,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5865,6 +6506,20 @@ module Google attr_accessor :quantity # The reason for the return. + # Acceptable values are: + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "deliveredTooLate" + # - "expiredItem" + # - "invalidCoupon" + # - "malformedShippingAddress" + # - "other" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "qualityNotAsExpected" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -5902,6 +6557,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -5967,6 +6625,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -6032,6 +6693,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -6109,6 +6773,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -6160,6 +6827,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -6208,6 +6878,9 @@ module Google attr_accessor :shipment_id # New status for the shipment. Not updated if missing. + # Acceptable values are: + # - "delivered" + # - "undeliverable" # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -6237,6 +6910,9 @@ module Google include Google::Apis::Core::Hashable # The status of the execution. + # Acceptable values are: + # - "duplicate" + # - "executed" # Corresponds to the JSON property `executionStatus` # @return [String] attr_accessor :execution_status @@ -6352,7 +7028,13 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # The method of the batch entry. + # Acceptable values are: + # - "delete" + # - "get" + # - "insert" + # - "inventory" + # - "sale" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -6530,7 +7212,7 @@ module Google class PosInventory include Google::Apis::Core::Hashable - # The two-letter ISO 639-1 language code for the item. + # Required. The two-letter ISO 639-1 language code for the item. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -6540,7 +7222,7 @@ module Google # @return [String] attr_accessor :gtin - # A unique identifier for the item. + # Required. A unique identifier for the item. # Corresponds to the JSON property `itemId` # @return [String] attr_accessor :item_id @@ -6551,28 +7233,28 @@ module Google # @return [String] attr_accessor :kind - # The current price of the item. + # Required. The current price of the item. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2_1::Price] attr_accessor :price - # The available quantity of the item. + # Required. The available quantity of the item. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity - # The identifier of the merchant's store. Either a storeCode inserted via the - # API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a storeCode inserted + # via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code - # The CLDR territory code for the item. + # Required. The CLDR territory code for the item. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country - # The inventory timestamp, in ISO 8601 format. + # Required. The inventory timestamp, in ISO 8601 format. # Corresponds to the JSON property `timestamp` # @return [String] attr_accessor :timestamp @@ -6599,7 +7281,7 @@ module Google class PosInventoryRequest include Google::Apis::Core::Hashable - # The two-letter ISO 639-1 language code for the item. + # Required. The two-letter ISO 639-1 language code for the item. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -6609,33 +7291,33 @@ module Google # @return [String] attr_accessor :gtin - # A unique identifier for the item. + # Required. A unique identifier for the item. # Corresponds to the JSON property `itemId` # @return [String] attr_accessor :item_id - # The current price of the item. + # Required. The current price of the item. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2_1::Price] attr_accessor :price - # The available quantity of the item. + # Required. The available quantity of the item. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity - # The identifier of the merchant's store. Either a storeCode inserted via the - # API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a storeCode inserted + # via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code - # The CLDR territory code for the item. + # Required. The CLDR territory code for the item. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country - # The inventory timestamp, in ISO 8601 format. + # Required. The inventory timestamp, in ISO 8601 format. # Corresponds to the JSON property `timestamp` # @return [String] attr_accessor :timestamp @@ -6661,7 +7343,7 @@ module Google class PosInventoryResponse include Google::Apis::Core::Hashable - # The two-letter ISO 639-1 language code for the item. + # Required. The two-letter ISO 639-1 language code for the item. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -6671,7 +7353,7 @@ module Google # @return [String] attr_accessor :gtin - # A unique identifier for the item. + # Required. A unique identifier for the item. # Corresponds to the JSON property `itemId` # @return [String] attr_accessor :item_id @@ -6682,28 +7364,28 @@ module Google # @return [String] attr_accessor :kind - # The current price of the item. + # Required. The current price of the item. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2_1::Price] attr_accessor :price - # The available quantity of the item. + # Required. The available quantity of the item. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity - # The identifier of the merchant's store. Either a storeCode inserted via the - # API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a storeCode inserted + # via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code - # The CLDR territory code for the item. + # Required. The CLDR territory code for the item. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country - # The inventory timestamp, in ISO 8601 format. + # Required. The inventory timestamp, in ISO 8601 format. # Corresponds to the JSON property `timestamp` # @return [String] attr_accessor :timestamp @@ -6756,7 +7438,7 @@ module Google class PosSale include Google::Apis::Core::Hashable - # The two-letter ISO 639-1 language code for the item. + # Required. The two-letter ISO 639-1 language code for the item. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -6766,7 +7448,7 @@ module Google # @return [String] attr_accessor :gtin - # A unique identifier for the item. + # Required. A unique identifier for the item. # Corresponds to the JSON property `itemId` # @return [String] attr_accessor :item_id @@ -6777,12 +7459,13 @@ module Google # @return [String] attr_accessor :kind - # The price of the item. + # Required. The price of the item. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2_1::Price] attr_accessor :price - # The relative change of the available quantity. Negative for items returned. + # Required. The relative change of the available quantity. Negative for items + # returned. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity @@ -6792,18 +7475,18 @@ module Google # @return [String] attr_accessor :sale_id - # The identifier of the merchant's store. Either a storeCode inserted via the - # API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a storeCode inserted + # via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code - # The CLDR territory code for the item. + # Required. The CLDR territory code for the item. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country - # The inventory timestamp, in ISO 8601 format. + # Required. The inventory timestamp, in ISO 8601 format. # Corresponds to the JSON property `timestamp` # @return [String] attr_accessor :timestamp @@ -6831,7 +7514,7 @@ module Google class PosSaleRequest include Google::Apis::Core::Hashable - # The two-letter ISO 639-1 language code for the item. + # Required. The two-letter ISO 639-1 language code for the item. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -6841,17 +7524,18 @@ module Google # @return [String] attr_accessor :gtin - # A unique identifier for the item. + # Required. A unique identifier for the item. # Corresponds to the JSON property `itemId` # @return [String] attr_accessor :item_id - # The price of the item. + # Required. The price of the item. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2_1::Price] attr_accessor :price - # The relative change of the available quantity. Negative for items returned. + # Required. The relative change of the available quantity. Negative for items + # returned. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity @@ -6861,18 +7545,18 @@ module Google # @return [String] attr_accessor :sale_id - # The identifier of the merchant's store. Either a storeCode inserted via the - # API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a storeCode inserted + # via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code - # The CLDR territory code for the item. + # Required. The CLDR territory code for the item. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country - # The inventory timestamp, in ISO 8601 format. + # Required. The inventory timestamp, in ISO 8601 format. # Corresponds to the JSON property `timestamp` # @return [String] attr_accessor :timestamp @@ -6899,7 +7583,7 @@ module Google class PosSaleResponse include Google::Apis::Core::Hashable - # The two-letter ISO 639-1 language code for the item. + # Required. The two-letter ISO 639-1 language code for the item. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -6909,7 +7593,7 @@ module Google # @return [String] attr_accessor :gtin - # A unique identifier for the item. + # Required. A unique identifier for the item. # Corresponds to the JSON property `itemId` # @return [String] attr_accessor :item_id @@ -6920,12 +7604,13 @@ module Google # @return [String] attr_accessor :kind - # The price of the item. + # Required. The price of the item. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2_1::Price] attr_accessor :price - # The relative change of the available quantity. Negative for items returned. + # Required. The relative change of the available quantity. Negative for items + # returned. # Corresponds to the JSON property `quantity` # @return [Fixnum] attr_accessor :quantity @@ -6935,18 +7620,18 @@ module Google # @return [String] attr_accessor :sale_id - # The identifier of the merchant's store. Either a storeCode inserted via the - # API or the code of the store in Google My Business. + # Required. The identifier of the merchant's store. Either a storeCode inserted + # via the API or the code of the store in Google My Business. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code - # The CLDR territory code for the item. + # Required. The CLDR territory code for the item. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country - # The inventory timestamp, in ISO 8601 format. + # Required. The inventory timestamp, in ISO 8601 format. # Corresponds to the JSON property `timestamp` # @return [String] attr_accessor :timestamp @@ -6980,12 +7665,12 @@ module Google # @return [String] attr_accessor :kind - # The street address of the store. + # Required. The street address of the store. # Corresponds to the JSON property `storeAddress` # @return [String] attr_accessor :store_address - # A store identifier that is unique for the given merchant. + # Required. A store identifier that is unique for the given merchant. # Corresponds to the JSON property `storeCode` # @return [String] attr_accessor :store_code @@ -7145,7 +7830,10 @@ module Google # @return [String] attr_accessor :brand - # The item's channel (online or local). + # Required. The item's channel (online or local). + # Acceptable values are: + # - "local" + # - "online" # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel @@ -7160,7 +7848,7 @@ module Google # @return [String] attr_accessor :condition - # The two-letter ISO 639-1 language code for the item. + # Required. The two-letter ISO 639-1 language code for the item. # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -7369,8 +8057,8 @@ module Google # @return [Fixnum] attr_accessor :multipack - # A unique identifier for the item. Leading and trailing whitespaces are - # stripped and multiple whitespaces are replaced by a single whitespace upon + # Required. A unique identifier for the item. Leading and trailing whitespaces + # are stripped and multiple whitespaces are replaced by a single whitespace upon # submission. Only valid unicode characters are accepted. See the products feed # specification for details. # Note: Content API methods that operate on products take the REST ID of the @@ -7464,11 +8152,15 @@ module Google attr_accessor :sizes # The source of the offer, i.e., how the offer was created. + # Acceptable values are: + # - "api" + # - "crawl" + # - "feed" # Corresponds to the JSON property `source` # @return [String] attr_accessor :source - # The CLDR territory code for the item. + # Required. The CLDR territory code for the item. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country @@ -8025,7 +8717,11 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # The method of the batch entry. + # Acceptable values are: + # - "delete" + # - "get" + # - "insert" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -8199,7 +8895,9 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # The method of the batch entry. + # Acceptable values are: + # - "get" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -8421,6 +9119,51 @@ module Google attr_accessor :description # Code of the refund reason. + # Acceptable values are: + # - "adjustment" + # - "autoPostInternal" + # - "autoPostInvalidBillingAddress" + # - "autoPostNoInventory" + # - "autoPostPriceError" + # - "autoPostUndeliverableShippingAddress" + # - "couponAbuse" + # - "courtesyAdjustment" + # - "customerCanceled" + # - "customerDiscretionaryReturn" + # - "customerInitiatedMerchantCancel" + # - "customerSupportRequested" + # - "deliveredLateByCarrier" + # - "deliveredTooLate" + # - "expiredItem" + # - "failToPushOrderGoogleError" + # - "failToPushOrderMerchantError" + # - "failToPushOrderMerchantFulfillmentError" + # - "failToPushOrderToMerchant" + # - "failToPushOrderToMerchantOutOfStock" + # - "feeAdjustment" + # - "invalidCoupon" + # - "lateShipmentCredit" + # - "malformedShippingAddress" + # - "merchantDidNotShipOnTime" + # - "noInventory" + # - "orderTimeout" + # - "other" + # - "paymentAbuse" + # - "paymentDeclined" + # - "priceAdjustment" + # - "priceError" + # - "productArrivedDamaged" + # - "productNotAsDescribed" + # - "promoReallocation" + # - "qualityNotAsExpected" + # - "returnRefundAbuse" + # - "shippingCostAdjustment" + # - "shippingPriceError" + # - "taxAdjustment" + # - "taxError" + # - "undeliverableShippingAddress" + # - "unsupportedPoBoxAddress" + # - "wrongProductShipped" # Corresponds to the JSON property `reasonCode` # @return [String] attr_accessor :reason_code @@ -8529,7 +9272,9 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # Method of the batch request entry. + # Acceptable values are: + # - "insert" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -8628,12 +9373,12 @@ module Google class ReturnAddress include Google::Apis::Core::Hashable - # The address. + # Required. The address. # Corresponds to the JSON property `address` # @return [Google::Apis::ContentV2_1::ReturnAddressAddress] attr_accessor :address - # The country of sale where the return address is applicable. + # Required. The country of sale where the return address is applicable. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country @@ -8644,13 +9389,13 @@ module Google # @return [String] attr_accessor :kind - # The user-defined label of the return address. For the default address, use the - # label "default". + # Required. The user-defined label of the return address. For the default + # address, use the label "default". # Corresponds to the JSON property `label` # @return [String] attr_accessor :label - # The merchant's contact phone number regarding the return. + # Required. The merchant's contact phone number regarding the return. # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number @@ -8731,7 +9476,7 @@ module Google class ReturnPolicy include Google::Apis::Core::Hashable - # The country of sale where the return policy is applicable. + # Required. The country of sale where the return policy is applicable. # Corresponds to the JSON property `country` # @return [String] attr_accessor :country @@ -8742,13 +9487,13 @@ module Google # @return [String] attr_accessor :kind - # The user-defined label of the return policy. For the default policy, use the - # label "default". + # Required. The user-defined label of the return policy. For the default policy, + # use the label "default". # Corresponds to the JSON property `label` # @return [String] attr_accessor :label - # The name of the policy as shown in Merchant Center. + # Required. The name of the policy as shown in Merchant Center. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -8758,7 +9503,7 @@ module Google # @return [Array] attr_accessor :non_free_return_reasons - # The policy. + # Required. The policy. # Corresponds to the JSON property `policy` # @return [Google::Apis::ContentV2_1::ReturnPolicyPolicy] attr_accessor :policy @@ -8794,9 +9539,9 @@ module Google class ReturnPolicyPolicy include Google::Apis::Core::Hashable - # Last day for returning the items. In ISO 8601 format. When specifying the - # return window like this, set the policy type to "lastReturnDate". Use this for - # seasonal overrides only. + # Required. Last day for returning the items. In ISO 8601 format. When + # specifying the return window like this, set the policy type to "lastReturnDate" + # . Use this for seasonal overrides only. # Corresponds to the JSON property `lastReturnDate` # @return [String] attr_accessor :last_return_date @@ -8818,6 +9563,11 @@ module Google # made for electronics or non-returnable items such as food, perishables, and # living things. A policy of less than 30 days can only be applied to those # items. + # Acceptable values are: + # - "lastReturnDate" + # - "lifetimeReturns" + # - "noReturns" + # - "numberOfDaysAfterDelivery" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -8838,22 +9588,22 @@ module Google class ReturnPolicySeasonalOverride include Google::Apis::Core::Hashable - # Last day on which the override applies. In ISO 8601 format. + # Required. Last day on which the override applies. In ISO 8601 format. # Corresponds to the JSON property `endDate` # @return [String] attr_accessor :end_date - # The name of the seasonal override as shown in Merchant Center. + # Required. The name of the seasonal override as shown in Merchant Center. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The policy which is in effect during that time. + # Required. The policy which is in effect during that time. # Corresponds to the JSON property `policy` # @return [Google::Apis::ContentV2_1::ReturnPolicyPolicy] attr_accessor :policy - # First day on which the override applies. In ISO 8601 format. + # Required. First day on which the override applies. In ISO 8601 format. # Corresponds to the JSON property `startDate` # @return [String] attr_accessor :start_date @@ -8886,6 +9636,10 @@ module Google attr_accessor :delivery_date # Type of the return method. + # Acceptable values are: + # - "byMail" + # - "contactCustomerSupport" + # - "returnless" # Corresponds to the JSON property `returnMethodType` # @return [String] attr_accessor :return_method_type @@ -8907,6 +9661,11 @@ module Google attr_accessor :shipping_date # State of the shipment. + # Acceptable values are: + # - "completed" + # - "new" + # - "shipped" + # - "undeliverable" # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -8960,7 +9719,11 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # Method of the batch request entry. + # Acceptable values are: + # - "delete" + # - "get" + # - "insert" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -9118,7 +9881,11 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # Method of the batch request entry. + # Acceptable values are: + # - "delete" + # - "get" + # - "insert" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -9286,6 +10053,10 @@ module Google attr_accessor :delivery_time # Eligibility for this service. + # Acceptable values are: + # - "All scenarios" + # - "All scenarios except Shopping Actions" + # - "Shopping Actions" # Corresponds to the JSON property `eligibility` # @return [String] attr_accessor :eligibility @@ -9317,6 +10088,9 @@ module Google attr_accessor :rate_groups # Type of locations this service ships orders to. + # Acceptable values are: + # - "delivery" + # - "pickup" # Corresponds to the JSON property `shipmentType` # @return [String] attr_accessor :shipment_type @@ -9419,6 +10193,37 @@ module Google include Google::Apis::Core::Hashable # The shipping carrier that handles the package. + # Acceptable values are: + # - "boxtal" + # - "bpost" + # - "chronopost" + # - "colisPrive" + # - "colissimo" + # - "cxt" + # - "deliv" + # - "dhl" + # - "dpd" + # - "dynamex" + # - "eCourier" + # - "easypost" + # - "efw" + # - "fedex" + # - "fedexSmartpost" + # - "geodis" + # - "gls" + # - "googleCourier" + # - "gsx" + # - "jdLogistics" + # - "laPoste" + # - "lasership" + # - "manual" + # - "mpx" + # - "onTrac" + # - "other" + # - "tnt" + # - "uds" + # - "ups" + # - "usps" # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier @@ -9510,7 +10315,10 @@ module Google # @return [Fixnum] attr_accessor :merchant_id - # + # The method of the batch entry. + # Acceptable values are: + # - "get" + # - "update" # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop @@ -9766,34 +10574,54 @@ module Google # @return [String] attr_accessor :kind - # Line items that are ordered. At least one line item must be provided. + # Required. Line items that are ordered. At least one line item must be provided. # Corresponds to the JSON property `lineItems` # @return [Array] attr_accessor :line_items # Determines if test order must be pulled by merchant or pushed to merchant via # push integration. + # Acceptable values are: + # - "checkoutIntegration" + # - "merchantPull" # Corresponds to the JSON property `notificationMode` # @return [String] attr_accessor :notification_mode - # The billing address. + # Required. The billing address. + # Acceptable values are: + # - "dwight" + # - "jim" + # - "pam" # Corresponds to the JSON property `predefinedBillingAddress` # @return [String] attr_accessor :predefined_billing_address - # Identifier of one of the predefined delivery addresses for the delivery. + # Required. Identifier of one of the predefined delivery addresses for the + # delivery. + # Acceptable values are: + # - "dwight" + # - "jim" + # - "pam" # Corresponds to the JSON property `predefinedDeliveryAddress` # @return [String] attr_accessor :predefined_delivery_address - # Email address of the customer. + # Required. Email address of the customer. + # Acceptable values are: + # - "pog.dwight.schrute@gmail.com" + # - "pog.jim.halpert@gmail.com" + # - "penpog.pam.beesly@gmail.comding" # Corresponds to the JSON property `predefinedEmail` # @return [String] attr_accessor :predefined_email # Identifier of one of the predefined pickup details. Required for orders # containing line items with shipping type pickup. + # Acceptable values are: + # - "dwight" + # - "jim" + # - "pam" # Corresponds to the JSON property `predefinedPickupDetails` # @return [String] attr_accessor :predefined_pickup_details @@ -9803,15 +10631,22 @@ module Google # @return [Array] attr_accessor :promotions - # The price of shipping for all items. Shipping tax is automatically calculated - # for orders where marketplace facilitator tax laws are applicable. Otherwise, - # tax settings from Merchant Center are applied. Note that shipping is not taxed - # in certain states. + # Required. The price of shipping for all items. Shipping tax is automatically + # calculated for orders where marketplace facilitator tax laws are applicable. + # Otherwise, tax settings from Merchant Center are applied. Note that shipping + # is not taxed in certain states. # Corresponds to the JSON property `shippingCost` # @return [Google::Apis::ContentV2_1::Price] attr_accessor :shipping_cost - # The requested shipping option. + # Required. The requested shipping option. + # Acceptable values are: + # - "economy" + # - "expedited" + # - "oneDay" + # - "sameDay" + # - "standard" + # - "twoDay" # Corresponds to the JSON property `shippingOption` # @return [String] attr_accessor :shipping_option @@ -9840,22 +10675,22 @@ module Google class TestOrderLineItem include Google::Apis::Core::Hashable - # Product data from the time of the order placement. + # Required. Product data from the time of the order placement. # Corresponds to the JSON property `product` # @return [Google::Apis::ContentV2_1::TestOrderLineItemProduct] attr_accessor :product - # Number of items ordered. + # Required. Number of items ordered. # Corresponds to the JSON property `quantityOrdered` # @return [Fixnum] attr_accessor :quantity_ordered - # Details of the return policy for the line item. + # Required. Details of the return policy for the line item. # Corresponds to the JSON property `returnInfo` # @return [Google::Apis::ContentV2_1::OrderLineItemReturnInfo] attr_accessor :return_info - # Details of the requested shipping for the line item. + # Required. Details of the requested shipping for the line item. # Corresponds to the JSON property `shippingDetails` # @return [Google::Apis::ContentV2_1::OrderLineItemShippingDetails] attr_accessor :shipping_details @@ -9877,17 +10712,22 @@ module Google class TestOrderLineItemProduct include Google::Apis::Core::Hashable - # Brand of the item. + # Required. Brand of the item. # Corresponds to the JSON property `brand` # @return [String] attr_accessor :brand - # Condition or state of the item. + # Required. Condition or state of the item. + # Acceptable values are: + # - "new" # Corresponds to the JSON property `condition` # @return [String] attr_accessor :condition - # The two-letter ISO 639-1 language code for the item. + # Required. The two-letter ISO 639-1 language code for the item. + # Acceptable values are: + # - "en" + # - "fr" # Corresponds to the JSON property `contentLanguage` # @return [String] attr_accessor :content_language @@ -9902,7 +10742,7 @@ module Google # @return [String] attr_accessor :gtin - # URL of an image of the item. + # Required. URL of an image of the item. # Corresponds to the JSON property `imageLink` # @return [String] attr_accessor :image_link @@ -9917,24 +10757,24 @@ module Google # @return [String] attr_accessor :mpn - # An identifier of the item. + # Required. An identifier of the item. # Corresponds to the JSON property `offerId` # @return [String] attr_accessor :offer_id - # The price for the product. Tax is automatically calculated for orders where - # marketplace facilitator tax laws are applicable. Otherwise, tax settings from - # Merchant Center are applied. + # Required. The price for the product. Tax is automatically calculated for + # orders where marketplace facilitator tax laws are applicable. Otherwise, tax + # settings from Merchant Center are applied. # Corresponds to the JSON property `price` # @return [Google::Apis::ContentV2_1::Price] attr_accessor :price - # The CLDR territory code of the target country of the product. + # Required. The CLDR territory code of the target country of the product. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country - # The title of the product. + # Required. The title of the product. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -10087,6 +10927,8 @@ module Google attr_accessor :additional_charge_amount # [required] Type of the additional charge. + # Acceptable values are: + # - "shipping" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -10118,6 +10960,10 @@ module Google attr_accessor :tax_name # [required] Type of the tax. + # Acceptable values are: + # - "otherFee" + # - "otherFeeTax" + # - "sales" # Corresponds to the JSON property `taxType` # @return [String] attr_accessor :tax_type @@ -10188,12 +11034,15 @@ module Google class Weight include Google::Apis::Core::Hashable - # The weight unit. + # Required. The weight unit. + # Acceptable values are: + # - "kg" + # - "lb" # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit - # The weight represented as a number. + # Required. The weight represented as a number. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value diff --git a/generated/google/apis/content_v2_1/representations.rb b/generated/google/apis/content_v2_1/representations.rb index 346c5f085..aa4f55d54 100644 --- a/generated/google/apis/content_v2_1/representations.rb +++ b/generated/google/apis/content_v2_1/representations.rb @@ -574,6 +574,36 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class LocalInventory + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LocalinventoryCustomBatchRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LocalinventoryCustomBatchRequestEntry + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LocalinventoryCustomBatchResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LocalinventoryCustomBatchResponseEntry + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class LocationIdSet class Representation < Google::Apis::Core::JsonRepresentation; end @@ -2512,6 +2542,63 @@ module Google end end + class LocalInventory + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :availability, as: 'availability' + property :instore_product_location, as: 'instoreProductLocation' + property :kind, as: 'kind' + property :pickup_method, as: 'pickupMethod' + property :pickup_sla, as: 'pickupSla' + property :price, as: 'price', class: Google::Apis::ContentV2_1::Price, decorator: Google::Apis::ContentV2_1::Price::Representation + + property :quantity, as: 'quantity' + property :sale_price, as: 'salePrice', class: Google::Apis::ContentV2_1::Price, decorator: Google::Apis::ContentV2_1::Price::Representation + + property :sale_price_effective_date, as: 'salePriceEffectiveDate' + property :store_code, as: 'storeCode' + end + end + + class LocalinventoryCustomBatchRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :entries, as: 'entries', class: Google::Apis::ContentV2_1::LocalinventoryCustomBatchRequestEntry, decorator: Google::Apis::ContentV2_1::LocalinventoryCustomBatchRequestEntry::Representation + + end + end + + class LocalinventoryCustomBatchRequestEntry + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :batch_id, as: 'batchId' + property :local_inventory, as: 'localInventory', class: Google::Apis::ContentV2_1::LocalInventory, decorator: Google::Apis::ContentV2_1::LocalInventory::Representation + + property :merchant_id, :numeric_string => true, as: 'merchantId' + property :method_prop, as: 'method' + property :product_id, as: 'productId' + end + end + + class LocalinventoryCustomBatchResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :entries, as: 'entries', class: Google::Apis::ContentV2_1::LocalinventoryCustomBatchResponseEntry, decorator: Google::Apis::ContentV2_1::LocalinventoryCustomBatchResponseEntry::Representation + + property :kind, as: 'kind' + end + end + + class LocalinventoryCustomBatchResponseEntry + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :batch_id, as: 'batchId' + property :errors, as: 'errors', class: Google::Apis::ContentV2_1::Errors, decorator: Google::Apis::ContentV2_1::Errors::Representation + + property :kind, as: 'kind' + end + end + class LocationIdSet # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/content_v2_1/service.rb b/generated/google/apis/content_v2_1/service.rb index 419f668e4..72a166d96 100644 --- a/generated/google/apis/content_v2_1/service.rb +++ b/generated/google/apis/content_v2_1/service.rb @@ -1494,6 +1494,79 @@ module Google execute_or_queue_command(command, &block) end + # Updates local inventory for multiple products or stores in a single request. + # @param [Google::Apis::ContentV2_1::LocalinventoryCustomBatchRequest] localinventory_custom_batch_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContentV2_1::LocalinventoryCustomBatchResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContentV2_1::LocalinventoryCustomBatchResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def custombatch_localinventory(localinventory_custom_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'localinventory/batch', options) + command.request_representation = Google::Apis::ContentV2_1::LocalinventoryCustomBatchRequest::Representation + command.request_object = localinventory_custom_batch_request_object + command.response_representation = Google::Apis::ContentV2_1::LocalinventoryCustomBatchResponse::Representation + command.response_class = Google::Apis::ContentV2_1::LocalinventoryCustomBatchResponse + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Update the local inventory of a product in your Merchant Center account. + # @param [Fixnum] merchant_id + # The ID of the account that contains the product. This account cannot be a + # multi-client account. + # @param [String] product_id + # The REST ID of the product for which to update local inventory. + # @param [Google::Apis::ContentV2_1::LocalInventory] local_inventory_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # An opaque string that represents a user for quota purposes. Must not exceed 40 + # characters. + # @param [String] user_ip + # Deprecated. Please use quotaUser instead. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContentV2_1::LocalInventory] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContentV2_1::LocalInventory] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_localinventory(merchant_id, product_id, local_inventory_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{merchantId}/products/{productId}/localinventory', options) + command.request_representation = Google::Apis::ContentV2_1::LocalInventory::Representation + command.request_object = local_inventory_object + command.response_representation = Google::Apis::ContentV2_1::LocalInventory::Representation + command.response_class = Google::Apis::ContentV2_1::LocalInventory + command.params['merchantId'] = merchant_id unless merchant_id.nil? + command.params['productId'] = product_id unless product_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Creates a charge invoice for a shipment group, and triggers a charge capture # for orderinvoice enabled orders. # @param [Fixnum] merchant_id diff --git a/generated/google/apis/customsearch_v1.rb b/generated/google/apis/customsearch_v1.rb index 7d80b427b..7c624b7ea 100644 --- a/generated/google/apis/customsearch_v1.rb +++ b/generated/google/apis/customsearch_v1.rb @@ -18,14 +18,14 @@ require 'google/apis/customsearch_v1/representations.rb' module Google module Apis - # CustomSearch API + # Custom Search API # # Searches over a website or collection of websites # - # @see https://developers.google.com/custom-search/v1/using_rest + # @see https://developers.google.com/custom-search/v1/introduction module CustomsearchV1 VERSION = 'V1' - REVISION = '20181001' + REVISION = '20200408' end end end diff --git a/generated/google/apis/customsearch_v1/classes.rb b/generated/google/apis/customsearch_v1/classes.rb index 61916b82f..35607e2d3 100644 --- a/generated/google/apis/customsearch_v1/classes.rb +++ b/generated/google/apis/customsearch_v1/classes.rb @@ -22,92 +22,39 @@ module Google module Apis module CustomsearchV1 - # - class Context - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `facets` - # @return [Array>] - attr_accessor :facets - - # - # 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) - @facets = args[:facets] if args.key?(:facets) - @title = args[:title] if args.key?(:title) - end - - # - class Facet - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `anchor` - # @return [String] - attr_accessor :anchor - - # - # Corresponds to the JSON property `label` - # @return [String] - attr_accessor :label - - # - # Corresponds to the JSON property `label_with_op` - # @return [String] - attr_accessor :label_with_op - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @anchor = args[:anchor] if args.key?(:anchor) - @label = args[:label] if args.key?(:label) - @label_with_op = args[:label_with_op] if args.key?(:label_with_op) - end - end - end - - # + # Promotion result. class Promotion include Google::Apis::Core::Hashable - # + # An array of block objects for this promotion. See [Google WebSearch + # Protocol + # reference](https://developers.google.com/custom-search/docs/xml_results) + # for more information. # Corresponds to the JSON property `bodyLines` # @return [Array] attr_accessor :body_lines - # + # An abridged version of this search's result URL, e.g. www.example.com. # Corresponds to the JSON property `displayLink` # @return [String] attr_accessor :display_link - # + # The title of the promotion, in HTML. # Corresponds to the JSON property `htmlTitle` # @return [String] attr_accessor :html_title - # + # Image belonging to a promotion. # Corresponds to the JSON property `image` # @return [Google::Apis::CustomsearchV1::Promotion::Image] attr_accessor :image - # + # The URL of the promotion. # Corresponds to the JSON property `link` # @return [String] attr_accessor :link - # + # The title of the promotion. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -126,26 +73,26 @@ module Google @title = args[:title] if args.key?(:title) end - # + # Block object belonging to a promotion. class BodyLine include Google::Apis::Core::Hashable - # + # The block object's text in HTML, if it has text. # Corresponds to the JSON property `htmlTitle` # @return [String] attr_accessor :html_title - # + # The anchor text of the block object's link, if it has a link. # Corresponds to the JSON property `link` # @return [String] attr_accessor :link - # + # The block object's text, if it has text. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title - # + # The URL of the block object's link, if it has one. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -163,21 +110,21 @@ module Google end end - # + # Image belonging to a promotion. class Image include Google::Apis::Core::Hashable - # + # Image height in pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height - # + # URL of the image for this promotion link. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source - # + # Image width in pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -195,310 +142,87 @@ module Google end end - # - class Query - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `count` - # @return [Fixnum] - attr_accessor :count - - # - # Corresponds to the JSON property `cr` - # @return [String] - attr_accessor :cr - - # - # Corresponds to the JSON property `cx` - # @return [String] - attr_accessor :cx - - # - # Corresponds to the JSON property `dateRestrict` - # @return [String] - attr_accessor :date_restrict - - # - # Corresponds to the JSON property `disableCnTwTranslation` - # @return [String] - attr_accessor :disable_cn_tw_translation - - # - # Corresponds to the JSON property `exactTerms` - # @return [String] - attr_accessor :exact_terms - - # - # Corresponds to the JSON property `excludeTerms` - # @return [String] - attr_accessor :exclude_terms - - # - # Corresponds to the JSON property `fileType` - # @return [String] - attr_accessor :file_type - - # - # Corresponds to the JSON property `filter` - # @return [String] - attr_accessor :filter - - # - # Corresponds to the JSON property `gl` - # @return [String] - attr_accessor :gl - - # - # Corresponds to the JSON property `googleHost` - # @return [String] - attr_accessor :google_host - - # - # Corresponds to the JSON property `highRange` - # @return [String] - attr_accessor :high_range - - # - # Corresponds to the JSON property `hl` - # @return [String] - attr_accessor :hl - - # - # Corresponds to the JSON property `hq` - # @return [String] - attr_accessor :hq - - # - # Corresponds to the JSON property `imgColorType` - # @return [String] - attr_accessor :img_color_type - - # - # Corresponds to the JSON property `imgDominantColor` - # @return [String] - attr_accessor :img_dominant_color - - # - # Corresponds to the JSON property `imgSize` - # @return [String] - attr_accessor :img_size - - # - # Corresponds to the JSON property `imgType` - # @return [String] - attr_accessor :img_type - - # - # Corresponds to the JSON property `inputEncoding` - # @return [String] - attr_accessor :input_encoding - - # - # Corresponds to the JSON property `language` - # @return [String] - attr_accessor :language - - # - # Corresponds to the JSON property `linkSite` - # @return [String] - attr_accessor :link_site - - # - # Corresponds to the JSON property `lowRange` - # @return [String] - attr_accessor :low_range - - # - # Corresponds to the JSON property `orTerms` - # @return [String] - attr_accessor :or_terms - - # - # Corresponds to the JSON property `outputEncoding` - # @return [String] - attr_accessor :output_encoding - - # - # Corresponds to the JSON property `relatedSite` - # @return [String] - attr_accessor :related_site - - # - # Corresponds to the JSON property `rights` - # @return [String] - attr_accessor :rights - - # - # Corresponds to the JSON property `safe` - # @return [String] - attr_accessor :safe - - # - # Corresponds to the JSON property `searchTerms` - # @return [String] - attr_accessor :search_terms - - # - # Corresponds to the JSON property `searchType` - # @return [String] - attr_accessor :search_type - - # - # Corresponds to the JSON property `siteSearch` - # @return [String] - attr_accessor :site_search - - # - # Corresponds to the JSON property `siteSearchFilter` - # @return [String] - attr_accessor :site_search_filter - - # - # Corresponds to the JSON property `sort` - # @return [String] - attr_accessor :sort - - # - # Corresponds to the JSON property `startIndex` - # @return [Fixnum] - attr_accessor :start_index - - # - # Corresponds to the JSON property `startPage` - # @return [Fixnum] - attr_accessor :start_page - - # - # Corresponds to the JSON property `title` - # @return [String] - attr_accessor :title - - # - # Corresponds to the JSON property `totalResults` - # @return [Fixnum] - attr_accessor :total_results - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @count = args[:count] if args.key?(:count) - @cr = args[:cr] if args.key?(:cr) - @cx = args[:cx] if args.key?(:cx) - @date_restrict = args[:date_restrict] if args.key?(:date_restrict) - @disable_cn_tw_translation = args[:disable_cn_tw_translation] if args.key?(:disable_cn_tw_translation) - @exact_terms = args[:exact_terms] if args.key?(:exact_terms) - @exclude_terms = args[:exclude_terms] if args.key?(:exclude_terms) - @file_type = args[:file_type] if args.key?(:file_type) - @filter = args[:filter] if args.key?(:filter) - @gl = args[:gl] if args.key?(:gl) - @google_host = args[:google_host] if args.key?(:google_host) - @high_range = args[:high_range] if args.key?(:high_range) - @hl = args[:hl] if args.key?(:hl) - @hq = args[:hq] if args.key?(:hq) - @img_color_type = args[:img_color_type] if args.key?(:img_color_type) - @img_dominant_color = args[:img_dominant_color] if args.key?(:img_dominant_color) - @img_size = args[:img_size] if args.key?(:img_size) - @img_type = args[:img_type] if args.key?(:img_type) - @input_encoding = args[:input_encoding] if args.key?(:input_encoding) - @language = args[:language] if args.key?(:language) - @link_site = args[:link_site] if args.key?(:link_site) - @low_range = args[:low_range] if args.key?(:low_range) - @or_terms = args[:or_terms] if args.key?(:or_terms) - @output_encoding = args[:output_encoding] if args.key?(:output_encoding) - @related_site = args[:related_site] if args.key?(:related_site) - @rights = args[:rights] if args.key?(:rights) - @safe = args[:safe] if args.key?(:safe) - @search_terms = args[:search_terms] if args.key?(:search_terms) - @search_type = args[:search_type] if args.key?(:search_type) - @site_search = args[:site_search] if args.key?(:site_search) - @site_search_filter = args[:site_search_filter] if args.key?(:site_search_filter) - @sort = args[:sort] if args.key?(:sort) - @start_index = args[:start_index] if args.key?(:start_index) - @start_page = args[:start_page] if args.key?(:start_page) - @title = args[:title] if args.key?(:title) - @total_results = args[:total_results] if args.key?(:total_results) - end - end - - # + # A custom search result. class Result include Google::Apis::Core::Hashable - # + # Indicates the ID of Google's cached version of the search result. # Corresponds to the JSON property `cacheId` # @return [String] attr_accessor :cache_id - # + # An abridged version of this search result’s URL, e.g. www.example.com. # Corresponds to the JSON property `displayLink` # @return [String] attr_accessor :display_link - # + # The file format of the search result. # Corresponds to the JSON property `fileFormat` # @return [String] attr_accessor :file_format - # + # The URL displayed after the snippet for each search result. # Corresponds to the JSON property `formattedUrl` # @return [String] attr_accessor :formatted_url - # + # The HTML-formatted URL displayed after the snippet for each search result. # Corresponds to the JSON property `htmlFormattedUrl` # @return [String] attr_accessor :html_formatted_url - # + # The snippet of the search result, in HTML. # Corresponds to the JSON property `htmlSnippet` # @return [String] attr_accessor :html_snippet - # + # The title of the search result, in HTML. # Corresponds to the JSON property `htmlTitle` # @return [String] attr_accessor :html_title - # + # Image belonging to a custom search result. # Corresponds to the JSON property `image` # @return [Google::Apis::CustomsearchV1::Result::Image] attr_accessor :image - # + # A unique identifier for the type of current object. For this API, it is + # `customsearch#result.` # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # Encapsulates all information about [refinement + # labels](https://developers.google.com/custom-search/docs/xml_results). # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels - # + # The full URL to which the search result is pointing, e.g. + # http://www.example.com/foo/bar. # Corresponds to the JSON property `link` # @return [String] attr_accessor :link - # + # The MIME type of the search result. # Corresponds to the JSON property `mime` # @return [String] attr_accessor :mime - # + # Contains + # [PageMap](https://developers.google.com/custom-search/docs/structured_data# + # pagemaps) + # information for this search result. # Corresponds to the JSON property `pagemap` - # @return [Hash>>] + # @return [Hash] attr_accessor :pagemap - # + # The snippet of the search result, in plain text. # Corresponds to the JSON property `snippet` # @return [String] attr_accessor :snippet - # + # The title of the search result, in plain text. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -526,41 +250,41 @@ module Google @title = args[:title] if args.key?(:title) end - # + # Image belonging to a custom search result. class Image include Google::Apis::Core::Hashable - # + # The size of the image, in pixels. # Corresponds to the JSON property `byteSize` # @return [Fixnum] attr_accessor :byte_size - # + # A URL pointing to the webpage hosting the image. # Corresponds to the JSON property `contextLink` # @return [String] attr_accessor :context_link - # + # The height of the image, in pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height - # + # The height of the thumbnail image, in pixels. # Corresponds to the JSON property `thumbnailHeight` # @return [Fixnum] attr_accessor :thumbnail_height - # + # A URL to the thumbnail image. # Corresponds to the JSON property `thumbnailLink` # @return [String] attr_accessor :thumbnail_link - # + # The width of the thumbnail image, in pixels. # Corresponds to the JSON property `thumbnailWidth` # @return [Fixnum] attr_accessor :thumbnail_width - # + # The width of the image, in pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -581,21 +305,23 @@ module Google end end - # + # Refinement label associated with a custom search result. class Label include Google::Apis::Core::Hashable - # + # The display name of a refinement label. This is the name you should + # display in your user interface. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # + # Refinement label and the associated refinement operation. # Corresponds to the JSON property `label_with_op` # @return [String] attr_accessor :label_with_op - # + # The name of a refinement label, which you can use to refine searches. + # Don't display this in your user interface; instead, use displayName. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -613,46 +339,55 @@ module Google end end - # + # Response to a custom search request. class Search include Google::Apis::Core::Hashable - # + # Metadata and refinements associated with the given search engine, + # including: + # * The name of the search engine that was used for the query. + # * A set of [facet + # objects](https://developers.google.com/custom-search/docs/refinements#create) + # (refinements) you can use for refining a search. # Corresponds to the JSON property `context` - # @return [Google::Apis::CustomsearchV1::Context] + # @return [Hash] attr_accessor :context - # + # The current set of custom search results. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # + # Unique identifier for the type of current object. For this API, it is + # customsearch#search. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # The set of + # [promotions](https://developers.google.com/custom-search/docs/promotions). + # Present only if the custom search engine's configuration files define any + # promotions for the given query. # Corresponds to the JSON property `promotions` # @return [Array] attr_accessor :promotions - # + # Query metadata for the previous, current, and next pages of results. # Corresponds to the JSON property `queries` - # @return [Hash>] + # @return [Google::Apis::CustomsearchV1::Search::Queries] attr_accessor :queries - # + # Metadata about a search operation. # Corresponds to the JSON property `searchInformation` # @return [Google::Apis::CustomsearchV1::Search::SearchInformation] attr_accessor :search_information - # + # Spell correction information for a query. # Corresponds to the JSON property `spelling` # @return [Google::Apis::CustomsearchV1::Search::Spelling] attr_accessor :spelling - # + # OpenSearch template and URL. # Corresponds to the JSON property `url` # @return [Google::Apis::CustomsearchV1::Search::Url] attr_accessor :url @@ -673,28 +408,1131 @@ module Google @url = args[:url] if args.key?(:url) end - # + # Query metadata for the previous, current, and next pages of results. + class Queries + include Google::Apis::Core::Hashable + + # Metadata representing the next page of results, if applicable. + # Corresponds to the JSON property `nextPage` + # @return [Array] + attr_accessor :next_page + + # Metadata representing the previous page of results, if applicable. + # Corresponds to the JSON property `previousPage` + # @return [Array] + attr_accessor :previous_page + + # Metadata representing the current request. + # Corresponds to the JSON property `request` + # @return [Array] + attr_accessor :request + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page = args[:next_page] if args.key?(:next_page) + @previous_page = args[:previous_page] if args.key?(:previous_page) + @request = args[:request] if args.key?(:request) + end + + # Custom search request metadata. + class NextPage + include Google::Apis::Core::Hashable + + # Number of search results returned in this set. + # Corresponds to the JSON property `count` + # @return [Fixnum] + attr_accessor :count + + # Restricts search results to documents originating in a particular + # country. You may use [Boolean + # operators](https://developers.google.com/custom-search/docs/xml_results# + # booleanOperators) + # in the `cr` parameter's value. + # Google WebSearch determines the country of a document by analyzing the + # following: + # * The top-level domain (TLD) of the document's URL. + # * The geographic location of the web server's IP address. + # See [Country (cr) Parameter + # Values](https://developers.google.com/custom-search/docs/xml_results# + # countryCollections) + # for a list of valid values for this parameter. + # Corresponds to the JSON property `cr` + # @return [String] + attr_accessor :cr + + # The identifier of a custom search engine created using the Custom Search + # [Control Panel](https://cse.google.com/). This is a custom property not + # defined in the OpenSearch spec. This parameter is **required**. + # Corresponds to the JSON property `cx` + # @return [String] + attr_accessor :cx + + # Restricts results to URLs based on date. Supported values include: + # * `d[number]`: requests results from the specified number of past days. + # * `w[number]`: requests results from the specified number of past weeks. + # * `m[number]`: requests results from the specified number of past months. + # * `y[number]`: requests results from the specified number of past years. + # Corresponds to the JSON property `dateRestrict` + # @return [String] + attr_accessor :date_restrict + + # Enables or disables the [Simplified and Traditional Chinese + # Search](https://developers.google.com/custom-search/docs/xml_results# + # chineseSearch) + # feature. + # Supported values are: + # * `0`: enabled (default) + # * `1`: disabled + # Corresponds to the JSON property `disableCnTwTranslation` + # @return [String] + attr_accessor :disable_cn_tw_translation + + # Identifies a phrase that all documents in the search results must + # contain. + # Corresponds to the JSON property `exactTerms` + # @return [String] + attr_accessor :exact_terms + + # Identifies a word or phrase that should not appear in any documents in + # the search results. + # Corresponds to the JSON property `excludeTerms` + # @return [String] + attr_accessor :exclude_terms + + # Restricts results to files of a specified extension. Filetypes supported + # by Google include: + # * Adobe Portable Document Format (`pdf`) + # * Adobe PostScript (`ps`) + # * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) + # * Lotus WordPro (`lwp`) + # * Macwrite (`mw`) + # * Microsoft Excel (`xls`) + # * Microsoft PowerPoint (`ppt`) + # * Microsoft Word (`doc`) + # * Microsoft Works (`wks`, `wps`, `wdb`) + # * Microsoft Write (`wri`) + # * Rich Text Format (`rtf`) + # * Shockwave Flash (`swf`) + # * Text (`ans`, `txt`). + # Additional filetypes may be added in the future. An up-to-date list can + # always be found in Google's [file type + # FAQ](https://support.google.com/webmasters/answer/35287). + # Corresponds to the JSON property `fileType` + # @return [String] + attr_accessor :file_type + + # Activates or deactivates the automatic filtering of Google search + # results. See [Automatic + # Filtering](https://developers.google.com/custom-search/docs/xml_results# + # automaticFiltering) + # for more information about Google's search results filters. Valid values + # for this parameter are: + # * `0`: Disabled + # * `1`: Enabled (default) + # **Note**: By default, Google applies filtering to all search results to + # improve the quality of those results. + # Corresponds to the JSON property `filter` + # @return [String] + attr_accessor :filter + + # Boosts search results whose country of origin matches the parameter + # value. See [Country + # Codes](https://developers.google.com/custom-search/docs/xml_results# + # countryCodes) + # for a list of valid values. + # Specifying a `gl` parameter value in WebSearch requests should improve + # the relevance of results. This is particularly true for international + # customers and, even more specifically, for customers in English-speaking + # countries other than the United States. + # Corresponds to the JSON property `gl` + # @return [String] + attr_accessor :gl + + # Specifies the Google domain (for example, google.com, google.de, or + # google.fr) to which the search should be limited. + # Corresponds to the JSON property `googleHost` + # @return [String] + attr_accessor :google_host + + # Specifies the ending value for a search range. Use `cse:lowRange` and + # `cse:highrange` to append an inclusive search range of + # `lowRange...highRange` to the query. + # Corresponds to the JSON property `highRange` + # @return [String] + attr_accessor :high_range + + # Specifies the interface language (host language) of your user interface. + # Explicitly setting this parameter improves the performance and the + # quality of your search results. + # See the [Interface + # Languages](https://developers.google.com/custom-search/docs/xml_results# + # wsInterfaceLanguages) + # section of [Internationalizing Queries and Results + # Presentation](https://developers.google.com/custom-search/docs/xml_results# + # wsInternationalizing) + # for more information, and [Supported Interface + # Languages](https://developers.google.com/custom-search/docs/ + # xml_results_appendices#interfaceLanguages) + # for a list of supported languages. + # Corresponds to the JSON property `hl` + # @return [String] + attr_accessor :hl + + # Appends the specified query terms to the query, as if they were combined + # with a logical `AND` operator. + # Corresponds to the JSON property `hq` + # @return [String] + attr_accessor :hq + + # Restricts results to images of a specified color type. Supported values + # are: + # * `mono` (black and white) + # * `gray` (grayscale) + # * `color` (color) + # Corresponds to the JSON property `imgColorType` + # @return [String] + attr_accessor :img_color_type + + # Restricts results to images with a specific dominant color. Supported + # values are: + # * `red` + # * `orange` + # * `yellow` + # * `green` + # * `teal` + # * `blue` + # * `purple` + # * `pink` + # * `white` + # * `gray` + # * `black` + # * `brown` + # Corresponds to the JSON property `imgDominantColor` + # @return [String] + attr_accessor :img_dominant_color + + # Restricts results to images of a specified size. Supported values are: + # * `icon` (small) + # * `small | medium | large | xlarge` (medium) + # * `xxlarge` (large) + # * `huge` (extra-large) + # Corresponds to the JSON property `imgSize` + # @return [String] + attr_accessor :img_size + + # Restricts results to images of a specified type. Supported values are: + # * `clipart` (Clip art) + # * `face` (Face) + # * `lineart` (Line drawing) + # * `photo` (Photo) + # * `animated` (Animated) + # * `stock` (Stock) + # Corresponds to the JSON property `imgType` + # @return [String] + attr_accessor :img_type + + # The character encoding supported for search requests. + # Corresponds to the JSON property `inputEncoding` + # @return [String] + attr_accessor :input_encoding + + # The language of the search results. + # Corresponds to the JSON property `language` + # @return [String] + attr_accessor :language + + # Specifies that all results should contain a link to a specific URL. + # Corresponds to the JSON property `linkSite` + # @return [String] + attr_accessor :link_site + + # Specifies the starting value for a search range. Use `cse:lowRange` and + # `cse:highrange` to append an inclusive search range of + # `lowRange...highRange` to the query. + # Corresponds to the JSON property `lowRange` + # @return [String] + attr_accessor :low_range + + # Provides additional search terms to check for in a document, where each + # document in the search results must contain at least one of the + # additional search terms. You can also use the [Boolean + # OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt) + # query term for this type of query. + # Corresponds to the JSON property `orTerms` + # @return [String] + attr_accessor :or_terms + + # The character encoding supported for search results. + # Corresponds to the JSON property `outputEncoding` + # @return [String] + attr_accessor :output_encoding + + # Specifies that all search results should be pages that are related to the + # specified URL. The parameter value should be a URL. + # Corresponds to the JSON property `relatedSite` + # @return [String] + attr_accessor :related_site + + # Filters based on licensing. Supported values include: + # * `cc_publicdomain` + # * `cc_attribute` + # * `cc_sharealike` + # * `cc_noncommercial` + # * `cc_nonderived` + # Corresponds to the JSON property `rights` + # @return [String] + attr_accessor :rights + + # Specifies the [SafeSearch + # level](https://developers.google.com/custom-search/docs/xml_results# + # safeSearchLevels) + # used for filtering out adult results. This is a custom property not + # defined in the OpenSearch spec. Valid parameter values are: + # * `"off"`: Disable SafeSearch + # * `"active"`: Enable SafeSearch + # Corresponds to the JSON property `safe` + # @return [String] + attr_accessor :safe + + # The search terms entered by the user. + # Corresponds to the JSON property `searchTerms` + # @return [String] + attr_accessor :search_terms + + # Allowed values are `web` or `image`. If unspecified, results are limited + # to webpages. + # Corresponds to the JSON property `searchType` + # @return [String] + attr_accessor :search_type + + # Restricts results to URLs from a specified site. + # Corresponds to the JSON property `siteSearch` + # @return [String] + attr_accessor :site_search + + # Specifies whether to include or exclude results from the site named in + # the `sitesearch` parameter. Supported values are: + # * `i`: include content from site + # * `e`: exclude content from site + # Corresponds to the JSON property `siteSearchFilter` + # @return [String] + attr_accessor :site_search_filter + + # Specifies that results should be sorted according to the specified + # expression. For example, sort by date. + # Corresponds to the JSON property `sort` + # @return [String] + attr_accessor :sort + + # The index of the current set of search results into the total set of + # results, where the index of the first result is 1. + # Corresponds to the JSON property `startIndex` + # @return [Fixnum] + attr_accessor :start_index + + # The page number of this set of results, where the page length is set by + # the `count` property. + # Corresponds to the JSON property `startPage` + # @return [Fixnum] + attr_accessor :start_page + + # A description of the query. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # Estimated number of total search results. May not be accurate. + # Corresponds to the JSON property `totalResults` + # @return [Fixnum] + attr_accessor :total_results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @count = args[:count] if args.key?(:count) + @cr = args[:cr] if args.key?(:cr) + @cx = args[:cx] if args.key?(:cx) + @date_restrict = args[:date_restrict] if args.key?(:date_restrict) + @disable_cn_tw_translation = args[:disable_cn_tw_translation] if args.key?(:disable_cn_tw_translation) + @exact_terms = args[:exact_terms] if args.key?(:exact_terms) + @exclude_terms = args[:exclude_terms] if args.key?(:exclude_terms) + @file_type = args[:file_type] if args.key?(:file_type) + @filter = args[:filter] if args.key?(:filter) + @gl = args[:gl] if args.key?(:gl) + @google_host = args[:google_host] if args.key?(:google_host) + @high_range = args[:high_range] if args.key?(:high_range) + @hl = args[:hl] if args.key?(:hl) + @hq = args[:hq] if args.key?(:hq) + @img_color_type = args[:img_color_type] if args.key?(:img_color_type) + @img_dominant_color = args[:img_dominant_color] if args.key?(:img_dominant_color) + @img_size = args[:img_size] if args.key?(:img_size) + @img_type = args[:img_type] if args.key?(:img_type) + @input_encoding = args[:input_encoding] if args.key?(:input_encoding) + @language = args[:language] if args.key?(:language) + @link_site = args[:link_site] if args.key?(:link_site) + @low_range = args[:low_range] if args.key?(:low_range) + @or_terms = args[:or_terms] if args.key?(:or_terms) + @output_encoding = args[:output_encoding] if args.key?(:output_encoding) + @related_site = args[:related_site] if args.key?(:related_site) + @rights = args[:rights] if args.key?(:rights) + @safe = args[:safe] if args.key?(:safe) + @search_terms = args[:search_terms] if args.key?(:search_terms) + @search_type = args[:search_type] if args.key?(:search_type) + @site_search = args[:site_search] if args.key?(:site_search) + @site_search_filter = args[:site_search_filter] if args.key?(:site_search_filter) + @sort = args[:sort] if args.key?(:sort) + @start_index = args[:start_index] if args.key?(:start_index) + @start_page = args[:start_page] if args.key?(:start_page) + @title = args[:title] if args.key?(:title) + @total_results = args[:total_results] if args.key?(:total_results) + end + end + + # Custom search request metadata. + class PreviousPage + include Google::Apis::Core::Hashable + + # Number of search results returned in this set. + # Corresponds to the JSON property `count` + # @return [Fixnum] + attr_accessor :count + + # Restricts search results to documents originating in a particular + # country. You may use [Boolean + # operators](https://developers.google.com/custom-search/docs/xml_results# + # booleanOperators) + # in the `cr` parameter's value. + # Google WebSearch determines the country of a document by analyzing the + # following: + # * The top-level domain (TLD) of the document's URL. + # * The geographic location of the web server's IP address. + # See [Country (cr) Parameter + # Values](https://developers.google.com/custom-search/docs/xml_results# + # countryCollections) + # for a list of valid values for this parameter. + # Corresponds to the JSON property `cr` + # @return [String] + attr_accessor :cr + + # The identifier of a custom search engine created using the Custom Search + # [Control Panel](https://cse.google.com/). This is a custom property not + # defined in the OpenSearch spec. This parameter is **required**. + # Corresponds to the JSON property `cx` + # @return [String] + attr_accessor :cx + + # Restricts results to URLs based on date. Supported values include: + # * `d[number]`: requests results from the specified number of past days. + # * `w[number]`: requests results from the specified number of past weeks. + # * `m[number]`: requests results from the specified number of past months. + # * `y[number]`: requests results from the specified number of past years. + # Corresponds to the JSON property `dateRestrict` + # @return [String] + attr_accessor :date_restrict + + # Enables or disables the [Simplified and Traditional Chinese + # Search](https://developers.google.com/custom-search/docs/xml_results# + # chineseSearch) + # feature. + # Supported values are: + # * `0`: enabled (default) + # * `1`: disabled + # Corresponds to the JSON property `disableCnTwTranslation` + # @return [String] + attr_accessor :disable_cn_tw_translation + + # Identifies a phrase that all documents in the search results must + # contain. + # Corresponds to the JSON property `exactTerms` + # @return [String] + attr_accessor :exact_terms + + # Identifies a word or phrase that should not appear in any documents in + # the search results. + # Corresponds to the JSON property `excludeTerms` + # @return [String] + attr_accessor :exclude_terms + + # Restricts results to files of a specified extension. Filetypes supported + # by Google include: + # * Adobe Portable Document Format (`pdf`) + # * Adobe PostScript (`ps`) + # * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) + # * Lotus WordPro (`lwp`) + # * Macwrite (`mw`) + # * Microsoft Excel (`xls`) + # * Microsoft PowerPoint (`ppt`) + # * Microsoft Word (`doc`) + # * Microsoft Works (`wks`, `wps`, `wdb`) + # * Microsoft Write (`wri`) + # * Rich Text Format (`rtf`) + # * Shockwave Flash (`swf`) + # * Text (`ans`, `txt`). + # Additional filetypes may be added in the future. An up-to-date list can + # always be found in Google's [file type + # FAQ](https://support.google.com/webmasters/answer/35287). + # Corresponds to the JSON property `fileType` + # @return [String] + attr_accessor :file_type + + # Activates or deactivates the automatic filtering of Google search + # results. See [Automatic + # Filtering](https://developers.google.com/custom-search/docs/xml_results# + # automaticFiltering) + # for more information about Google's search results filters. Valid values + # for this parameter are: + # * `0`: Disabled + # * `1`: Enabled (default) + # **Note**: By default, Google applies filtering to all search results to + # improve the quality of those results. + # Corresponds to the JSON property `filter` + # @return [String] + attr_accessor :filter + + # Boosts search results whose country of origin matches the parameter + # value. See [Country + # Codes](https://developers.google.com/custom-search/docs/xml_results# + # countryCodes) + # for a list of valid values. + # Specifying a `gl` parameter value in WebSearch requests should improve + # the relevance of results. This is particularly true for international + # customers and, even more specifically, for customers in English-speaking + # countries other than the United States. + # Corresponds to the JSON property `gl` + # @return [String] + attr_accessor :gl + + # Specifies the Google domain (for example, google.com, google.de, or + # google.fr) to which the search should be limited. + # Corresponds to the JSON property `googleHost` + # @return [String] + attr_accessor :google_host + + # Specifies the ending value for a search range. Use `cse:lowRange` and + # `cse:highrange` to append an inclusive search range of + # `lowRange...highRange` to the query. + # Corresponds to the JSON property `highRange` + # @return [String] + attr_accessor :high_range + + # Specifies the interface language (host language) of your user interface. + # Explicitly setting this parameter improves the performance and the + # quality of your search results. + # See the [Interface + # Languages](https://developers.google.com/custom-search/docs/xml_results# + # wsInterfaceLanguages) + # section of [Internationalizing Queries and Results + # Presentation](https://developers.google.com/custom-search/docs/xml_results# + # wsInternationalizing) + # for more information, and [Supported Interface + # Languages](https://developers.google.com/custom-search/docs/ + # xml_results_appendices#interfaceLanguages) + # for a list of supported languages. + # Corresponds to the JSON property `hl` + # @return [String] + attr_accessor :hl + + # Appends the specified query terms to the query, as if they were combined + # with a logical `AND` operator. + # Corresponds to the JSON property `hq` + # @return [String] + attr_accessor :hq + + # Restricts results to images of a specified color type. Supported values + # are: + # * `mono` (black and white) + # * `gray` (grayscale) + # * `color` (color) + # Corresponds to the JSON property `imgColorType` + # @return [String] + attr_accessor :img_color_type + + # Restricts results to images with a specific dominant color. Supported + # values are: + # * `red` + # * `orange` + # * `yellow` + # * `green` + # * `teal` + # * `blue` + # * `purple` + # * `pink` + # * `white` + # * `gray` + # * `black` + # * `brown` + # Corresponds to the JSON property `imgDominantColor` + # @return [String] + attr_accessor :img_dominant_color + + # Restricts results to images of a specified size. Supported values are: + # * `icon` (small) + # * `small | medium | large | xlarge` (medium) + # * `xxlarge` (large) + # * `huge` (extra-large) + # Corresponds to the JSON property `imgSize` + # @return [String] + attr_accessor :img_size + + # Restricts results to images of a specified type. Supported values are: + # * `clipart` (Clip art) + # * `face` (Face) + # * `lineart` (Line drawing) + # * `photo` (Photo) + # * `animated` (Animated) + # * `stock` (Stock) + # Corresponds to the JSON property `imgType` + # @return [String] + attr_accessor :img_type + + # The character encoding supported for search requests. + # Corresponds to the JSON property `inputEncoding` + # @return [String] + attr_accessor :input_encoding + + # The language of the search results. + # Corresponds to the JSON property `language` + # @return [String] + attr_accessor :language + + # Specifies that all results should contain a link to a specific URL. + # Corresponds to the JSON property `linkSite` + # @return [String] + attr_accessor :link_site + + # Specifies the starting value for a search range. Use `cse:lowRange` and + # `cse:highrange` to append an inclusive search range of + # `lowRange...highRange` to the query. + # Corresponds to the JSON property `lowRange` + # @return [String] + attr_accessor :low_range + + # Provides additional search terms to check for in a document, where each + # document in the search results must contain at least one of the + # additional search terms. You can also use the [Boolean + # OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt) + # query term for this type of query. + # Corresponds to the JSON property `orTerms` + # @return [String] + attr_accessor :or_terms + + # The character encoding supported for search results. + # Corresponds to the JSON property `outputEncoding` + # @return [String] + attr_accessor :output_encoding + + # Specifies that all search results should be pages that are related to the + # specified URL. The parameter value should be a URL. + # Corresponds to the JSON property `relatedSite` + # @return [String] + attr_accessor :related_site + + # Filters based on licensing. Supported values include: + # * `cc_publicdomain` + # * `cc_attribute` + # * `cc_sharealike` + # * `cc_noncommercial` + # * `cc_nonderived` + # Corresponds to the JSON property `rights` + # @return [String] + attr_accessor :rights + + # Specifies the [SafeSearch + # level](https://developers.google.com/custom-search/docs/xml_results# + # safeSearchLevels) + # used for filtering out adult results. This is a custom property not + # defined in the OpenSearch spec. Valid parameter values are: + # * `"off"`: Disable SafeSearch + # * `"active"`: Enable SafeSearch + # Corresponds to the JSON property `safe` + # @return [String] + attr_accessor :safe + + # The search terms entered by the user. + # Corresponds to the JSON property `searchTerms` + # @return [String] + attr_accessor :search_terms + + # Allowed values are `web` or `image`. If unspecified, results are limited + # to webpages. + # Corresponds to the JSON property `searchType` + # @return [String] + attr_accessor :search_type + + # Restricts results to URLs from a specified site. + # Corresponds to the JSON property `siteSearch` + # @return [String] + attr_accessor :site_search + + # Specifies whether to include or exclude results from the site named in + # the `sitesearch` parameter. Supported values are: + # * `i`: include content from site + # * `e`: exclude content from site + # Corresponds to the JSON property `siteSearchFilter` + # @return [String] + attr_accessor :site_search_filter + + # Specifies that results should be sorted according to the specified + # expression. For example, sort by date. + # Corresponds to the JSON property `sort` + # @return [String] + attr_accessor :sort + + # The index of the current set of search results into the total set of + # results, where the index of the first result is 1. + # Corresponds to the JSON property `startIndex` + # @return [Fixnum] + attr_accessor :start_index + + # The page number of this set of results, where the page length is set by + # the `count` property. + # Corresponds to the JSON property `startPage` + # @return [Fixnum] + attr_accessor :start_page + + # A description of the query. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # Estimated number of total search results. May not be accurate. + # Corresponds to the JSON property `totalResults` + # @return [Fixnum] + attr_accessor :total_results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @count = args[:count] if args.key?(:count) + @cr = args[:cr] if args.key?(:cr) + @cx = args[:cx] if args.key?(:cx) + @date_restrict = args[:date_restrict] if args.key?(:date_restrict) + @disable_cn_tw_translation = args[:disable_cn_tw_translation] if args.key?(:disable_cn_tw_translation) + @exact_terms = args[:exact_terms] if args.key?(:exact_terms) + @exclude_terms = args[:exclude_terms] if args.key?(:exclude_terms) + @file_type = args[:file_type] if args.key?(:file_type) + @filter = args[:filter] if args.key?(:filter) + @gl = args[:gl] if args.key?(:gl) + @google_host = args[:google_host] if args.key?(:google_host) + @high_range = args[:high_range] if args.key?(:high_range) + @hl = args[:hl] if args.key?(:hl) + @hq = args[:hq] if args.key?(:hq) + @img_color_type = args[:img_color_type] if args.key?(:img_color_type) + @img_dominant_color = args[:img_dominant_color] if args.key?(:img_dominant_color) + @img_size = args[:img_size] if args.key?(:img_size) + @img_type = args[:img_type] if args.key?(:img_type) + @input_encoding = args[:input_encoding] if args.key?(:input_encoding) + @language = args[:language] if args.key?(:language) + @link_site = args[:link_site] if args.key?(:link_site) + @low_range = args[:low_range] if args.key?(:low_range) + @or_terms = args[:or_terms] if args.key?(:or_terms) + @output_encoding = args[:output_encoding] if args.key?(:output_encoding) + @related_site = args[:related_site] if args.key?(:related_site) + @rights = args[:rights] if args.key?(:rights) + @safe = args[:safe] if args.key?(:safe) + @search_terms = args[:search_terms] if args.key?(:search_terms) + @search_type = args[:search_type] if args.key?(:search_type) + @site_search = args[:site_search] if args.key?(:site_search) + @site_search_filter = args[:site_search_filter] if args.key?(:site_search_filter) + @sort = args[:sort] if args.key?(:sort) + @start_index = args[:start_index] if args.key?(:start_index) + @start_page = args[:start_page] if args.key?(:start_page) + @title = args[:title] if args.key?(:title) + @total_results = args[:total_results] if args.key?(:total_results) + end + end + + # Custom search request metadata. + class Request + include Google::Apis::Core::Hashable + + # Number of search results returned in this set. + # Corresponds to the JSON property `count` + # @return [Fixnum] + attr_accessor :count + + # Restricts search results to documents originating in a particular + # country. You may use [Boolean + # operators](https://developers.google.com/custom-search/docs/xml_results# + # booleanOperators) + # in the `cr` parameter's value. + # Google WebSearch determines the country of a document by analyzing the + # following: + # * The top-level domain (TLD) of the document's URL. + # * The geographic location of the web server's IP address. + # See [Country (cr) Parameter + # Values](https://developers.google.com/custom-search/docs/xml_results# + # countryCollections) + # for a list of valid values for this parameter. + # Corresponds to the JSON property `cr` + # @return [String] + attr_accessor :cr + + # The identifier of a custom search engine created using the Custom Search + # [Control Panel](https://cse.google.com/). This is a custom property not + # defined in the OpenSearch spec. This parameter is **required**. + # Corresponds to the JSON property `cx` + # @return [String] + attr_accessor :cx + + # Restricts results to URLs based on date. Supported values include: + # * `d[number]`: requests results from the specified number of past days. + # * `w[number]`: requests results from the specified number of past weeks. + # * `m[number]`: requests results from the specified number of past months. + # * `y[number]`: requests results from the specified number of past years. + # Corresponds to the JSON property `dateRestrict` + # @return [String] + attr_accessor :date_restrict + + # Enables or disables the [Simplified and Traditional Chinese + # Search](https://developers.google.com/custom-search/docs/xml_results# + # chineseSearch) + # feature. + # Supported values are: + # * `0`: enabled (default) + # * `1`: disabled + # Corresponds to the JSON property `disableCnTwTranslation` + # @return [String] + attr_accessor :disable_cn_tw_translation + + # Identifies a phrase that all documents in the search results must + # contain. + # Corresponds to the JSON property `exactTerms` + # @return [String] + attr_accessor :exact_terms + + # Identifies a word or phrase that should not appear in any documents in + # the search results. + # Corresponds to the JSON property `excludeTerms` + # @return [String] + attr_accessor :exclude_terms + + # Restricts results to files of a specified extension. Filetypes supported + # by Google include: + # * Adobe Portable Document Format (`pdf`) + # * Adobe PostScript (`ps`) + # * Lotus 1-2-3 (`wk1`, `wk2`, `wk3`, `wk4`, `wk5`, `wki`, `wks`, `wku`) + # * Lotus WordPro (`lwp`) + # * Macwrite (`mw`) + # * Microsoft Excel (`xls`) + # * Microsoft PowerPoint (`ppt`) + # * Microsoft Word (`doc`) + # * Microsoft Works (`wks`, `wps`, `wdb`) + # * Microsoft Write (`wri`) + # * Rich Text Format (`rtf`) + # * Shockwave Flash (`swf`) + # * Text (`ans`, `txt`). + # Additional filetypes may be added in the future. An up-to-date list can + # always be found in Google's [file type + # FAQ](https://support.google.com/webmasters/answer/35287). + # Corresponds to the JSON property `fileType` + # @return [String] + attr_accessor :file_type + + # Activates or deactivates the automatic filtering of Google search + # results. See [Automatic + # Filtering](https://developers.google.com/custom-search/docs/xml_results# + # automaticFiltering) + # for more information about Google's search results filters. Valid values + # for this parameter are: + # * `0`: Disabled + # * `1`: Enabled (default) + # **Note**: By default, Google applies filtering to all search results to + # improve the quality of those results. + # Corresponds to the JSON property `filter` + # @return [String] + attr_accessor :filter + + # Boosts search results whose country of origin matches the parameter + # value. See [Country + # Codes](https://developers.google.com/custom-search/docs/xml_results# + # countryCodes) + # for a list of valid values. + # Specifying a `gl` parameter value in WebSearch requests should improve + # the relevance of results. This is particularly true for international + # customers and, even more specifically, for customers in English-speaking + # countries other than the United States. + # Corresponds to the JSON property `gl` + # @return [String] + attr_accessor :gl + + # Specifies the Google domain (for example, google.com, google.de, or + # google.fr) to which the search should be limited. + # Corresponds to the JSON property `googleHost` + # @return [String] + attr_accessor :google_host + + # Specifies the ending value for a search range. Use `cse:lowRange` and + # `cse:highrange` to append an inclusive search range of + # `lowRange...highRange` to the query. + # Corresponds to the JSON property `highRange` + # @return [String] + attr_accessor :high_range + + # Specifies the interface language (host language) of your user interface. + # Explicitly setting this parameter improves the performance and the + # quality of your search results. + # See the [Interface + # Languages](https://developers.google.com/custom-search/docs/xml_results# + # wsInterfaceLanguages) + # section of [Internationalizing Queries and Results + # Presentation](https://developers.google.com/custom-search/docs/xml_results# + # wsInternationalizing) + # for more information, and [Supported Interface + # Languages](https://developers.google.com/custom-search/docs/ + # xml_results_appendices#interfaceLanguages) + # for a list of supported languages. + # Corresponds to the JSON property `hl` + # @return [String] + attr_accessor :hl + + # Appends the specified query terms to the query, as if they were combined + # with a logical `AND` operator. + # Corresponds to the JSON property `hq` + # @return [String] + attr_accessor :hq + + # Restricts results to images of a specified color type. Supported values + # are: + # * `mono` (black and white) + # * `gray` (grayscale) + # * `color` (color) + # Corresponds to the JSON property `imgColorType` + # @return [String] + attr_accessor :img_color_type + + # Restricts results to images with a specific dominant color. Supported + # values are: + # * `red` + # * `orange` + # * `yellow` + # * `green` + # * `teal` + # * `blue` + # * `purple` + # * `pink` + # * `white` + # * `gray` + # * `black` + # * `brown` + # Corresponds to the JSON property `imgDominantColor` + # @return [String] + attr_accessor :img_dominant_color + + # Restricts results to images of a specified size. Supported values are: + # * `icon` (small) + # * `small | medium | large | xlarge` (medium) + # * `xxlarge` (large) + # * `huge` (extra-large) + # Corresponds to the JSON property `imgSize` + # @return [String] + attr_accessor :img_size + + # Restricts results to images of a specified type. Supported values are: + # * `clipart` (Clip art) + # * `face` (Face) + # * `lineart` (Line drawing) + # * `photo` (Photo) + # * `animated` (Animated) + # * `stock` (Stock) + # Corresponds to the JSON property `imgType` + # @return [String] + attr_accessor :img_type + + # The character encoding supported for search requests. + # Corresponds to the JSON property `inputEncoding` + # @return [String] + attr_accessor :input_encoding + + # The language of the search results. + # Corresponds to the JSON property `language` + # @return [String] + attr_accessor :language + + # Specifies that all results should contain a link to a specific URL. + # Corresponds to the JSON property `linkSite` + # @return [String] + attr_accessor :link_site + + # Specifies the starting value for a search range. Use `cse:lowRange` and + # `cse:highrange` to append an inclusive search range of + # `lowRange...highRange` to the query. + # Corresponds to the JSON property `lowRange` + # @return [String] + attr_accessor :low_range + + # Provides additional search terms to check for in a document, where each + # document in the search results must contain at least one of the + # additional search terms. You can also use the [Boolean + # OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt) + # query term for this type of query. + # Corresponds to the JSON property `orTerms` + # @return [String] + attr_accessor :or_terms + + # The character encoding supported for search results. + # Corresponds to the JSON property `outputEncoding` + # @return [String] + attr_accessor :output_encoding + + # Specifies that all search results should be pages that are related to the + # specified URL. The parameter value should be a URL. + # Corresponds to the JSON property `relatedSite` + # @return [String] + attr_accessor :related_site + + # Filters based on licensing. Supported values include: + # * `cc_publicdomain` + # * `cc_attribute` + # * `cc_sharealike` + # * `cc_noncommercial` + # * `cc_nonderived` + # Corresponds to the JSON property `rights` + # @return [String] + attr_accessor :rights + + # Specifies the [SafeSearch + # level](https://developers.google.com/custom-search/docs/xml_results# + # safeSearchLevels) + # used for filtering out adult results. This is a custom property not + # defined in the OpenSearch spec. Valid parameter values are: + # * `"off"`: Disable SafeSearch + # * `"active"`: Enable SafeSearch + # Corresponds to the JSON property `safe` + # @return [String] + attr_accessor :safe + + # The search terms entered by the user. + # Corresponds to the JSON property `searchTerms` + # @return [String] + attr_accessor :search_terms + + # Allowed values are `web` or `image`. If unspecified, results are limited + # to webpages. + # Corresponds to the JSON property `searchType` + # @return [String] + attr_accessor :search_type + + # Restricts results to URLs from a specified site. + # Corresponds to the JSON property `siteSearch` + # @return [String] + attr_accessor :site_search + + # Specifies whether to include or exclude results from the site named in + # the `sitesearch` parameter. Supported values are: + # * `i`: include content from site + # * `e`: exclude content from site + # Corresponds to the JSON property `siteSearchFilter` + # @return [String] + attr_accessor :site_search_filter + + # Specifies that results should be sorted according to the specified + # expression. For example, sort by date. + # Corresponds to the JSON property `sort` + # @return [String] + attr_accessor :sort + + # The index of the current set of search results into the total set of + # results, where the index of the first result is 1. + # Corresponds to the JSON property `startIndex` + # @return [Fixnum] + attr_accessor :start_index + + # The page number of this set of results, where the page length is set by + # the `count` property. + # Corresponds to the JSON property `startPage` + # @return [Fixnum] + attr_accessor :start_page + + # A description of the query. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # Estimated number of total search results. May not be accurate. + # Corresponds to the JSON property `totalResults` + # @return [Fixnum] + attr_accessor :total_results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @count = args[:count] if args.key?(:count) + @cr = args[:cr] if args.key?(:cr) + @cx = args[:cx] if args.key?(:cx) + @date_restrict = args[:date_restrict] if args.key?(:date_restrict) + @disable_cn_tw_translation = args[:disable_cn_tw_translation] if args.key?(:disable_cn_tw_translation) + @exact_terms = args[:exact_terms] if args.key?(:exact_terms) + @exclude_terms = args[:exclude_terms] if args.key?(:exclude_terms) + @file_type = args[:file_type] if args.key?(:file_type) + @filter = args[:filter] if args.key?(:filter) + @gl = args[:gl] if args.key?(:gl) + @google_host = args[:google_host] if args.key?(:google_host) + @high_range = args[:high_range] if args.key?(:high_range) + @hl = args[:hl] if args.key?(:hl) + @hq = args[:hq] if args.key?(:hq) + @img_color_type = args[:img_color_type] if args.key?(:img_color_type) + @img_dominant_color = args[:img_dominant_color] if args.key?(:img_dominant_color) + @img_size = args[:img_size] if args.key?(:img_size) + @img_type = args[:img_type] if args.key?(:img_type) + @input_encoding = args[:input_encoding] if args.key?(:input_encoding) + @language = args[:language] if args.key?(:language) + @link_site = args[:link_site] if args.key?(:link_site) + @low_range = args[:low_range] if args.key?(:low_range) + @or_terms = args[:or_terms] if args.key?(:or_terms) + @output_encoding = args[:output_encoding] if args.key?(:output_encoding) + @related_site = args[:related_site] if args.key?(:related_site) + @rights = args[:rights] if args.key?(:rights) + @safe = args[:safe] if args.key?(:safe) + @search_terms = args[:search_terms] if args.key?(:search_terms) + @search_type = args[:search_type] if args.key?(:search_type) + @site_search = args[:site_search] if args.key?(:site_search) + @site_search_filter = args[:site_search_filter] if args.key?(:site_search_filter) + @sort = args[:sort] if args.key?(:sort) + @start_index = args[:start_index] if args.key?(:start_index) + @start_page = args[:start_page] if args.key?(:start_page) + @title = args[:title] if args.key?(:title) + @total_results = args[:total_results] if args.key?(:total_results) + end + end + end + + # Metadata about a search operation. class SearchInformation include Google::Apis::Core::Hashable - # + # The time taken for the server to return search results, formatted + # according to locale style. # Corresponds to the JSON property `formattedSearchTime` # @return [String] attr_accessor :formatted_search_time - # + # The total number of search results, formatted according to locale style. # Corresponds to the JSON property `formattedTotalResults` # @return [String] attr_accessor :formatted_total_results - # + # The time taken for the server to return search results. # Corresponds to the JSON property `searchTime` # @return [Float] attr_accessor :search_time - # + # The total number of search results returned by the query. # Corresponds to the JSON property `totalResults` - # @return [Fixnum] + # @return [String] attr_accessor :total_results def initialize(**args) @@ -710,16 +1548,16 @@ module Google end end - # + # Spell correction information for a query. class Spelling include Google::Apis::Core::Hashable - # + # The corrected query. # Corresponds to the JSON property `correctedQuery` # @return [String] attr_accessor :corrected_query - # + # The corrected query, formatted in HTML. # Corresponds to the JSON property `htmlCorrectedQuery` # @return [String] attr_accessor :html_corrected_query @@ -735,16 +1573,19 @@ module Google end end - # + # OpenSearch template and URL. class Url include Google::Apis::Core::Hashable - # + # The actual [OpenSearch + # template](http://www.opensearch.org/specifications/opensearch/1.1# + # opensearch_url_template_syntax) + # for this API. # Corresponds to the JSON property `template` # @return [String] attr_accessor :template - # + # The MIME type of the OpenSearch URL template for the Custom Search API. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type diff --git a/generated/google/apis/customsearch_v1/representations.rb b/generated/google/apis/customsearch_v1/representations.rb index 575973f0b..7ad933bc4 100644 --- a/generated/google/apis/customsearch_v1/representations.rb +++ b/generated/google/apis/customsearch_v1/representations.rb @@ -22,18 +22,6 @@ module Google module Apis module CustomsearchV1 - class Context - class Representation < Google::Apis::Core::JsonRepresentation; end - - class Facet - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - include Google::Apis::Core::JsonObjectSupport - end - class Promotion class Representation < Google::Apis::Core::JsonRepresentation; end @@ -52,12 +40,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class Query - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class Result class Representation < Google::Apis::Core::JsonRepresentation; end @@ -79,6 +61,30 @@ module Google class Search class Representation < Google::Apis::Core::JsonRepresentation; end + class Queries + class Representation < Google::Apis::Core::JsonRepresentation; end + + class NextPage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PreviousPage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Request + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + class SearchInformation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -100,28 +106,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class Context - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :facets, as: 'facets', :class => Array do - include Representable::JSON::Collection - items class: Google::Apis::CustomsearchV1::Context::Facet, decorator: Google::Apis::CustomsearchV1::Context::Facet::Representation - - end - - property :title, as: 'title' - end - - class Facet - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :anchor, as: 'anchor' - property :label, as: 'label' - property :label_with_op, as: 'label_with_op' - end - end - end - class Promotion # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -155,48 +139,6 @@ module Google end end - class Query - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :count, as: 'count' - property :cr, as: 'cr' - property :cx, as: 'cx' - property :date_restrict, as: 'dateRestrict' - property :disable_cn_tw_translation, as: 'disableCnTwTranslation' - property :exact_terms, as: 'exactTerms' - property :exclude_terms, as: 'excludeTerms' - property :file_type, as: 'fileType' - property :filter, as: 'filter' - property :gl, as: 'gl' - property :google_host, as: 'googleHost' - property :high_range, as: 'highRange' - property :hl, as: 'hl' - property :hq, as: 'hq' - property :img_color_type, as: 'imgColorType' - property :img_dominant_color, as: 'imgDominantColor' - property :img_size, as: 'imgSize' - property :img_type, as: 'imgType' - property :input_encoding, as: 'inputEncoding' - property :language, as: 'language' - property :link_site, as: 'linkSite' - property :low_range, as: 'lowRange' - property :or_terms, as: 'orTerms' - property :output_encoding, as: 'outputEncoding' - property :related_site, as: 'relatedSite' - property :rights, as: 'rights' - property :safe, as: 'safe' - property :search_terms, as: 'searchTerms' - property :search_type, as: 'searchType' - property :site_search, as: 'siteSearch' - property :site_search_filter, as: 'siteSearchFilter' - property :sort, as: 'sort' - property :start_index, as: 'startIndex' - property :start_page, as: 'startPage' - property :title, as: 'title' - property :total_results, :numeric_string => true, as: 'totalResults' - end - end - class Result # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -214,11 +156,7 @@ module Google property :link, as: 'link' property :mime, as: 'mime' - hash :pagemap, as: 'pagemap', :class => Array do - include Representable::JSON::Collection - items - end - + hash :pagemap, as: 'pagemap' property :snippet, as: 'snippet' property :title, as: 'title' end @@ -249,18 +187,13 @@ module Google class Search # @private class Representation < Google::Apis::Core::JsonRepresentation - property :context, as: 'context', class: Google::Apis::CustomsearchV1::Context, decorator: Google::Apis::CustomsearchV1::Context::Representation - + hash :context, as: 'context' collection :items, as: 'items', class: Google::Apis::CustomsearchV1::Result, decorator: Google::Apis::CustomsearchV1::Result::Representation property :kind, as: 'kind' collection :promotions, as: 'promotions', class: Google::Apis::CustomsearchV1::Promotion, decorator: Google::Apis::CustomsearchV1::Promotion::Representation - hash :queries, as: 'queries', :class => Array do - include Representable::JSON::Collection - items class: Google::Apis::CustomsearchV1::Query, decorator: Google::Apis::CustomsearchV1::Query::Representation - - end + property :queries, as: 'queries', class: Google::Apis::CustomsearchV1::Search::Queries, decorator: Google::Apis::CustomsearchV1::Search::Queries::Representation property :search_information, as: 'searchInformation', class: Google::Apis::CustomsearchV1::Search::SearchInformation, decorator: Google::Apis::CustomsearchV1::Search::SearchInformation::Representation @@ -270,13 +203,151 @@ module Google end + class Queries + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :next_page, as: 'nextPage', class: Google::Apis::CustomsearchV1::Search::Queries::NextPage, decorator: Google::Apis::CustomsearchV1::Search::Queries::NextPage::Representation + + collection :previous_page, as: 'previousPage', class: Google::Apis::CustomsearchV1::Search::Queries::PreviousPage, decorator: Google::Apis::CustomsearchV1::Search::Queries::PreviousPage::Representation + + collection :request, as: 'request', class: Google::Apis::CustomsearchV1::Search::Queries::Request, decorator: Google::Apis::CustomsearchV1::Search::Queries::Request::Representation + + end + + class NextPage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :count, as: 'count' + property :cr, as: 'cr' + property :cx, as: 'cx' + property :date_restrict, as: 'dateRestrict' + property :disable_cn_tw_translation, as: 'disableCnTwTranslation' + property :exact_terms, as: 'exactTerms' + property :exclude_terms, as: 'excludeTerms' + property :file_type, as: 'fileType' + property :filter, as: 'filter' + property :gl, as: 'gl' + property :google_host, as: 'googleHost' + property :high_range, as: 'highRange' + property :hl, as: 'hl' + property :hq, as: 'hq' + property :img_color_type, as: 'imgColorType' + property :img_dominant_color, as: 'imgDominantColor' + property :img_size, as: 'imgSize' + property :img_type, as: 'imgType' + property :input_encoding, as: 'inputEncoding' + property :language, as: 'language' + property :link_site, as: 'linkSite' + property :low_range, as: 'lowRange' + property :or_terms, as: 'orTerms' + property :output_encoding, as: 'outputEncoding' + property :related_site, as: 'relatedSite' + property :rights, as: 'rights' + property :safe, as: 'safe' + property :search_terms, as: 'searchTerms' + property :search_type, as: 'searchType' + property :site_search, as: 'siteSearch' + property :site_search_filter, as: 'siteSearchFilter' + property :sort, as: 'sort' + property :start_index, as: 'startIndex' + property :start_page, as: 'startPage' + property :title, as: 'title' + property :total_results, :numeric_string => true, as: 'totalResults' + end + end + + class PreviousPage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :count, as: 'count' + property :cr, as: 'cr' + property :cx, as: 'cx' + property :date_restrict, as: 'dateRestrict' + property :disable_cn_tw_translation, as: 'disableCnTwTranslation' + property :exact_terms, as: 'exactTerms' + property :exclude_terms, as: 'excludeTerms' + property :file_type, as: 'fileType' + property :filter, as: 'filter' + property :gl, as: 'gl' + property :google_host, as: 'googleHost' + property :high_range, as: 'highRange' + property :hl, as: 'hl' + property :hq, as: 'hq' + property :img_color_type, as: 'imgColorType' + property :img_dominant_color, as: 'imgDominantColor' + property :img_size, as: 'imgSize' + property :img_type, as: 'imgType' + property :input_encoding, as: 'inputEncoding' + property :language, as: 'language' + property :link_site, as: 'linkSite' + property :low_range, as: 'lowRange' + property :or_terms, as: 'orTerms' + property :output_encoding, as: 'outputEncoding' + property :related_site, as: 'relatedSite' + property :rights, as: 'rights' + property :safe, as: 'safe' + property :search_terms, as: 'searchTerms' + property :search_type, as: 'searchType' + property :site_search, as: 'siteSearch' + property :site_search_filter, as: 'siteSearchFilter' + property :sort, as: 'sort' + property :start_index, as: 'startIndex' + property :start_page, as: 'startPage' + property :title, as: 'title' + property :total_results, :numeric_string => true, as: 'totalResults' + end + end + + class Request + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :count, as: 'count' + property :cr, as: 'cr' + property :cx, as: 'cx' + property :date_restrict, as: 'dateRestrict' + property :disable_cn_tw_translation, as: 'disableCnTwTranslation' + property :exact_terms, as: 'exactTerms' + property :exclude_terms, as: 'excludeTerms' + property :file_type, as: 'fileType' + property :filter, as: 'filter' + property :gl, as: 'gl' + property :google_host, as: 'googleHost' + property :high_range, as: 'highRange' + property :hl, as: 'hl' + property :hq, as: 'hq' + property :img_color_type, as: 'imgColorType' + property :img_dominant_color, as: 'imgDominantColor' + property :img_size, as: 'imgSize' + property :img_type, as: 'imgType' + property :input_encoding, as: 'inputEncoding' + property :language, as: 'language' + property :link_site, as: 'linkSite' + property :low_range, as: 'lowRange' + property :or_terms, as: 'orTerms' + property :output_encoding, as: 'outputEncoding' + property :related_site, as: 'relatedSite' + property :rights, as: 'rights' + property :safe, as: 'safe' + property :search_terms, as: 'searchTerms' + property :search_type, as: 'searchType' + property :site_search, as: 'siteSearch' + property :site_search_filter, as: 'siteSearchFilter' + property :sort, as: 'sort' + property :start_index, as: 'startIndex' + property :start_page, as: 'startPage' + property :title, as: 'title' + property :total_results, :numeric_string => true, as: 'totalResults' + end + end + end + class SearchInformation # @private class Representation < Google::Apis::Core::JsonRepresentation property :formatted_search_time, as: 'formattedSearchTime' property :formatted_total_results, as: 'formattedTotalResults' property :search_time, as: 'searchTime' - property :total_results, :numeric_string => true, as: 'totalResults' + property :total_results, as: 'totalResults' end end diff --git a/generated/google/apis/customsearch_v1/service.rb b/generated/google/apis/customsearch_v1/service.rb index 6854f9459..dd4c9ae6c 100644 --- a/generated/google/apis/customsearch_v1/service.rb +++ b/generated/google/apis/customsearch_v1/service.rb @@ -20,7 +20,7 @@ require 'google/apis/errors' module Google module Apis module CustomsearchV1 - # CustomSearch API + # Custom Search API # # Searches over a website or collection of websites # @@ -30,7 +30,7 @@ module Google # Customsearch = Google::Apis::CustomsearchV1 # Alias the module # service = Customsearch::CustomsearchService.new # - # @see https://developers.google.com/custom-search/v1/using_rest + # @see https://developers.google.com/custom-search/v1/introduction class CustomsearchService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, @@ -38,103 +38,237 @@ module Google attr_accessor :key # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. attr_accessor :quota_user - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - def initialize - super('https://www.googleapis.com/', 'customsearch/') - @batch_path = 'batch/customsearch/v1' + super('https://customsearch.googleapis.com/', '') + @batch_path = 'batch' end - # Returns metadata about the search performed, metadata about the custom search - # engine used for the search, and the search results. - # @param [String] q - # Query + # Returns metadata about the search performed, metadata about the custom + # search engine used for the search, and the search results. # @param [String] c2coff - # Turns off the translation between zh-CN and zh-TW. + # Enables or disables [Simplified and Traditional Chinese + # Search](https://developers.google.com/custom-search/docs/xml_results# + # chineseSearch). + # The default value for this parameter is 0 (zero), meaning that the feature + # is enabled. Supported values are: + # * `1`: Disabled + # * `0`: Enabled (default) # @param [String] cr - # Country restrict(s). + # Restricts search results to documents originating in a particular country. + # You may use [Boolean + # operators](https://developers.google.com/custom-search/docs/ + # xml_results_appendices#booleanOperators) + # in the cr parameter's value. + # Google Search determines the country of a document by analyzing: + # * the top-level domain (TLD) of the document's URL + # * the geographic location of the Web server's IP address + # See the [Country Parameter + # Values](https://developers.google.com/custom-search/docs/ + # xml_results_appendices#countryCollections) + # page for a list of valid values for this parameter. # @param [String] cx - # The custom search engine ID to scope this search query + # The custom search engine ID to use for this request. # @param [String] date_restrict - # Specifies all search results are from a time period + # Restricts results to URLs based on date. Supported values include: + # * `d[number]`: requests results from the specified number of past days. + # * `w[number]`: requests results from the specified number of past weeks. + # * `m[number]`: requests results from the specified number of past months. + # * `y[number]`: requests results from the specified number of past years. # @param [String] exact_terms - # Identifies a phrase that all documents in the search results must contain + # Identifies a phrase that all documents in the search results must contain. # @param [String] exclude_terms # Identifies a word or phrase that should not appear in any documents in the - # search results + # search results. # @param [String] file_type - # Returns images of a specified type. Some of the allowed values are: bmp, gif, - # png, jpg, svg, pdf, ... + # Restricts results to files of a specified extension. A list of file types + # indexable by Google can be found in Search Console [Help + # Center](https://support.google.com/webmasters/answer/35287). # @param [String] filter # Controls turning on or off the duplicate content filter. + # * See [Automatic + # Filtering](https://developers.google.com/custom-search/docs/xml_results# + # automaticFiltering) + # for more information about Google's search results filters. Note that host + # crowding filtering applies only to multi-site searches. + # * By default, Google applies filtering to all search results to improve the + # quality of those results. + # Acceptable values are: + # * `0`: Turns off duplicate content filter. + # * `1`: Turns on duplicate content filter. # @param [String] gl # Geolocation of end user. + # * The `gl` parameter value is a two-letter country code. The `gl` parameter + # boosts search results whose country of origin matches the parameter value. + # See the [Country + # Codes](https://developers.google.com/custom-search/docs/xml_results_appendices# + # countryCodes) + # page for a list of valid values. + # * Specifying a `gl` parameter value should lead to more relevant results. + # This is particularly true for international customers and, even more + # specifically, for customers in English- speaking countries other than the + # United States. # @param [String] googlehost - # The local Google domain to use to perform the search. + # **Deprecated**. Use the `gl` parameter for a similar effect. + # The local Google domain (for example, google.com, google.de, or + # google.fr) to use to perform the search. # @param [String] high_range - # Creates a range in form as_nlo value..as_nhi value and attempts to append it - # to query + # Specifies the ending value for a search range. + # * Use `lowRange` and `highRange` to append an inclusive search range of + # `lowRange...highRange` to the query. # @param [String] hl # Sets the user interface language. + # * Explicitly setting this parameter improves the performance and the + # quality of your search results. + # * See the [Interface + # Languages](https://developers.google.com/custom-search/docs/xml_results# + # wsInterfaceLanguages) + # section of [Internationalizing Queries and Results + # Presentation](https://developers.google.com/custom-search/docs/xml_results# + # wsInternationalizing) + # for more information, and (Supported Interface + # Languages)[https://developers.google.com/custom-search/docs/ + # xml_results_appendices#interfaceLanguages] + # for a list of supported languages. # @param [String] hq - # Appends the extra query terms to the query. + # Appends the specified query terms to the query, as if they were combined + # with a logical AND operator. # @param [String] img_color_type - # Returns black and white, grayscale, or color images: mono, gray, and color. + # Returns black and white, grayscale, transparent, or color images. + # Acceptable values are: + # * `"color"` + # * `"gray"` + # * `"mono"`: black and white + # * `"trans"`: transparent background # @param [String] img_dominant_color - # Returns images of a specific dominant color: red, orange, yellow, green, teal, - # blue, purple, pink, white, gray, black and brown. + # Returns images of a specific dominant color. Acceptable values are: + # * `"black"` + # * `"blue"` + # * `"brown"` + # * `"gray"` + # * `"green"` + # * `"orange"` + # * `"pink"` + # * `"purple"` + # * `"red"` + # * `"teal"` + # * `"white"` + # * `"yellow"` # @param [String] img_size - # Returns images of a specified size, where size can be one of: icon, small, - # medium, large, xlarge, xxlarge, and huge. + # Returns images of a specified size. Acceptable values are: + # * `"huge"` + # * `"icon"` + # * `"large"` + # * `"medium"` + # * `"small"` + # * `"xlarge"` + # * `"xxlarge"` # @param [String] img_type - # Returns images of a type, which can be one of: clipart, face, lineart, news, - # and photo. + # Returns images of a type. Acceptable values are: + # * `"clipart"` + # * `"face"` + # * `"lineart"` + # * `"stock"` + # * `"photo"` + # * `"animated"` # @param [String] link_site - # Specifies that all search results should contain a link to a particular URL + # Specifies that all search results should contain a link to a particular + # URL. # @param [String] low_range - # Creates a range in form as_nlo value..as_nhi value and attempts to append it - # to query + # Specifies the starting value for a search range. Use `lowRange` and + # `highRange` to append an inclusive search range of `lowRange...highRange` + # to the query. # @param [String] lr - # The language restriction for the search results + # Restricts the search to documents written in a particular language (e.g., + # `lr=lang_ja`). + # Acceptable values are: + # * `"lang_ar"`: Arabic + # * `"lang_bg"`: Bulgarian + # * `"lang_ca"`: Catalan + # * `"lang_cs"`: Czech + # * `"lang_da"`: Danish + # * `"lang_de"`: German + # * `"lang_el"`: Greek + # * `"lang_en"`: English + # * `"lang_es"`: Spanish + # * `"lang_et"`: Estonian + # * `"lang_fi"`: Finnish + # * `"lang_fr"`: French + # * `"lang_hr"`: Croatian + # * `"lang_hu"`: Hungarian + # * `"lang_id"`: Indonesian + # * `"lang_is"`: Icelandic + # * `"lang_it"`: Italian + # * `"lang_iw"`: Hebrew + # * `"lang_ja"`: Japanese + # * `"lang_ko"`: Korean + # * `"lang_lt"`: Lithuanian + # * `"lang_lv"`: Latvian + # * `"lang_nl"`: Dutch + # * `"lang_no"`: Norwegian + # * `"lang_pl"`: Polish + # * `"lang_pt"`: Portuguese + # * `"lang_ro"`: Romanian + # * `"lang_ru"`: Russian + # * `"lang_sk"`: Slovak + # * `"lang_sl"`: Slovenian + # * `"lang_sr"`: Serbian + # * `"lang_sv"`: Swedish + # * `"lang_tr"`: Turkish + # * `"lang_zh-CN"`: Chinese (Simplified) + # * `"lang_zh-TW"`: Chinese (Traditional) # @param [Fixnum] num - # Number of search results to return + # Number of search results to return. + # * Valid values are integers between 1 and 10, inclusive. # @param [String] or_terms # Provides additional search terms to check for in a document, where each # document in the search results must contain at least one of the additional - # search terms + # search terms. + # @param [String] q + # Query # @param [String] related_site # Specifies that all search results should be pages that are related to the - # specified URL + # specified URL. # @param [String] rights - # Filters based on licensing. Supported values include: cc_publicdomain, - # cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations - # of these. + # Filters based on licensing. Supported values include: `cc_publicdomain`, + # `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and + # combinations of these. See [typical + # combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration). # @param [String] safe - # Search safety level + # Search safety level. Acceptable values are: + # * `"active"`: Enables SafeSearch filtering. + # * `"off"`: Disables SafeSearch filtering. (default) # @param [String] search_type - # Specifies the search type: image. + # Specifies the search type: `image`. If unspecified, results are limited to + # webpages. + # Acceptable values are: + # * `"image"`: custom image search. # @param [String] site_search - # Specifies all search results should be pages from a given site + # Specifies a given site which should always be included or excluded from + # results (see `siteSearchFilter` parameter, below). # @param [String] site_search_filter # Controls whether to include or exclude results from the site named in the - # as_sitesearch parameter + # `siteSearch` parameter. + # Acceptable values are: + # * `"e"`: exclude + # * `"i"`: include # @param [String] sort - # The sort expression to apply to the results + # The sort expression to apply to the results. # @param [Fixnum] start - # The index of the first result to return + # The index of the first result to return. The default number of results per + # page is 10, so `&start=11` would start at the top of the second page of + # results. **Note**: The JSON API will never return more than 100 results, + # even if more than 100 documents match the query, so setting the sum of + # `start + num` to a number greater than 100 will produce an error. Also note + # that the maximum value for `num` is 10. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -147,8 +281,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_cses(q, c2coff: nil, cr: nil, cx: nil, date_restrict: nil, exact_terms: nil, exclude_terms: nil, file_type: nil, filter: nil, gl: nil, googlehost: nil, high_range: nil, hl: nil, hq: nil, img_color_type: nil, img_dominant_color: nil, img_size: nil, img_type: nil, link_site: nil, low_range: nil, lr: nil, num: nil, or_terms: nil, related_site: nil, rights: nil, safe: nil, search_type: nil, site_search: nil, site_search_filter: nil, sort: nil, start: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'v1', options) + def list_cses(c2coff: nil, cr: nil, cx: nil, date_restrict: nil, exact_terms: nil, exclude_terms: nil, file_type: nil, filter: nil, gl: nil, googlehost: nil, high_range: nil, hl: nil, hq: nil, img_color_type: nil, img_dominant_color: nil, img_size: nil, img_type: nil, link_site: nil, low_range: nil, lr: nil, num: nil, or_terms: nil, q: nil, related_site: nil, rights: nil, safe: nil, search_type: nil, site_search: nil, site_search_filter: nil, sort: nil, start: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'customsearch/v1', options) command.response_representation = Google::Apis::CustomsearchV1::Search::Representation command.response_class = Google::Apis::CustomsearchV1::Search command.query['c2coff'] = c2coff unless c2coff.nil? @@ -184,95 +318,232 @@ module Google command.query['start'] = start unless start.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Returns metadata about the search performed, metadata about the custom search - # engine used for the search, and the search results. Uses a small set of url - # patterns. - # @param [String] q - # Query + # Returns metadata about the search performed, metadata about the custom + # search engine used for the search, and the search results. Uses a small set + # of url patterns. # @param [String] c2coff - # Turns off the translation between zh-CN and zh-TW. + # Enables or disables [Simplified and Traditional Chinese + # Search](https://developers.google.com/custom-search/docs/xml_results# + # chineseSearch). + # The default value for this parameter is 0 (zero), meaning that the feature + # is enabled. Supported values are: + # * `1`: Disabled + # * `0`: Enabled (default) # @param [String] cr - # Country restrict(s). + # Restricts search results to documents originating in a particular country. + # You may use [Boolean + # operators](https://developers.google.com/custom-search/docs/ + # xml_results_appendices#booleanOperators) + # in the cr parameter's value. + # Google Search determines the country of a document by analyzing: + # * the top-level domain (TLD) of the document's URL + # * the geographic location of the Web server's IP address + # See the [Country Parameter + # Values](https://developers.google.com/custom-search/docs/ + # xml_results_appendices#countryCollections) + # page for a list of valid values for this parameter. # @param [String] cx - # The custom search engine ID to scope this search query + # The custom search engine ID to use for this request. # @param [String] date_restrict - # Specifies all search results are from a time period + # Restricts results to URLs based on date. Supported values include: + # * `d[number]`: requests results from the specified number of past days. + # * `w[number]`: requests results from the specified number of past weeks. + # * `m[number]`: requests results from the specified number of past months. + # * `y[number]`: requests results from the specified number of past years. # @param [String] exact_terms - # Identifies a phrase that all documents in the search results must contain + # Identifies a phrase that all documents in the search results must contain. # @param [String] exclude_terms # Identifies a word or phrase that should not appear in any documents in the - # search results + # search results. # @param [String] file_type - # Returns images of a specified type. Some of the allowed values are: bmp, gif, - # png, jpg, svg, pdf, ... + # Restricts results to files of a specified extension. A list of file types + # indexable by Google can be found in Search Console [Help + # Center](https://support.google.com/webmasters/answer/35287). # @param [String] filter # Controls turning on or off the duplicate content filter. + # * See [Automatic + # Filtering](https://developers.google.com/custom-search/docs/xml_results# + # automaticFiltering) + # for more information about Google's search results filters. Note that host + # crowding filtering applies only to multi-site searches. + # * By default, Google applies filtering to all search results to improve the + # quality of those results. + # Acceptable values are: + # * `0`: Turns off duplicate content filter. + # * `1`: Turns on duplicate content filter. # @param [String] gl # Geolocation of end user. + # * The `gl` parameter value is a two-letter country code. The `gl` parameter + # boosts search results whose country of origin matches the parameter value. + # See the [Country + # Codes](https://developers.google.com/custom-search/docs/xml_results_appendices# + # countryCodes) + # page for a list of valid values. + # * Specifying a `gl` parameter value should lead to more relevant results. + # This is particularly true for international customers and, even more + # specifically, for customers in English- speaking countries other than the + # United States. # @param [String] googlehost - # The local Google domain to use to perform the search. + # **Deprecated**. Use the `gl` parameter for a similar effect. + # The local Google domain (for example, google.com, google.de, or + # google.fr) to use to perform the search. # @param [String] high_range - # Creates a range in form as_nlo value..as_nhi value and attempts to append it - # to query + # Specifies the ending value for a search range. + # * Use `lowRange` and `highRange` to append an inclusive search range of + # `lowRange...highRange` to the query. # @param [String] hl # Sets the user interface language. + # * Explicitly setting this parameter improves the performance and the + # quality of your search results. + # * See the [Interface + # Languages](https://developers.google.com/custom-search/docs/xml_results# + # wsInterfaceLanguages) + # section of [Internationalizing Queries and Results + # Presentation](https://developers.google.com/custom-search/docs/xml_results# + # wsInternationalizing) + # for more information, and (Supported Interface + # Languages)[https://developers.google.com/custom-search/docs/ + # xml_results_appendices#interfaceLanguages] + # for a list of supported languages. # @param [String] hq - # Appends the extra query terms to the query. + # Appends the specified query terms to the query, as if they were combined + # with a logical AND operator. # @param [String] img_color_type - # Returns black and white, grayscale, or color images: mono, gray, and color. + # Returns black and white, grayscale, transparent, or color images. + # Acceptable values are: + # * `"color"` + # * `"gray"` + # * `"mono"`: black and white + # * `"trans"`: transparent background # @param [String] img_dominant_color - # Returns images of a specific dominant color: red, orange, yellow, green, teal, - # blue, purple, pink, white, gray, black and brown. + # Returns images of a specific dominant color. Acceptable values are: + # * `"black"` + # * `"blue"` + # * `"brown"` + # * `"gray"` + # * `"green"` + # * `"orange"` + # * `"pink"` + # * `"purple"` + # * `"red"` + # * `"teal"` + # * `"white"` + # * `"yellow"` # @param [String] img_size - # Returns images of a specified size, where size can be one of: icon, small, - # medium, large, xlarge, xxlarge, and huge. + # Returns images of a specified size. Acceptable values are: + # * `"huge"` + # * `"icon"` + # * `"large"` + # * `"medium"` + # * `"small"` + # * `"xlarge"` + # * `"xxlarge"` # @param [String] img_type - # Returns images of a type, which can be one of: clipart, face, lineart, news, - # and photo. + # Returns images of a type. Acceptable values are: + # * `"clipart"` + # * `"face"` + # * `"lineart"` + # * `"stock"` + # * `"photo"` + # * `"animated"` # @param [String] link_site - # Specifies that all search results should contain a link to a particular URL + # Specifies that all search results should contain a link to a particular + # URL. # @param [String] low_range - # Creates a range in form as_nlo value..as_nhi value and attempts to append it - # to query + # Specifies the starting value for a search range. Use `lowRange` and + # `highRange` to append an inclusive search range of `lowRange...highRange` + # to the query. # @param [String] lr - # The language restriction for the search results + # Restricts the search to documents written in a particular language (e.g., + # `lr=lang_ja`). + # Acceptable values are: + # * `"lang_ar"`: Arabic + # * `"lang_bg"`: Bulgarian + # * `"lang_ca"`: Catalan + # * `"lang_cs"`: Czech + # * `"lang_da"`: Danish + # * `"lang_de"`: German + # * `"lang_el"`: Greek + # * `"lang_en"`: English + # * `"lang_es"`: Spanish + # * `"lang_et"`: Estonian + # * `"lang_fi"`: Finnish + # * `"lang_fr"`: French + # * `"lang_hr"`: Croatian + # * `"lang_hu"`: Hungarian + # * `"lang_id"`: Indonesian + # * `"lang_is"`: Icelandic + # * `"lang_it"`: Italian + # * `"lang_iw"`: Hebrew + # * `"lang_ja"`: Japanese + # * `"lang_ko"`: Korean + # * `"lang_lt"`: Lithuanian + # * `"lang_lv"`: Latvian + # * `"lang_nl"`: Dutch + # * `"lang_no"`: Norwegian + # * `"lang_pl"`: Polish + # * `"lang_pt"`: Portuguese + # * `"lang_ro"`: Romanian + # * `"lang_ru"`: Russian + # * `"lang_sk"`: Slovak + # * `"lang_sl"`: Slovenian + # * `"lang_sr"`: Serbian + # * `"lang_sv"`: Swedish + # * `"lang_tr"`: Turkish + # * `"lang_zh-CN"`: Chinese (Simplified) + # * `"lang_zh-TW"`: Chinese (Traditional) # @param [Fixnum] num - # Number of search results to return + # Number of search results to return. + # * Valid values are integers between 1 and 10, inclusive. # @param [String] or_terms # Provides additional search terms to check for in a document, where each # document in the search results must contain at least one of the additional - # search terms + # search terms. + # @param [String] q + # Query # @param [String] related_site # Specifies that all search results should be pages that are related to the - # specified URL + # specified URL. # @param [String] rights - # Filters based on licensing. Supported values include: cc_publicdomain, - # cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations - # of these. + # Filters based on licensing. Supported values include: `cc_publicdomain`, + # `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and + # combinations of these. See [typical + # combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration). # @param [String] safe - # Search safety level + # Search safety level. Acceptable values are: + # * `"active"`: Enables SafeSearch filtering. + # * `"off"`: Disables SafeSearch filtering. (default) # @param [String] search_type - # Specifies the search type: image. + # Specifies the search type: `image`. If unspecified, results are limited to + # webpages. + # Acceptable values are: + # * `"image"`: custom image search. # @param [String] site_search - # Specifies all search results should be pages from a given site + # Specifies a given site which should always be included or excluded from + # results (see `siteSearchFilter` parameter, below). # @param [String] site_search_filter # Controls whether to include or exclude results from the site named in the - # as_sitesearch parameter + # `siteSearch` parameter. + # Acceptable values are: + # * `"e"`: exclude + # * `"i"`: include # @param [String] sort - # The sort expression to apply to the results + # The sort expression to apply to the results. # @param [Fixnum] start - # The index of the first result to return + # The index of the first result to return. The default number of results per + # page is 10, so `&start=11` would start at the top of the second page of + # results. **Note**: The JSON API will never return more than 100 results, + # even if more than 100 documents match the query, so setting the sum of + # `start + num` to a number greater than 100 will produce an error. Also note + # that the maximum value for `num` is 10. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -285,8 +556,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_cse_siterestricts(q, c2coff: nil, cr: nil, cx: nil, date_restrict: nil, exact_terms: nil, exclude_terms: nil, file_type: nil, filter: nil, gl: nil, googlehost: nil, high_range: nil, hl: nil, hq: nil, img_color_type: nil, img_dominant_color: nil, img_size: nil, img_type: nil, link_site: nil, low_range: nil, lr: nil, num: nil, or_terms: nil, related_site: nil, rights: nil, safe: nil, search_type: nil, site_search: nil, site_search_filter: nil, sort: nil, start: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/siterestrict', options) + def list_cse_siterestricts(c2coff: nil, cr: nil, cx: nil, date_restrict: nil, exact_terms: nil, exclude_terms: nil, file_type: nil, filter: nil, gl: nil, googlehost: nil, high_range: nil, hl: nil, hq: nil, img_color_type: nil, img_dominant_color: nil, img_size: nil, img_type: nil, link_site: nil, low_range: nil, lr: nil, num: nil, or_terms: nil, q: nil, related_site: nil, rights: nil, safe: nil, search_type: nil, site_search: nil, site_search_filter: nil, sort: nil, start: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'customsearch/v1/siterestrict', options) command.response_representation = Google::Apis::CustomsearchV1::Search::Representation command.response_class = Google::Apis::CustomsearchV1::Search command.query['c2coff'] = c2coff unless c2coff.nil? @@ -322,7 +593,6 @@ module Google command.query['start'] = start unless start.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -331,7 +601,6 @@ module Google def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? end end end diff --git a/generated/google/apis/datacatalog_v1beta1.rb b/generated/google/apis/datacatalog_v1beta1.rb index 1531c5362..76697efcf 100644 --- a/generated/google/apis/datacatalog_v1beta1.rb +++ b/generated/google/apis/datacatalog_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/data-catalog/docs/ module DatacatalogV1beta1 VERSION = 'V1beta1' - REVISION = '20200302' + REVISION = '20200402' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/datacatalog_v1beta1/classes.rb b/generated/google/apis/datacatalog_v1beta1/classes.rb index 1abe9de90..4837ae11b 100644 --- a/generated/google/apis/datacatalog_v1beta1/classes.rb +++ b/generated/google/apis/datacatalog_v1beta1/classes.rb @@ -351,7 +351,7 @@ module Google # Entry Metadata. # A Data Catalog Entry resource represents another resource in Google - # Cloud Platform (such as a BigQuery dataset or a Cloud Pub/Sub topic), or + # Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic), or # outside of Google Cloud Platform. Clients can use the `linked_resource` field # in the Entry resource to refer to the original resource ID of the source # system. @@ -393,7 +393,7 @@ module Google attr_accessor :gcs_fileset_spec # Output only. This field indicates the entry's source system that Data Catalog - # integrates with, such as BigQuery or Cloud Pub/Sub. + # integrates with, such as BigQuery or Pub/Sub. # Corresponds to the JSON property `integratedSystem` # @return [String] attr_accessor :integrated_system diff --git a/generated/google/apis/datacatalog_v1beta1/service.rb b/generated/google/apis/datacatalog_v1beta1/service.rb index 18929d58d..82fb9c6bc 100644 --- a/generated/google/apis/datacatalog_v1beta1/service.rb +++ b/generated/google/apis/datacatalog_v1beta1/service.rb @@ -262,9 +262,8 @@ module Google # - Tag templates. # - Entries. # - Entry groups. - # Note, this method cannot be used to manage policies for BigQuery, Cloud - # Pub/Sub and any external Google Cloud Platform resources synced to Cloud - # Data Catalog. + # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub + # and any external Google Cloud Platform resources synced to Data Catalog. # Callers must have following Google IAM permission # - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag # templates. @@ -395,9 +394,8 @@ module Google # - Tag templates. # - Entries. # - Entry groups. - # Note, this method cannot be used to manage policies for BigQuery, Cloud - # Pub/Sub and any external Google Cloud Platform resources synced to Cloud - # Data Catalog. + # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub + # and any external Google Cloud Platform resources synced to Data Catalog. # Callers must have following Google IAM permission # - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag # templates. @@ -443,9 +441,8 @@ module Google # - Tag templates. # - Entries. # - Entry groups. - # Note, this method cannot be used to manage policies for BigQuery, Cloud - # Pub/Sub and any external Google Cloud Platform resources synced to Cloud - # Data Catalog. + # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub + # and any external Google Cloud Platform resources synced to Data Catalog. # A caller is not required to have Google IAM permission to make this # request. # @param [String] resource @@ -601,9 +598,8 @@ module Google # - Tag templates. # - Entries. # - Entry groups. - # Note, this method cannot be used to manage policies for BigQuery, Cloud - # Pub/Sub and any external Google Cloud Platform resources synced to Cloud - # Data Catalog. + # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub + # and any external Google Cloud Platform resources synced to Data Catalog. # Callers must have following Google IAM permission # - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag # templates. @@ -756,9 +752,8 @@ module Google # - Tag templates. # - Entries. # - Entry groups. - # Note, this method cannot be used to manage policies for BigQuery, Cloud - # Pub/Sub and any external Google Cloud Platform resources synced to Cloud - # Data Catalog. + # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub + # and any external Google Cloud Platform resources synced to Data Catalog. # A caller is not required to have Google IAM permission to make this # request. # @param [String] resource @@ -1242,9 +1237,8 @@ module Google # - Tag templates. # - Entries. # - Entry groups. - # Note, this method cannot be used to manage policies for BigQuery, Cloud - # Pub/Sub and any external Google Cloud Platform resources synced to Cloud - # Data Catalog. + # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub + # and any external Google Cloud Platform resources synced to Data Catalog. # Callers must have following Google IAM permission # - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag # templates. @@ -1336,9 +1330,8 @@ module Google # - Tag templates. # - Entries. # - Entry groups. - # Note, this method cannot be used to manage policies for BigQuery, Cloud - # Pub/Sub and any external Google Cloud Platform resources synced to Cloud - # Data Catalog. + # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub + # and any external Google Cloud Platform resources synced to Data Catalog. # Callers must have following Google IAM permission # - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag # templates. @@ -1384,9 +1377,8 @@ module Google # - Tag templates. # - Entries. # - Entry groups. - # Note, this method cannot be used to manage policies for BigQuery, Cloud - # Pub/Sub and any external Google Cloud Platform resources synced to Cloud - # Data Catalog. + # Note, this method cannot be used to manage policies for BigQuery, Pub/Sub + # and any external Google Cloud Platform resources synced to Data Catalog. # A caller is not required to have Google IAM permission to make this # request. # @param [String] resource diff --git a/generated/google/apis/dataflow_v1b3.rb b/generated/google/apis/dataflow_v1b3.rb index 2f9536439..b399cf59e 100644 --- a/generated/google/apis/dataflow_v1b3.rb +++ b/generated/google/apis/dataflow_v1b3.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/dataflow module DataflowV1b3 VERSION = 'V1b3' - REVISION = '20200215' + REVISION = '20200305' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dataflow_v1b3/classes.rb b/generated/google/apis/dataflow_v1b3/classes.rb index 0586d2ddc..007b41108 100644 --- a/generated/google/apis/dataflow_v1b3/classes.rb +++ b/generated/google/apis/dataflow_v1b3/classes.rb @@ -867,6 +867,19 @@ module Google end end + # Response from deleting a snapshot. + class DeleteSnapshotResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # Specification of one of the bundles produced as a result of splitting # a Source (e.g. when executing a SourceSplitRequest, or when # splitting an active task using WorkItemStatus.dynamic_source_split), @@ -2541,6 +2554,25 @@ module Google end end + # List of snapshots. + class ListSnapshotsResponse + include Google::Apis::Core::Hashable + + # Returned snapshots. + # Corresponds to the JSON property `snapshots` + # @return [Array] + attr_accessor :snapshots + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @snapshots = args[:snapshots] if args.key?(:snapshots) + end + end + # MapTask consists of an ordered set of instructions, each of which # describes one particular low-level operation for the worker to # perform in order to accomplish the MapTask's WorkItem. @@ -2585,6 +2617,44 @@ module Google end end + # Information about the memory usage of a worker or a container within a + # worker. + class MemInfo + include Google::Apis::Core::Hashable + + # Instantenous memory limit in bytes. + # Corresponds to the JSON property `currentLimitBytes` + # @return [Fixnum] + attr_accessor :current_limit_bytes + + # Instantenous memory (RSS) size in bytes. + # Corresponds to the JSON property `currentRssBytes` + # @return [Fixnum] + attr_accessor :current_rss_bytes + + # Timestamp of the measurement. + # Corresponds to the JSON property `timestamp` + # @return [String] + attr_accessor :timestamp + + # Total memory (RSS) usage since start up in GB * ms. + # Corresponds to the JSON property `totalGbMs` + # @return [Fixnum] + attr_accessor :total_gb_ms + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @current_limit_bytes = args[:current_limit_bytes] if args.key?(:current_limit_bytes) + @current_rss_bytes = args[:current_rss_bytes] if args.key?(:current_rss_bytes) + @timestamp = args[:timestamp] if args.key?(:timestamp) + @total_gb_ms = args[:total_gb_ms] if args.key?(:total_gb_ms) + end + end + # The metric short id is returned to the user alongside an offset into # ReportWorkItemStatusRequest class MetricShortId @@ -3281,6 +3351,37 @@ module Google end end + # Represents a Pubsub snapshot. + class PubsubSnapshotMetadata + include Google::Apis::Core::Hashable + + # The expire time of the Pubsub snapshot. + # Corresponds to the JSON property `expireTime` + # @return [String] + attr_accessor :expire_time + + # The name of the Pubsub snapshot. + # Corresponds to the JSON property `snapshotName` + # @return [String] + attr_accessor :snapshot_name + + # The name of the Pubsub topic. + # Corresponds to the JSON property `topicName` + # @return [String] + attr_accessor :topic_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @expire_time = args[:expire_time] if args.key?(:expire_time) + @snapshot_name = args[:snapshot_name] if args.key?(:snapshot_name) + @topic_name = args[:topic_name] if args.key?(:topic_name) + end + end + # An instruction that reads records. # Takes no inputs, produces one output. class ReadInstruction @@ -3417,18 +3518,31 @@ module Google class ResourceUtilizationReport include Google::Apis::Core::Hashable + # Per container information. + # Key: container name. + # Corresponds to the JSON property `containers` + # @return [Hash] + attr_accessor :containers + # CPU utilization samples. # Corresponds to the JSON property `cpuTime` # @return [Array] attr_accessor :cpu_time + # Memory utilization samples. + # Corresponds to the JSON property `memoryInfo` + # @return [Array] + attr_accessor :memory_info + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @containers = args[:containers] if args.key?(:containers) @cpu_time = args[:cpu_time] if args.key?(:cpu_time) + @memory_info = args[:memory_info] if args.key?(:memory_info) end end @@ -3944,6 +4058,112 @@ module Google end end + # Represents a snapshot of a job. + class Snapshot + include Google::Apis::Core::Hashable + + # The time this snapshot was created. + # Corresponds to the JSON property `creationTime` + # @return [String] + attr_accessor :creation_time + + # User specified description of the snapshot. Maybe empty. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The disk byte size of the snapshot. Only available for snapshots in READY + # state. + # Corresponds to the JSON property `diskSizeBytes` + # @return [Fixnum] + attr_accessor :disk_size_bytes + + # The unique ID of this snapshot. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # The project this snapshot belongs to. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + # PubSub snapshot metadata. + # Corresponds to the JSON property `pubsubMetadata` + # @return [Array] + attr_accessor :pubsub_metadata + + # The job this snapshot was created from. + # Corresponds to the JSON property `sourceJobId` + # @return [String] + attr_accessor :source_job_id + + # State of the snapshot. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # The time after which this snapshot will be automatically deleted. + # Corresponds to the JSON property `ttl` + # @return [String] + attr_accessor :ttl + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creation_time = args[:creation_time] if args.key?(:creation_time) + @description = args[:description] if args.key?(:description) + @disk_size_bytes = args[:disk_size_bytes] if args.key?(:disk_size_bytes) + @id = args[:id] if args.key?(:id) + @project_id = args[:project_id] if args.key?(:project_id) + @pubsub_metadata = args[:pubsub_metadata] if args.key?(:pubsub_metadata) + @source_job_id = args[:source_job_id] if args.key?(:source_job_id) + @state = args[:state] if args.key?(:state) + @ttl = args[:ttl] if args.key?(:ttl) + end + end + + # Request to create a snapshot of a job. + class SnapshotJobRequest + include Google::Apis::Core::Hashable + + # User specified description of the snapshot. Maybe empty. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The location that contains this job. + # Corresponds to the JSON property `location` + # @return [String] + attr_accessor :location + + # If true, perform snapshots for sources which support this. + # Corresponds to the JSON property `snapshotSources` + # @return [Boolean] + attr_accessor :snapshot_sources + alias_method :snapshot_sources?, :snapshot_sources + + # TTL for the snapshot. + # Corresponds to the JSON property `ttl` + # @return [String] + attr_accessor :ttl + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @location = args[:location] if args.key?(:location) + @snapshot_sources = args[:snapshot_sources] if args.key?(:snapshot_sources) + @ttl = args[:ttl] if args.key?(:ttl) + end + end + # A source that records can be read and decoded from. class Source include Google::Apis::Core::Hashable diff --git a/generated/google/apis/dataflow_v1b3/representations.rb b/generated/google/apis/dataflow_v1b3/representations.rb index f0652a0cc..96d515303 100644 --- a/generated/google/apis/dataflow_v1b3/representations.rb +++ b/generated/google/apis/dataflow_v1b3/representations.rb @@ -148,6 +148,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class DeleteSnapshotResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class DerivedSource class Representation < Google::Apis::Core::JsonRepresentation; end @@ -388,12 +394,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ListSnapshotsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class MapTask class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class MemInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class MetricShortId class Representation < Google::Apis::Core::JsonRepresentation; end @@ -490,6 +508,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class PubsubSnapshotMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ReadInstruction class Representation < Google::Apis::Core::JsonRepresentation; end @@ -610,6 +634,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Snapshot + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SnapshotJobRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Source class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1130,6 +1166,12 @@ module Google end end + class DeleteSnapshotResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class DerivedSource # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1573,6 +1615,14 @@ module Google end end + class ListSnapshotsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :snapshots, as: 'snapshots', class: Google::Apis::DataflowV1b3::Snapshot, decorator: Google::Apis::DataflowV1b3::Snapshot::Representation + + end + end + class MapTask # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1584,6 +1634,16 @@ module Google end end + class MemInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :current_limit_bytes, :numeric_string => true, as: 'currentLimitBytes' + property :current_rss_bytes, :numeric_string => true, as: 'currentRssBytes' + property :timestamp, as: 'timestamp' + property :total_gb_ms, :numeric_string => true, as: 'totalGbMs' + end + end + class MetricShortId # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1764,6 +1824,15 @@ module Google end end + class PubsubSnapshotMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :expire_time, as: 'expireTime' + property :snapshot_name, as: 'snapshotName' + property :topic_name, as: 'topicName' + end + end + class ReadInstruction # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1804,8 +1873,12 @@ module Google class ResourceUtilizationReport # @private class Representation < Google::Apis::Core::JsonRepresentation + hash :containers, as: 'containers', class: Google::Apis::DataflowV1b3::ResourceUtilizationReport, decorator: Google::Apis::DataflowV1b3::ResourceUtilizationReport::Representation + collection :cpu_time, as: 'cpuTime', class: Google::Apis::DataflowV1b3::CpuTime, decorator: Google::Apis::DataflowV1b3::CpuTime::Representation + collection :memory_info, as: 'memoryInfo', class: Google::Apis::DataflowV1b3::MemInfo, decorator: Google::Apis::DataflowV1b3::MemInfo::Representation + end end @@ -1953,6 +2026,32 @@ module Google end end + class Snapshot + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :creation_time, as: 'creationTime' + property :description, as: 'description' + property :disk_size_bytes, :numeric_string => true, as: 'diskSizeBytes' + property :id, as: 'id' + property :project_id, as: 'projectId' + collection :pubsub_metadata, as: 'pubsubMetadata', class: Google::Apis::DataflowV1b3::PubsubSnapshotMetadata, decorator: Google::Apis::DataflowV1b3::PubsubSnapshotMetadata::Representation + + property :source_job_id, as: 'sourceJobId' + property :state, as: 'state' + property :ttl, as: 'ttl' + end + end + + class SnapshotJobRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :location, as: 'location' + property :snapshot_sources, as: 'snapshotSources' + property :ttl, as: 'ttl' + end + end + class Source # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/dataflow_v1b3/service.rb b/generated/google/apis/dataflow_v1b3/service.rb index 44e602938..e16a26d99 100644 --- a/generated/google/apis/dataflow_v1b3/service.rb +++ b/generated/google/apis/dataflow_v1b3/service.rb @@ -47,6 +47,42 @@ module Google @batch_path = 'batch' end + # Deletes a snapshot. + # @param [String] project_id + # The ID of the Cloud Platform project that the snapshot belongs to. + # @param [String] location + # The location that contains this snapshot. + # @param [String] snapshot_id + # The ID of the snapshot. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DataflowV1b3::DeleteSnapshotResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DataflowV1b3::DeleteSnapshotResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_snapshots(project_id, location: nil, snapshot_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1b3/projects/{projectId}/snapshots', options) + command.response_representation = Google::Apis::DataflowV1b3::DeleteSnapshotResponse::Representation + command.response_class = Google::Apis::DataflowV1b3::DeleteSnapshotResponse + command.params['projectId'] = project_id unless project_id.nil? + command.query['location'] = location unless location.nil? + command.query['snapshotId'] = snapshot_id unless snapshot_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Send a worker_message to the service. # @param [String] project_id # The project to send the WorkerMessages to. @@ -328,6 +364,42 @@ module Google execute_or_queue_command(command, &block) end + # Snapshot the state of a streaming job. + # @param [String] project_id + # The project which owns the job to be snapshotted. + # @param [String] job_id + # The job to be snapshotted. + # @param [Google::Apis::DataflowV1b3::SnapshotJobRequest] snapshot_job_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DataflowV1b3::Snapshot] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DataflowV1b3::Snapshot] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def snapshot_project_job(project_id, job_id, snapshot_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}:snapshot', options) + command.request_representation = Google::Apis::DataflowV1b3::SnapshotJobRequest::Representation + command.request_object = snapshot_job_request_object + command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation + command.response_class = Google::Apis::DataflowV1b3::Snapshot + command.params['projectId'] = project_id unless project_id.nil? + command.params['jobId'] = job_id unless job_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Updates the state of an existing Cloud Dataflow job. # To update the state of an existing job, we recommend using # `projects.locations.jobs.update` with a [regional endpoint] @@ -856,6 +928,45 @@ module Google execute_or_queue_command(command, &block) end + # Snapshot the state of a streaming job. + # @param [String] project_id + # The project which owns the job to be snapshotted. + # @param [String] location + # The location that contains this job. + # @param [String] job_id + # The job to be snapshotted. + # @param [Google::Apis::DataflowV1b3::SnapshotJobRequest] snapshot_job_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DataflowV1b3::Snapshot] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DataflowV1b3::Snapshot] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def snapshot_project_location_job(project_id, location, job_id, snapshot_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}:snapshot', options) + command.request_representation = Google::Apis::DataflowV1b3::SnapshotJobRequest::Representation + command.request_object = snapshot_job_request_object + command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation + command.response_class = Google::Apis::DataflowV1b3::Snapshot + command.params['projectId'] = project_id unless project_id.nil? + command.params['location'] = location unless location.nil? + command.params['jobId'] = job_id unless job_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Updates the state of an existing Cloud Dataflow job. # To update the state of an existing job, we recommend using # `projects.locations.jobs.update` with a [regional endpoint] @@ -1048,6 +1159,42 @@ module Google execute_or_queue_command(command, &block) end + # Lists snapshots. + # @param [String] project_id + # The project ID to list snapshots for. + # @param [String] location + # The location to list snapshots in. + # @param [String] job_id + # If specified, list snapshots created from this job. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DataflowV1b3::ListSnapshotsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DataflowV1b3::ListSnapshotsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_job_snapshots(project_id, location, job_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/snapshots', options) + command.response_representation = Google::Apis::DataflowV1b3::ListSnapshotsResponse::Representation + command.response_class = Google::Apis::DataflowV1b3::ListSnapshotsResponse + command.params['projectId'] = project_id unless project_id.nil? + command.params['location'] = location unless location.nil? + command.params['jobId'] = job_id unless job_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Leases a dataflow WorkItem to run. # @param [String] project_id # Identifies the project this worker belongs to. @@ -1130,6 +1277,114 @@ module Google execute_or_queue_command(command, &block) end + # Deletes a snapshot. + # @param [String] project_id + # The ID of the Cloud Platform project that the snapshot belongs to. + # @param [String] location + # The location that contains this snapshot. + # @param [String] snapshot_id + # The ID of the snapshot. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DataflowV1b3::DeleteSnapshotResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DataflowV1b3::DeleteSnapshotResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_snapshot(project_id, location, snapshot_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}', options) + command.response_representation = Google::Apis::DataflowV1b3::DeleteSnapshotResponse::Representation + command.response_class = Google::Apis::DataflowV1b3::DeleteSnapshotResponse + command.params['projectId'] = project_id unless project_id.nil? + command.params['location'] = location unless location.nil? + command.params['snapshotId'] = snapshot_id unless snapshot_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets information about a snapshot. + # @param [String] project_id + # The ID of the Cloud Platform project that the snapshot belongs to. + # @param [String] location + # The location that contains this snapshot. + # @param [String] snapshot_id + # The ID of the snapshot. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DataflowV1b3::Snapshot] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DataflowV1b3::Snapshot] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_snapshot(project_id, location, snapshot_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}', options) + command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation + command.response_class = Google::Apis::DataflowV1b3::Snapshot + command.params['projectId'] = project_id unless project_id.nil? + command.params['location'] = location unless location.nil? + command.params['snapshotId'] = snapshot_id unless snapshot_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists snapshots. + # @param [String] project_id + # The project ID to list snapshots for. + # @param [String] location + # The location to list snapshots in. + # @param [String] job_id + # If specified, list snapshots created from this job. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DataflowV1b3::ListSnapshotsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DataflowV1b3::ListSnapshotsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_snapshots(project_id, location, job_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/snapshots', options) + command.response_representation = Google::Apis::DataflowV1b3::ListSnapshotsResponse::Representation + command.response_class = Google::Apis::DataflowV1b3::ListSnapshotsResponse + command.params['projectId'] = project_id unless project_id.nil? + command.params['location'] = location unless location.nil? + command.query['jobId'] = job_id unless job_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Validates a GoogleSQL query for Cloud Dataflow syntax. Will always # confirm the given query parses correctly, and if able to look up # schema information from DataCatalog, will validate that the query @@ -1307,6 +1562,78 @@ module Google execute_or_queue_command(command, &block) end + # Gets information about a snapshot. + # @param [String] project_id + # The ID of the Cloud Platform project that the snapshot belongs to. + # @param [String] snapshot_id + # The ID of the snapshot. + # @param [String] location + # The location that contains this snapshot. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DataflowV1b3::Snapshot] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DataflowV1b3::Snapshot] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_snapshot(project_id, snapshot_id, location: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1b3/projects/{projectId}/snapshots/{snapshotId}', options) + command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation + command.response_class = Google::Apis::DataflowV1b3::Snapshot + command.params['projectId'] = project_id unless project_id.nil? + command.params['snapshotId'] = snapshot_id unless snapshot_id.nil? + command.query['location'] = location unless location.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists snapshots. + # @param [String] project_id + # The project ID to list snapshots for. + # @param [String] job_id + # If specified, list snapshots created from this job. + # @param [String] location + # The location to list snapshots in. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DataflowV1b3::ListSnapshotsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DataflowV1b3::ListSnapshotsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_snapshots(project_id, job_id: nil, location: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1b3/projects/{projectId}/snapshots', options) + command.response_representation = Google::Apis::DataflowV1b3::ListSnapshotsResponse::Representation + command.response_class = Google::Apis::DataflowV1b3::ListSnapshotsResponse + command.params['projectId'] = project_id unless project_id.nil? + command.query['jobId'] = job_id unless job_id.nil? + command.query['location'] = location unless location.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a Cloud Dataflow job from a template. # @param [String] project_id # Required. The ID of the Cloud Platform project that the job belongs to. diff --git a/generated/google/apis/datafusion_v1beta1.rb b/generated/google/apis/datafusion_v1beta1.rb index 930d87f3c..8c8c70235 100644 --- a/generated/google/apis/datafusion_v1beta1.rb +++ b/generated/google/apis/datafusion_v1beta1.rb @@ -34,7 +34,7 @@ module Google # @see https://cloud.google.com/data-fusion/docs module DatafusionV1beta1 VERSION = 'V1beta1' - REVISION = '20200122' + REVISION = '20200311' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/datafusion_v1beta1/classes.rb b/generated/google/apis/datafusion_v1beta1/classes.rb index 7ea87a376..69b5d72cc 100644 --- a/generated/google/apis/datafusion_v1beta1/classes.rb +++ b/generated/google/apis/datafusion_v1beta1/classes.rb @@ -22,6 +22,25 @@ module Google module Apis module DatafusionV1beta1 + # Identifies Data Fusion accelerators for an instance. + class Accelerator + include Google::Apis::Core::Hashable + + # The type of an accelator for a CDF instance. + # Corresponds to the JSON property `acceleratorType` + # @return [String] + attr_accessor :accelerator_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @accelerator_type = args[:accelerator_type] if args.key?(:accelerator_type) + 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. @@ -317,9 +336,15 @@ module Google end # Represents a Data Fusion instance. + # Next available ID: 23 class Instance include Google::Apis::Core::Hashable + # List of accelerators enabled for this CDF instance. + # Corresponds to the JSON property `accelerators` + # @return [Array] + attr_accessor :accelerators + # Output only. Endpoint on which the REST APIs is accessible. # Corresponds to the JSON property `apiEndpoint` # @return [String] @@ -336,7 +361,7 @@ module Google # @return [String] attr_accessor :create_time - # An optional description of this instance. + # Optional. An optional description of this instance. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -449,6 +474,7 @@ module Google # Update properties of this object def update!(**args) + @accelerators = args[:accelerators] if args.key?(:accelerators) @api_endpoint = args[:api_endpoint] if args.key?(:api_endpoint) @available_version = args[:available_version] if args.key?(:available_version) @create_time = args[:create_time] if args.key?(:create_time) diff --git a/generated/google/apis/datafusion_v1beta1/representations.rb b/generated/google/apis/datafusion_v1beta1/representations.rb index d27e5324d..050574478 100644 --- a/generated/google/apis/datafusion_v1beta1/representations.rb +++ b/generated/google/apis/datafusion_v1beta1/representations.rb @@ -22,6 +22,12 @@ module Google module Apis module DatafusionV1beta1 + class Accelerator + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class AuditConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -154,6 +160,13 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Accelerator + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :accelerator_type, as: 'acceleratorType' + end + end + class AuditConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -206,6 +219,8 @@ module Google class Instance # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :accelerators, as: 'accelerators', class: Google::Apis::DatafusionV1beta1::Accelerator, decorator: Google::Apis::DatafusionV1beta1::Accelerator::Representation + property :api_endpoint, as: 'apiEndpoint' collection :available_version, as: 'availableVersion', class: Google::Apis::DatafusionV1beta1::Version, decorator: Google::Apis::DatafusionV1beta1::Version::Representation diff --git a/generated/google/apis/dataproc_v1.rb b/generated/google/apis/dataproc_v1.rb index 928d2bc9f..07d64ee3d 100644 --- a/generated/google/apis/dataproc_v1.rb +++ b/generated/google/apis/dataproc_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/dataproc/ module DataprocV1 VERSION = 'V1' - REVISION = '20200220' + REVISION = '20200407' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dataproc_v1/classes.rb b/generated/google/apis/dataproc_v1/classes.rb index 3091cbde7..74ab37bde 100644 --- a/generated/google/apis/dataproc_v1/classes.rb +++ b/generated/google/apis/dataproc_v1/classes.rb @@ -1227,8 +1227,18 @@ module Google # @return [Google::Apis::DataprocV1::DiskConfig] attr_accessor :disk_config - # Optional. The Compute Engine image resource used for cluster instances. It can - # be specified or may be inferred from SoftwareConfig.image_version. + # Optional. The Compute Engine image resource used for cluster instances.The URI + # can represent an image or image family.Image examples: + # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[ + # image-id] + # projects/[project_id]/global/images/[image-id] + # image-idImage family examples. Dataproc will use the most recent image from + # the family: + # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/ + # family/[custom-image-family-name] + # projects/[project_id]/global/images/family/[custom-image-family-name]If the + # URI is unspecified, it will be inferred from SoftwareConfig.image_version or + # the system default. # Corresponds to the JSON property `imageUri` # @return [String] attr_accessor :image_uri @@ -1239,7 +1249,7 @@ module Google # @return [Array] attr_accessor :instance_names - # Optional. Specifies that this instance group contains preemptible instances. + # Output only. Specifies that this instance group contains preemptible instances. # Corresponds to the JSON property `isPreemptible` # @return [Boolean] attr_accessor :is_preemptible @@ -1274,7 +1284,9 @@ module Google # @return [Fixnum] attr_accessor :num_instances - # Optional. Specifies the preemptibility of the instance group. + # Optional. Specifies the preemptibility of the instance group.The default value + # for master and worker groups is NON_PREEMPTIBLE. This default cannot be + # changed.The default value for secondary instances is PREEMPTIBLE. # Corresponds to the JSON property `preemptibility` # @return [String] attr_accessor :preemptibility @@ -1404,7 +1416,9 @@ module Google # @return [Google::Apis::DataprocV1::JobPlacement] attr_accessor :placement - # A Dataproc job for running Presto (https://prestosql.io/) queries + # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: + # The Dataproc Presto Optional Component must be enabled when the cluster is + # created to submit a Presto job to the cluster. # Corresponds to the JSON property `prestoJob` # @return [Google::Apis::DataprocV1::PrestoJob] attr_accessor :presto_job @@ -1488,6 +1502,43 @@ module Google end end + # Job Operation metadata. + class JobMetadata + include Google::Apis::Core::Hashable + + # Output only. The job id. + # Corresponds to the JSON property `jobId` + # @return [String] + attr_accessor :job_id + + # Output only. Operation type. + # Corresponds to the JSON property `operationType` + # @return [String] + attr_accessor :operation_type + + # Output only. Job submission time. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # Dataproc job status. + # Corresponds to the JSON property `status` + # @return [Google::Apis::DataprocV1::JobStatus] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @job_id = args[:job_id] if args.key?(:job_id) + @operation_type = args[:operation_type] if args.key?(:operation_type) + @start_time = args[:start_time] if args.key?(:start_time) + @status = args[:status] if args.key?(:status) + end + end + # Dataproc job config. class JobPlacement include Google::Apis::Core::Hashable @@ -1632,7 +1683,8 @@ module Google # @return [String] attr_accessor :cross_realm_trust_shared_password_uri - # Optional. Flag to indicate whether to Kerberize the cluster. + # Optional. Flag to indicate whether to Kerberize the cluster (default: false). + # Set this field to true to enable Kerberos on a cluster. # Corresponds to the JSON property `enableKerberos` # @return [Boolean] attr_accessor :enable_kerberos @@ -2120,6 +2172,13 @@ module Google # @return [Array] attr_accessor :prerequisite_step_ids + # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: + # The Dataproc Presto Optional Component must be enabled when the cluster is + # created to submit a Presto job to the cluster. + # Corresponds to the JSON property `prestoJob` + # @return [Google::Apis::DataprocV1::PrestoJob] + attr_accessor :presto_job + # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/ # python-programming-guide.html) applications on YARN. # Corresponds to the JSON property `pysparkJob` @@ -2137,6 +2196,12 @@ module Google # @return [Google::Apis::DataprocV1::SparkJob] attr_accessor :spark_job + # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/ + # sparkr.html) applications on YARN. + # Corresponds to the JSON property `sparkRJob` + # @return [Google::Apis::DataprocV1::SparkRJob] + attr_accessor :spark_r_job + # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) # queries. # Corresponds to the JSON property `sparkSqlJob` @@ -2164,9 +2229,11 @@ module Google @labels = args[:labels] if args.key?(:labels) @pig_job = args[:pig_job] if args.key?(:pig_job) @prerequisite_step_ids = args[:prerequisite_step_ids] if args.key?(:prerequisite_step_ids) + @presto_job = args[:presto_job] if args.key?(:presto_job) @pyspark_job = args[:pyspark_job] if args.key?(:pyspark_job) @scheduling = args[:scheduling] if args.key?(:scheduling) @spark_job = args[:spark_job] if args.key?(:spark_job) + @spark_r_job = args[:spark_r_job] if args.key?(:spark_r_job) @spark_sql_job = args[:spark_sql_job] if args.key?(:spark_sql_job) @step_id = args[:step_id] if args.key?(:step_id) end @@ -2368,7 +2435,9 @@ module Google end end - # A Dataproc job for running Presto (https://prestosql.io/) queries + # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: + # The Dataproc Presto Optional Component must be enabled when the cluster is + # created to submit a Presto job to the cluster. class PrestoJob include Google::Apis::Core::Hashable diff --git a/generated/google/apis/dataproc_v1/representations.rb b/generated/google/apis/dataproc_v1/representations.rb index 114a5897a..04e9f9a52 100644 --- a/generated/google/apis/dataproc_v1/representations.rb +++ b/generated/google/apis/dataproc_v1/representations.rb @@ -202,6 +202,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class JobMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class JobPlacement class Representation < Google::Apis::Core::JsonRepresentation; end @@ -811,6 +817,17 @@ module Google end end + class JobMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :job_id, as: 'jobId' + property :operation_type, as: 'operationType' + property :start_time, as: 'startTime' + property :status, as: 'status', class: Google::Apis::DataprocV1::JobStatus, decorator: Google::Apis::DataprocV1::JobStatus::Representation + + end + end + class JobPlacement # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -976,12 +993,16 @@ module Google property :pig_job, as: 'pigJob', class: Google::Apis::DataprocV1::PigJob, decorator: Google::Apis::DataprocV1::PigJob::Representation collection :prerequisite_step_ids, as: 'prerequisiteStepIds' + property :presto_job, as: 'prestoJob', class: Google::Apis::DataprocV1::PrestoJob, decorator: Google::Apis::DataprocV1::PrestoJob::Representation + property :pyspark_job, as: 'pysparkJob', class: Google::Apis::DataprocV1::PySparkJob, decorator: Google::Apis::DataprocV1::PySparkJob::Representation property :scheduling, as: 'scheduling', class: Google::Apis::DataprocV1::JobScheduling, decorator: Google::Apis::DataprocV1::JobScheduling::Representation property :spark_job, as: 'sparkJob', class: Google::Apis::DataprocV1::SparkJob, decorator: Google::Apis::DataprocV1::SparkJob::Representation + property :spark_r_job, as: 'sparkRJob', class: Google::Apis::DataprocV1::SparkRJob, decorator: Google::Apis::DataprocV1::SparkRJob::Representation + property :spark_sql_job, as: 'sparkSqlJob', class: Google::Apis::DataprocV1::SparkSqlJob, decorator: Google::Apis::DataprocV1::SparkSqlJob::Representation property :step_id, as: 'stepId' diff --git a/generated/google/apis/dataproc_v1/service.rb b/generated/google/apis/dataproc_v1/service.rb index dde928f0b..1c25cf881 100644 --- a/generated/google/apis/dataproc_v1/service.rb +++ b/generated/google/apis/dataproc_v1/service.rb @@ -515,8 +515,11 @@ module Google # will complete when entire workflow is finished.The running workflow can be # aborted via operations.cancel. This will cause any inflight jobs to be # cancelled and workflow-owned clusters to be deleted.The Operation.metadata - # will be WorkflowMetadata. Also see Using WorkflowMetadata.On successful - # completion, Operation.response will be Empty. + # will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/ + # google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata ( + # https://cloud.google.com/dataproc/docs/concepts/workflows/debugging# + # using_workflowmetadata).On successful completion, Operation.response will be + # Empty. # @param [String] name # Required. The resource name of the workflow template, as described in https:// # cloud.google.com/apis/design/resource_names. @@ -562,8 +565,11 @@ module Google # of workflow by polling operations.get. The Operation will complete when entire # workflow is finished.The running workflow can be aborted via operations.cancel. # This will cause any inflight jobs to be cancelled and workflow-owned clusters - # to be deleted.The Operation.metadata will be WorkflowMetadata. Also see Using - # WorkflowMetadata.On successful completion, Operation.response will be Empty. + # to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud. + # google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1# + # workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/ + # dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On + # successful completion, Operation.response will be Empty. # @param [String] parent # Required. The resource name of the region or location, as described in https:// # cloud.google.com/apis/design/resource_names. @@ -1074,7 +1080,8 @@ module Google end # Creates a cluster in a project. The returned Operation.metadata will be - # ClusterOperationMetadata. + # ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/ + # google.cloud.dataproc.v1#clusteroperationmetadata). # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the cluster belongs # to. @@ -1121,7 +1128,8 @@ module Google end # Deletes a cluster in a project. The returned Operation.metadata will be - # ClusterOperationMetadata. + # ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/ + # google.cloud.dataproc.v1#clusteroperationmetadata). # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the cluster belongs # to. @@ -1172,8 +1180,11 @@ module Google end # Gets cluster diagnostic information. The returned Operation.metadata will be - # ClusterOperationMetadata. After the operation completes, Operation.response - # contains DiagnoseClusterResults. + # ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/ + # google.cloud.dataproc.v1#clusteroperationmetadata). After the operation + # completes, Operation.response contains DiagnoseClusterResults (https://cloud. + # google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1# + # diagnoseclusterresults). # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the cluster belongs # to. @@ -1285,7 +1296,7 @@ module Google execute_or_queue_command(command, &block) end - # Lists all regions/`region`/clusters in a project. + # Lists all regions/`region`/clusters in a project alphabetically. # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the cluster belongs # to. @@ -1339,7 +1350,8 @@ module Google end # Updates a cluster in a project. The returned Operation.metadata will be - # ClusterOperationMetadata. + # ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/ + # google.cloud.dataproc.v1#clusteroperationmetadata). # @param [String] project_id # Required. The ID of the Google Cloud Platform project the cluster belongs to. # @param [String] region @@ -1504,7 +1516,10 @@ module Google end # Starts a job cancellation request. To access the job resource after - # cancellation, call regions/`region`/jobs.list or regions/`region`/jobs.get. + # cancellation, call regions/`region`/jobs.list (https://cloud.google.com/ + # dataproc/docs/reference/rest/v1/projects.regions.jobs/list) or regions/`region` + # /jobs.get (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects. + # regions.jobs/get). # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the job belongs to. # @param [String] region @@ -1826,6 +1841,42 @@ module Google execute_or_queue_command(command, &block) end + # Submits job to a cluster. + # @param [String] project_id + # Required. The ID of the Google Cloud Platform project that the job belongs to. + # @param [String] region + # Required. The Dataproc region in which to handle the request. + # @param [Google::Apis::DataprocV1::SubmitJobRequest] submit_job_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DataprocV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DataprocV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def submit_project_region_job_as_operation(project_id, region, submit_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/projects/{projectId}/regions/{region}/jobs:submitAsOperation', options) + command.request_representation = Google::Apis::DataprocV1::SubmitJobRequest::Representation + command.request_object = submit_job_request_object + command.response_representation = Google::Apis::DataprocV1::Operation::Representation + command.response_class = Google::Apis::DataprocV1::Operation + command.params['projectId'] = project_id unless project_id.nil? + command.params['region'] = region unless region.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Returns permissions that a caller has on the specified resource. If the # resource does not exist, this will return an empty set of permissions, not a # NOT_FOUND error.Note: This operation is designed to be used for building @@ -2282,8 +2333,11 @@ module Google # will complete when entire workflow is finished.The running workflow can be # aborted via operations.cancel. This will cause any inflight jobs to be # cancelled and workflow-owned clusters to be deleted.The Operation.metadata - # will be WorkflowMetadata. Also see Using WorkflowMetadata.On successful - # completion, Operation.response will be Empty. + # will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/ + # google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata ( + # https://cloud.google.com/dataproc/docs/concepts/workflows/debugging# + # using_workflowmetadata).On successful completion, Operation.response will be + # Empty. # @param [String] name # Required. The resource name of the workflow template, as described in https:// # cloud.google.com/apis/design/resource_names. @@ -2329,8 +2383,11 @@ module Google # of workflow by polling operations.get. The Operation will complete when entire # workflow is finished.The running workflow can be aborted via operations.cancel. # This will cause any inflight jobs to be cancelled and workflow-owned clusters - # to be deleted.The Operation.metadata will be WorkflowMetadata. Also see Using - # WorkflowMetadata.On successful completion, Operation.response will be Empty. + # to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud. + # google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1# + # workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/ + # dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On + # successful completion, Operation.response will be Empty. # @param [String] parent # Required. The resource name of the region or location, as described in https:// # cloud.google.com/apis/design/resource_names. diff --git a/generated/google/apis/dataproc_v1beta2.rb b/generated/google/apis/dataproc_v1beta2.rb index 0cf8efa59..bbd56a654 100644 --- a/generated/google/apis/dataproc_v1beta2.rb +++ b/generated/google/apis/dataproc_v1beta2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/dataproc/ module DataprocV1beta2 VERSION = 'V1beta2' - REVISION = '20200220' + REVISION = '20200407' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dataproc_v1beta2/classes.rb b/generated/google/apis/dataproc_v1beta2/classes.rb index 2847bd54d..0a3540299 100644 --- a/generated/google/apis/dataproc_v1beta2/classes.rb +++ b/generated/google/apis/dataproc_v1beta2/classes.rb @@ -420,6 +420,11 @@ module Google # @return [Google::Apis::DataprocV1beta2::GceClusterConfig] attr_accessor :gce_cluster_config + # The GKE config for this cluster. + # Corresponds to the JSON property `gkeClusterConfig` + # @return [Google::Apis::DataprocV1beta2::GkeClusterConfig] + attr_accessor :gke_cluster_config + # Optional. Commands to execute on each node after config is completed. By # default, executables are run on master and all worker nodes. You can test a # node's role metadata to run an executable on a master or worker @@ -479,6 +484,7 @@ module Google @encryption_config = args[:encryption_config] if args.key?(:encryption_config) @endpoint_config = args[:endpoint_config] if args.key?(:endpoint_config) @gce_cluster_config = args[:gce_cluster_config] if args.key?(:gce_cluster_config) + @gke_cluster_config = args[:gke_cluster_config] if args.key?(:gke_cluster_config) @initialization_actions = args[:initialization_actions] if args.key?(:initialization_actions) @lifecycle_config = args[:lifecycle_config] if args.key?(:lifecycle_config) @master_config = args[:master_config] if args.key?(:master_config) @@ -1058,6 +1064,25 @@ module Google end end + # The GKE config for this cluster. + class GkeClusterConfig + include Google::Apis::Core::Hashable + + # A full, namespace-isolated deployment target for an existing GKE cluster. + # Corresponds to the JSON property `namespacedGkeDeploymentTarget` + # @return [Google::Apis::DataprocV1beta2::NamespacedGkeDeploymentTarget] + attr_accessor :namespaced_gke_deployment_target + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @namespaced_gke_deployment_target = args[:namespaced_gke_deployment_target] if args.key?(:namespaced_gke_deployment_target) + end + end + # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/ # docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/ # MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/ @@ -1260,8 +1285,18 @@ module Google # @return [Google::Apis::DataprocV1beta2::DiskConfig] attr_accessor :disk_config - # Optional. The Compute Engine image resource used for cluster instances. It can - # be specified or may be inferred from SoftwareConfig.image_version. + # Optional. The Compute Engine image resource used for cluster instances.The URI + # can represent an image or image family.Image examples: + # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[ + # image-id] + # projects/[project_id]/global/images/[image-id] + # image-idImage family examples. Dataproc will use the most recent image from + # the family: + # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/ + # family/[custom-image-family-name] + # projects/[project_id]/global/images/family/[custom-image-family-name]If the + # URI is unspecified, it will be inferred from SoftwareConfig.image_version or + # the system default. # Corresponds to the JSON property `imageUri` # @return [String] attr_accessor :image_uri @@ -1272,7 +1307,7 @@ module Google # @return [Array] attr_accessor :instance_names - # Optional. Specifies that this instance group contains preemptible instances. + # Output only. Specifies that this instance group contains preemptible instances. # Corresponds to the JSON property `isPreemptible` # @return [Boolean] attr_accessor :is_preemptible @@ -1307,7 +1342,9 @@ module Google # @return [Fixnum] attr_accessor :num_instances - # Optional. Specifies the preemptibility of the instance group. + # Optional. Specifies the preemptibility of the instance group.The default value + # for master and worker groups is NON_PREEMPTIBLE. This default cannot be + # changed.The default value for secondary instances is PREEMPTIBLE. # Corresponds to the JSON property `preemptibility` # @return [String] attr_accessor :preemptibility @@ -1443,7 +1480,9 @@ module Google # @return [Google::Apis::DataprocV1beta2::JobPlacement] attr_accessor :placement - # A Dataproc job for running Presto (https://prestosql.io/) queries + # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: + # The Dataproc Presto Optional Component must be enabled when the cluster is + # created to submit a Presto job to the cluster. # Corresponds to the JSON property `prestoJob` # @return [Google::Apis::DataprocV1beta2::PrestoJob] attr_accessor :presto_job @@ -1537,6 +1576,43 @@ module Google end end + # Job Operation metadata. + class JobMetadata + include Google::Apis::Core::Hashable + + # Output only. The job id. + # Corresponds to the JSON property `jobId` + # @return [String] + attr_accessor :job_id + + # Output only. Operation type. + # Corresponds to the JSON property `operationType` + # @return [String] + attr_accessor :operation_type + + # Output only. Job submission time. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # Dataproc job status. + # Corresponds to the JSON property `status` + # @return [Google::Apis::DataprocV1beta2::JobStatus] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @job_id = args[:job_id] if args.key?(:job_id) + @operation_type = args[:operation_type] if args.key?(:operation_type) + @start_time = args[:start_time] if args.key?(:start_time) + @status = args[:status] if args.key?(:status) + end + end + # Dataproc job config. class JobPlacement include Google::Apis::Core::Hashable @@ -1681,7 +1757,8 @@ module Google # @return [String] attr_accessor :cross_realm_trust_shared_password_uri - # Optional. Flag to indicate whether to Kerberize the cluster. + # Optional. Flag to indicate whether to Kerberize the cluster (default: false). + # Set this field to true to enable Kerberos on a cluster. # Corresponds to the JSON property `enableKerberos` # @return [Boolean] attr_accessor :enable_kerberos @@ -2037,6 +2114,32 @@ module Google end end + # A full, namespace-isolated deployment target for an existing GKE cluster. + class NamespacedGkeDeploymentTarget + include Google::Apis::Core::Hashable + + # Optional. A namespace within the GKE cluster to deploy into. + # Corresponds to the JSON property `clusterNamespace` + # @return [String] + attr_accessor :cluster_namespace + + # Optional. The target GKE cluster to deploy to. Format: 'projects/`project`/ + # locations/`location`/clusters/`cluster_id`' + # Corresponds to the JSON property `targetGkeCluster` + # @return [String] + attr_accessor :target_gke_cluster + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cluster_namespace = args[:cluster_namespace] if args.key?(:cluster_namespace) + @target_gke_cluster = args[:target_gke_cluster] if args.key?(:target_gke_cluster) + end + end + # Specifies an executable to run on a fully configured node and a timeout period # for executable completion. class NodeInitializationAction @@ -2169,6 +2272,13 @@ module Google # @return [Array] attr_accessor :prerequisite_step_ids + # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: + # The Dataproc Presto Optional Component must be enabled when the cluster is + # created to submit a Presto job to the cluster. + # Corresponds to the JSON property `prestoJob` + # @return [Google::Apis::DataprocV1beta2::PrestoJob] + attr_accessor :presto_job + # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/ # python-programming-guide.html) applications on YARN. # Corresponds to the JSON property `pysparkJob` @@ -2189,6 +2299,12 @@ module Google # @return [Google::Apis::DataprocV1beta2::SparkJob] attr_accessor :spark_job + # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/ + # sparkr.html) applications on YARN. + # Corresponds to the JSON property `sparkRJob` + # @return [Google::Apis::DataprocV1beta2::SparkRJob] + attr_accessor :spark_r_job + # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) # queries. # Corresponds to the JSON property `sparkSqlJob` @@ -2216,9 +2332,11 @@ module Google @labels = args[:labels] if args.key?(:labels) @pig_job = args[:pig_job] if args.key?(:pig_job) @prerequisite_step_ids = args[:prerequisite_step_ids] if args.key?(:prerequisite_step_ids) + @presto_job = args[:presto_job] if args.key?(:presto_job) @pyspark_job = args[:pyspark_job] if args.key?(:pyspark_job) @scheduling = args[:scheduling] if args.key?(:scheduling) @spark_job = args[:spark_job] if args.key?(:spark_job) + @spark_r_job = args[:spark_r_job] if args.key?(:spark_r_job) @spark_sql_job = args[:spark_sql_job] if args.key?(:spark_sql_job) @step_id = args[:step_id] if args.key?(:step_id) end @@ -2420,7 +2538,9 @@ module Google end end - # A Dataproc job for running Presto (https://prestosql.io/) queries + # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: + # The Dataproc Presto Optional Component must be enabled when the cluster is + # created to submit a Presto job to the cluster. class PrestoJob include Google::Apis::Core::Hashable @@ -2957,6 +3077,38 @@ module Google end end + # A request to start a cluster. + class StartClusterRequest + include Google::Apis::Core::Hashable + + # Optional. Specifying the cluster_uuid means the RPC should fail (with error + # NOT_FOUND) if cluster with specified UUID does not exist. + # Corresponds to the JSON property `clusterUuid` + # @return [String] + attr_accessor :cluster_uuid + + # Optional. A unique id used to identify the request. If the server receives two + # StartClusterRequest requests with the same id, then the second request will be + # ignored and the first google.longrunning.Operation created and stored in the + # backend is returned.It is recommended to always set this value to a UUID ( + # https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must + # contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (- + # ). The maximum length is 40 characters. + # Corresponds to the JSON property `requestId` + # @return [String] + attr_accessor :request_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cluster_uuid = args[:cluster_uuid] if args.key?(:cluster_uuid) + @request_id = args[:request_id] if args.key?(:request_id) + 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: @@ -2996,6 +3148,38 @@ module Google end end + # A request to stop a cluster. + class StopClusterRequest + include Google::Apis::Core::Hashable + + # Optional. Specifying the cluster_uuid means the RPC should fail (with error + # NOT_FOUND) if cluster with specified UUID does not exist. + # Corresponds to the JSON property `clusterUuid` + # @return [String] + attr_accessor :cluster_uuid + + # Optional. A unique id used to identify the request. If the server receives two + # StopClusterRequest requests with the same id, then the second request will be + # ignored and the first google.longrunning.Operation created and stored in the + # backend is returned.It is recommended to always set this value to a UUID ( + # https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must + # contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (- + # ). The maximum length is 40 characters. + # Corresponds to the JSON property `requestId` + # @return [String] + attr_accessor :request_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cluster_uuid = args[:cluster_uuid] if args.key?(:cluster_uuid) + @request_id = args[:request_id] if args.key?(:request_id) + end + end + # A request to submit a job. class SubmitJobRequest include Google::Apis::Core::Hashable diff --git a/generated/google/apis/dataproc_v1beta2/representations.rb b/generated/google/apis/dataproc_v1beta2/representations.rb index 51f2598db..fc21683bf 100644 --- a/generated/google/apis/dataproc_v1beta2/representations.rb +++ b/generated/google/apis/dataproc_v1beta2/representations.rb @@ -172,6 +172,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GkeClusterConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class HadoopJob class Representation < Google::Apis::Core::JsonRepresentation; end @@ -208,6 +214,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class JobMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class JobPlacement class Representation < Google::Apis::Core::JsonRepresentation; end @@ -292,6 +304,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class NamespacedGkeDeploymentTarget + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class NodeInitializationAction class Representation < Google::Apis::Core::JsonRepresentation; end @@ -394,12 +412,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class StartClusterRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Status class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class StopClusterRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SubmitJobRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -561,6 +591,8 @@ module Google property :gce_cluster_config, as: 'gceClusterConfig', class: Google::Apis::DataprocV1beta2::GceClusterConfig, decorator: Google::Apis::DataprocV1beta2::GceClusterConfig::Representation + property :gke_cluster_config, as: 'gkeClusterConfig', class: Google::Apis::DataprocV1beta2::GkeClusterConfig, decorator: Google::Apis::DataprocV1beta2::GkeClusterConfig::Representation + collection :initialization_actions, as: 'initializationActions', class: Google::Apis::DataprocV1beta2::NodeInitializationAction, decorator: Google::Apis::DataprocV1beta2::NodeInitializationAction::Representation property :lifecycle_config, as: 'lifecycleConfig', class: Google::Apis::DataprocV1beta2::LifecycleConfig, decorator: Google::Apis::DataprocV1beta2::LifecycleConfig::Representation @@ -723,6 +755,14 @@ module Google end end + class GkeClusterConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :namespaced_gke_deployment_target, as: 'namespacedGkeDeploymentTarget', class: Google::Apis::DataprocV1beta2::NamespacedGkeDeploymentTarget, decorator: Google::Apis::DataprocV1beta2::NamespacedGkeDeploymentTarget::Representation + + end + end + class HadoopJob # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -829,6 +869,17 @@ module Google end end + class JobMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :job_id, as: 'jobId' + property :operation_type, as: 'operationType' + property :start_time, as: 'startTime' + property :status, as: 'status', class: Google::Apis::DataprocV1beta2::JobStatus, decorator: Google::Apis::DataprocV1beta2::JobStatus::Representation + + end + end + class JobPlacement # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -963,6 +1014,14 @@ module Google end end + class NamespacedGkeDeploymentTarget + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cluster_namespace, as: 'clusterNamespace' + property :target_gke_cluster, as: 'targetGkeCluster' + end + end + class NodeInitializationAction # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -994,12 +1053,16 @@ module Google property :pig_job, as: 'pigJob', class: Google::Apis::DataprocV1beta2::PigJob, decorator: Google::Apis::DataprocV1beta2::PigJob::Representation collection :prerequisite_step_ids, as: 'prerequisiteStepIds' + property :presto_job, as: 'prestoJob', class: Google::Apis::DataprocV1beta2::PrestoJob, decorator: Google::Apis::DataprocV1beta2::PrestoJob::Representation + property :pyspark_job, as: 'pysparkJob', class: Google::Apis::DataprocV1beta2::PySparkJob, decorator: Google::Apis::DataprocV1beta2::PySparkJob::Representation property :scheduling, as: 'scheduling', class: Google::Apis::DataprocV1beta2::JobScheduling, decorator: Google::Apis::DataprocV1beta2::JobScheduling::Representation property :spark_job, as: 'sparkJob', class: Google::Apis::DataprocV1beta2::SparkJob, decorator: Google::Apis::DataprocV1beta2::SparkJob::Representation + property :spark_r_job, as: 'sparkRJob', class: Google::Apis::DataprocV1beta2::SparkRJob, decorator: Google::Apis::DataprocV1beta2::SparkRJob::Representation + property :spark_sql_job, as: 'sparkSqlJob', class: Google::Apis::DataprocV1beta2::SparkSqlJob, decorator: Google::Apis::DataprocV1beta2::SparkSqlJob::Representation property :step_id, as: 'stepId' @@ -1161,6 +1224,14 @@ module Google end end + class StartClusterRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cluster_uuid, as: 'clusterUuid' + property :request_id, as: 'requestId' + end + end + class Status # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1170,6 +1241,14 @@ module Google end end + class StopClusterRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cluster_uuid, as: 'clusterUuid' + property :request_id, as: 'requestId' + end + end + class SubmitJobRequest # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/dataproc_v1beta2/service.rb b/generated/google/apis/dataproc_v1beta2/service.rb index 8ef5f2b97..dc80c54f3 100644 --- a/generated/google/apis/dataproc_v1beta2/service.rb +++ b/generated/google/apis/dataproc_v1beta2/service.rb @@ -521,8 +521,11 @@ module Google # will complete when entire workflow is finished.The running workflow can be # aborted via operations.cancel. This will cause any inflight jobs to be # cancelled and workflow-owned clusters to be deleted.The Operation.metadata - # will be WorkflowMetadata. Also see Using WorkflowMetadata.On successful - # completion, Operation.response will be Empty. + # will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/ + # google.cloud.dataproc.v1beta2#workflowmetadata). Also see Using + # WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/ + # debugging#using_workflowmetadata).On successful completion, Operation.response + # will be Empty. # @param [String] name # Required. The resource name of the workflow template, as described in https:// # cloud.google.com/apis/design/resource_names. @@ -568,8 +571,11 @@ module Google # of workflow by polling operations.get. The Operation will complete when entire # workflow is finished.The running workflow can be aborted via operations.cancel. # This will cause any inflight jobs to be cancelled and workflow-owned clusters - # to be deleted.The Operation.metadata will be WorkflowMetadata. Also see Using - # WorkflowMetadata.On successful completion, Operation.response will be Empty. + # to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud. + # google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1# + # workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/ + # dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On + # successful completion, Operation.response will be Empty. # @param [String] parent # Required. The resource name of the region or location, as described in https:// # cloud.google.com/apis/design/resource_names. @@ -1086,7 +1092,8 @@ module Google end # Creates a cluster in a project. The returned Operation.metadata will be - # ClusterOperationMetadata. + # ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/ + # google.cloud.dataproc.v1beta2#clusteroperationmetadata). # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the cluster belongs # to. @@ -1133,7 +1140,8 @@ module Google end # Deletes a cluster in a project. The returned Operation.metadata will be - # ClusterOperationMetadata. + # ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/ + # google.cloud.dataproc.v1beta2#clusteroperationmetadata). # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the cluster belongs # to. @@ -1184,8 +1192,9 @@ module Google end # Gets cluster diagnostic information. The returned Operation.metadata will be - # ClusterOperationMetadata. After the operation completes, Operation.response - # contains Empty. + # ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/ + # google.cloud.dataproc.v1beta2#clusteroperationmetadata). After the operation + # completes, Operation.response contains Empty. # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the cluster belongs # to. @@ -1300,7 +1309,7 @@ module Google execute_or_queue_command(command, &block) end - # Lists all regions/`region`/clusters in a project. + # Lists all regions/`region`/clusters in a project alphabetically. # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the cluster belongs # to. @@ -1354,7 +1363,8 @@ module Google end # Updates a cluster in a project. The returned Operation.metadata will be - # ClusterOperationMetadata. + # ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/ + # google.cloud.dataproc.v1beta2#clusteroperationmetadata). # @param [String] project_id # Required. The ID of the Google Cloud Platform project the cluster belongs to. # @param [String] region @@ -1504,6 +1514,84 @@ module Google execute_or_queue_command(command, &block) end + # Starts a cluster in a project. + # @param [String] project_id + # Required. The ID of the Google Cloud Platform project the cluster belongs to. + # @param [String] region + # Required. The Dataproc region in which to handle the request. + # @param [String] cluster_name + # Required. The cluster name. + # @param [Google::Apis::DataprocV1beta2::StartClusterRequest] start_cluster_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DataprocV1beta2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DataprocV1beta2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def start_cluster(project_id, region, cluster_name, start_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:start', options) + command.request_representation = Google::Apis::DataprocV1beta2::StartClusterRequest::Representation + command.request_object = start_cluster_request_object + command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation + command.response_class = Google::Apis::DataprocV1beta2::Operation + command.params['projectId'] = project_id unless project_id.nil? + command.params['region'] = region unless region.nil? + command.params['clusterName'] = cluster_name unless cluster_name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Stops a cluster in a project. + # @param [String] project_id + # Required. The ID of the Google Cloud Platform project the cluster belongs to. + # @param [String] region + # Required. The Dataproc region in which to handle the request. + # @param [String] cluster_name + # Required. The cluster name. + # @param [Google::Apis::DataprocV1beta2::StopClusterRequest] stop_cluster_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DataprocV1beta2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DataprocV1beta2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def stop_cluster(project_id, region, cluster_name, stop_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:stop', options) + command.request_representation = Google::Apis::DataprocV1beta2::StopClusterRequest::Representation + command.request_object = stop_cluster_request_object + command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation + command.response_class = Google::Apis::DataprocV1beta2::Operation + command.params['projectId'] = project_id unless project_id.nil? + command.params['region'] = region unless region.nil? + command.params['clusterName'] = cluster_name unless cluster_name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Returns permissions that a caller has on the specified resource. If the # resource does not exist, this will return an empty set of permissions, not a # NOT_FOUND error.Note: This operation is designed to be used for building @@ -1543,7 +1631,10 @@ module Google end # Starts a job cancellation request. To access the job resource after - # cancellation, call regions/`region`/jobs.list or regions/`region`/jobs.get. + # cancellation, call regions/`region`/jobs.list (https://cloud.google.com/ + # dataproc/docs/reference/rest/v1beta2/projects.regions.jobs/list) or regions/` + # region`/jobs.get (https://cloud.google.com/dataproc/docs/reference/rest/ + # v1beta2/projects.regions.jobs/get). # @param [String] project_id # Required. The ID of the Google Cloud Platform project that the job belongs to. # @param [String] region @@ -1868,6 +1959,42 @@ module Google execute_or_queue_command(command, &block) end + # Submits job to a cluster. + # @param [String] project_id + # Required. The ID of the Google Cloud Platform project that the job belongs to. + # @param [String] region + # Required. The Dataproc region in which to handle the request. + # @param [Google::Apis::DataprocV1beta2::SubmitJobRequest] submit_job_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DataprocV1beta2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DataprocV1beta2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def submit_project_region_job_as_operation(project_id, region, submit_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta2/projects/{projectId}/regions/{region}/jobs:submitAsOperation', options) + command.request_representation = Google::Apis::DataprocV1beta2::SubmitJobRequest::Representation + command.request_object = submit_job_request_object + command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation + command.response_class = Google::Apis::DataprocV1beta2::Operation + command.params['projectId'] = project_id unless project_id.nil? + command.params['region'] = region unless region.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Returns permissions that a caller has on the specified resource. If the # resource does not exist, this will return an empty set of permissions, not a # NOT_FOUND error.Note: This operation is designed to be used for building @@ -2330,8 +2457,11 @@ module Google # will complete when entire workflow is finished.The running workflow can be # aborted via operations.cancel. This will cause any inflight jobs to be # cancelled and workflow-owned clusters to be deleted.The Operation.metadata - # will be WorkflowMetadata. Also see Using WorkflowMetadata.On successful - # completion, Operation.response will be Empty. + # will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/ + # google.cloud.dataproc.v1beta2#workflowmetadata). Also see Using + # WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/ + # debugging#using_workflowmetadata).On successful completion, Operation.response + # will be Empty. # @param [String] name # Required. The resource name of the workflow template, as described in https:// # cloud.google.com/apis/design/resource_names. @@ -2377,8 +2507,11 @@ module Google # of workflow by polling operations.get. The Operation will complete when entire # workflow is finished.The running workflow can be aborted via operations.cancel. # This will cause any inflight jobs to be cancelled and workflow-owned clusters - # to be deleted.The Operation.metadata will be WorkflowMetadata. Also see Using - # WorkflowMetadata.On successful completion, Operation.response will be Empty. + # to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud. + # google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1# + # workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/ + # dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On + # successful completion, Operation.response will be Empty. # @param [String] parent # Required. The resource name of the region or location, as described in https:// # cloud.google.com/apis/design/resource_names. diff --git a/generated/google/apis/dfareporting_v3_3.rb b/generated/google/apis/dfareporting_v3_3.rb index 7b78c6ec6..0f2bd4792 100644 --- a/generated/google/apis/dfareporting_v3_3.rb +++ b/generated/google/apis/dfareporting_v3_3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/doubleclick-advertisers/ module DfareportingV3_3 VERSION = 'V3_3' - REVISION = '20191112' + REVISION = '20200326' # Manage DoubleClick Digital Marketing conversions AUTH_DDMCONVERSIONS = 'https://www.googleapis.com/auth/ddmconversions' diff --git a/generated/google/apis/dfareporting_v3_3/classes.rb b/generated/google/apis/dfareporting_v3_3/classes.rb index 17bff9e0e..3acb93d52 100644 --- a/generated/google/apis/dfareporting_v3_3/classes.rb +++ b/generated/google/apis/dfareporting_v3_3/classes.rb @@ -3771,8 +3771,8 @@ module Google # @return [Google::Apis::DfareportingV3_3::CreativeAssetId] attr_accessor :asset_identifier - # List of detected click tags for assets. This is a read-only auto-generated - # field. + # List of detected click tags for assets. This is a read-only, auto-generated + # field. This field is empty for a rich media asset. # Corresponds to the JSON property `clickTags` # @return [Array] attr_accessor :click_tags @@ -5623,7 +5623,7 @@ module Google # @return [Google::Apis::DfareportingV3_3::DateRange] attr_accessor :date_range - # The eTag of this response for caching purposes. + # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag @@ -5643,7 +5643,8 @@ module Google # @return [Fixnum] attr_accessor :id - # The kind of resource this is, in this case dfareporting#file. + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#file". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -5712,21 +5713,22 @@ module Google end end - # Represents the list of File resources. + # class FileList include Google::Apis::Core::Hashable - # The eTag of this response for caching purposes. + # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # The files returned in this response. + # # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The kind of list this is, in this case dfareporting#fileList. + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#fileList". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -11844,7 +11846,9 @@ module Google end end - # Represents a UserProfile resource. + # A UserProfile resource lets you list all DFA user profiles that are associated + # with a Google user account. The profile_id needs to be specified in other API + # requests.  class UserProfile include Google::Apis::Core::Hashable @@ -11858,12 +11862,13 @@ module Google # @return [String] attr_accessor :account_name - # The eTag of this response for caching purposes. + # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # The kind of resource this is, in this case dfareporting#userProfile. + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#userProfile". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -11909,7 +11914,7 @@ module Google class UserProfileList include Google::Apis::Core::Hashable - # The eTag of this response for caching purposes. + # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag @@ -11919,7 +11924,8 @@ module Google # @return [Array] attr_accessor :items - # The kind of list this is, in this case dfareporting#userProfileList. + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#userProfileList". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind diff --git a/generated/google/apis/dfareporting_v3_3/service.rb b/generated/google/apis/dfareporting_v3_3/service.rb index 8dd1e1592..23b302031 100644 --- a/generated/google/apis/dfareporting_v3_3/service.rb +++ b/generated/google/apis/dfareporting_v3_3/service.rb @@ -7205,9 +7205,10 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves a report file. This method supports media download. + # Retrieves a report file by its report ID and file ID. This method supports + # media download. # @param [Fixnum] profile_id - # The DFA profile ID. + # The DFA user profile ID. # @param [Fixnum] report_id # The ID of the report. # @param [Fixnum] file_id @@ -7253,9 +7254,9 @@ module Google # Lists files for a report. # @param [Fixnum] profile_id - # The DFA profile ID. + # The DFA user profile ID. # @param [Fixnum] report_id - # The ID of the parent report. + # The ID of the report. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token diff --git a/generated/google/apis/dfareporting_v3_4.rb b/generated/google/apis/dfareporting_v3_4.rb index c614bc09c..3ce389f8d 100644 --- a/generated/google/apis/dfareporting_v3_4.rb +++ b/generated/google/apis/dfareporting_v3_4.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/doubleclick-advertisers/ module DfareportingV3_4 VERSION = 'V3_4' - REVISION = '20200121' + REVISION = '20200326' # Manage DoubleClick Digital Marketing conversions AUTH_DDMCONVERSIONS = 'https://www.googleapis.com/auth/ddmconversions' diff --git a/generated/google/apis/dfareporting_v3_4/classes.rb b/generated/google/apis/dfareporting_v3_4/classes.rb index b14010404..435760b0f 100644 --- a/generated/google/apis/dfareporting_v3_4/classes.rb +++ b/generated/google/apis/dfareporting_v3_4/classes.rb @@ -3127,6 +3127,11 @@ module Google # @return [String] attr_accessor :name + # Online Behavioral Advertiser icon. + # Corresponds to the JSON property `obaIcon` + # @return [Google::Apis::DfareportingV3_4::ObaIcon] + attr_accessor :oba_icon + # Override CSS value for rich media creatives. Applicable to the following # creative types: all RICH_MEDIA. # Corresponds to the JSON property `overrideCss` @@ -3337,6 +3342,7 @@ module Google @media_description = args[:media_description] if args.key?(:media_description) @media_duration = args[:media_duration] if args.key?(:media_duration) @name = args[:name] if args.key?(:name) + @oba_icon = args[:oba_icon] if args.key?(:oba_icon) @override_css = args[:override_css] if args.key?(:override_css) @progress_offset = args[:progress_offset] if args.key?(:progress_offset) @redirect_url = args[:redirect_url] if args.key?(:redirect_url) @@ -3821,12 +3827,18 @@ module Google # @return [Google::Apis::DfareportingV3_4::CreativeAssetId] attr_accessor :asset_identifier - # List of detected click tags for assets. This is a read-only auto-generated - # field. + # List of detected click tags for assets. This is a read-only, auto-generated + # field. This field is empty for a rich media asset. # Corresponds to the JSON property `clickTags` # @return [Array] attr_accessor :click_tags + # List of counter events configured for the asset. This is a read-only, auto- + # generated field and only applicable to a rich media asset. + # Corresponds to the JSON property `counterCustomEvents` + # @return [Array] + attr_accessor :counter_custom_events + # List of feature dependencies for the creative asset that are detected by # Campaign Manager. Feature dependencies are features that a browser must be # able to support in order to render your HTML5 creative correctly. This is a @@ -3835,6 +3847,12 @@ module Google # @return [Array] attr_accessor :detected_features + # List of exit events configured for the asset. This is a read-only, auto- + # generated field and only applicable to a rich media asset. + # Corresponds to the JSON property `exitCustomEvents` + # @return [Array] + attr_accessor :exit_custom_events + # Numeric ID of the asset. This is a read-only, auto-generated field. # Corresponds to the JSON property `id` # @return [Fixnum] @@ -3851,6 +3869,19 @@ module Google # @return [String] attr_accessor :kind + # True if the uploaded asset is a rich media asset. This is a read-only, auto- + # generated field. + # Corresponds to the JSON property `richMedia` + # @return [Boolean] + attr_accessor :rich_media + alias_method :rich_media?, :rich_media + + # List of timer events configured for the asset. This is a read-only, auto- + # generated field and only applicable to a rich media asset. + # Corresponds to the JSON property `timerCustomEvents` + # @return [Array] + attr_accessor :timer_custom_events + # Rules validated during code generation that generated a warning. This is a # read-only, auto-generated field. # Possible values are: @@ -3890,10 +3921,14 @@ module Google def update!(**args) @asset_identifier = args[:asset_identifier] if args.key?(:asset_identifier) @click_tags = args[:click_tags] if args.key?(:click_tags) + @counter_custom_events = args[:counter_custom_events] if args.key?(:counter_custom_events) @detected_features = args[:detected_features] if args.key?(:detected_features) + @exit_custom_events = args[:exit_custom_events] if args.key?(:exit_custom_events) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @kind = args[:kind] if args.key?(:kind) + @rich_media = args[:rich_media] if args.key?(:rich_media) + @timer_custom_events = args[:timer_custom_events] if args.key?(:timer_custom_events) @warned_validation_rules = args[:warned_validation_rules] if args.key?(:warned_validation_rules) end end @@ -4635,14 +4670,19 @@ module Google # @return [Google::Apis::DfareportingV3_4::CustomEventClickAnnotation] attr_accessor :annotate_click_event + # Annotate an impression. + # Corresponds to the JSON property `annotateImpressionEvent` + # @return [Google::Apis::DfareportingV3_4::CustomEventImpressionAnnotation] + attr_accessor :annotate_impression_event + # Custom variables associated with the event. # Corresponds to the JSON property `customVariables` # @return [Array] attr_accessor :custom_variables # The type of event. If INSERT, the fields in insertEvent need to be populated. - # If ANNOTATE_CLICK, the fields in annotateClickEvent need to be populated. A - # custom event cannot have both insertEvent and annotateClickEvent populated. + # If ANNOTATE, the fields in either annotateClickEvent or + # annotateImpressionEvent need to be populated. # Corresponds to the JSON property `eventType` # @return [String] attr_accessor :event_type @@ -4682,6 +4722,7 @@ module Google # Update properties of this object def update!(**args) @annotate_click_event = args[:annotate_click_event] if args.key?(:annotate_click_event) + @annotate_impression_event = args[:annotate_impression_event] if args.key?(:annotate_impression_event) @custom_variables = args[:custom_variables] if args.key?(:custom_variables) @event_type = args[:event_type] if args.key?(:event_type) @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) @@ -4751,6 +4792,33 @@ module Google end end + # Annotate an impression. + class CustomEventImpressionAnnotation + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#customEventImpressionAnnotation". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The path impression ID. Use this field to annotate the impression associated + # with the pathImpressionId. + # Corresponds to the JSON property `pathImpressionId` + # @return [String] + attr_accessor :path_impression_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @path_impression_id = args[:path_impression_id] if args.key?(:path_impression_id) + end + end + # Custom event to be inserted. class CustomEventInsert include Google::Apis::Core::Hashable @@ -6024,7 +6092,7 @@ module Google # @return [Google::Apis::DfareportingV3_4::DateRange] attr_accessor :date_range - # The eTag of this response for caching purposes. + # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag @@ -6044,7 +6112,8 @@ module Google # @return [Fixnum] attr_accessor :id - # The kind of resource this is, in this case dfareporting#file. + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#file". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -6113,21 +6182,22 @@ module Google end end - # Represents the list of File resources. + # class FileList include Google::Apis::Core::Hashable - # The eTag of this response for caching purposes. + # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # The files returned in this response. + # # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The kind of list this is, in this case dfareporting#fileList. + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#fileList". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -7814,6 +7884,69 @@ module Google end end + # Online Behavioral Advertiser icon. + class ObaIcon + include Google::Apis::Core::Hashable + + # URL to redirect to when an OBA icon is clicked. + # Corresponds to the JSON property `iconClickThroughUrl` + # @return [String] + attr_accessor :icon_click_through_url + + # URL to track click when an OBA icon is clicked. + # Corresponds to the JSON property `iconClickTrackingUrl` + # @return [String] + attr_accessor :icon_click_tracking_url + + # URL to track view when an OBA icon is clicked. + # Corresponds to the JSON property `iconViewTrackingUrl` + # @return [String] + attr_accessor :icon_view_tracking_url + + # Identifies the industry initiative that the icon supports. For example, + # AdChoices. + # Corresponds to the JSON property `program` + # @return [String] + attr_accessor :program + + # OBA icon resource URL. Campaign Manager only supports image and JavaScript + # icons. Learn more + # Corresponds to the JSON property `resourceUrl` + # @return [String] + attr_accessor :resource_url + + # Represents the dimensions of ads, placements, creatives, or creative assets. + # Corresponds to the JSON property `size` + # @return [Google::Apis::DfareportingV3_4::Size] + attr_accessor :size + + # OBA icon x coordinate position. Accepted values are left or right. + # Corresponds to the JSON property `xPosition` + # @return [String] + attr_accessor :x_position + + # OBA icon y coordinate position. Accepted values are top or bottom. + # Corresponds to the JSON property `yPosition` + # @return [String] + attr_accessor :y_position + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @icon_click_through_url = args[:icon_click_through_url] if args.key?(:icon_click_through_url) + @icon_click_tracking_url = args[:icon_click_tracking_url] if args.key?(:icon_click_tracking_url) + @icon_view_tracking_url = args[:icon_view_tracking_url] if args.key?(:icon_view_tracking_url) + @program = args[:program] if args.key?(:program) + @resource_url = args[:resource_url] if args.key?(:resource_url) + @size = args[:size] if args.key?(:size) + @x_position = args[:x_position] if args.key?(:x_position) + @y_position = args[:y_position] if args.key?(:y_position) + end + end + # Object Filter. class ObjectFilter include Google::Apis::Core::Hashable @@ -12241,7 +12374,9 @@ module Google end end - # Represents a UserProfile resource. + # A UserProfile resource lets you list all DFA user profiles that are associated + # with a Google user account. The profile_id needs to be specified in other API + # requests.  class UserProfile include Google::Apis::Core::Hashable @@ -12255,12 +12390,13 @@ module Google # @return [String] attr_accessor :account_name - # The eTag of this response for caching purposes. + # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # The kind of resource this is, in this case dfareporting#userProfile. + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#userProfile". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -12306,7 +12442,7 @@ module Google class UserProfileList include Google::Apis::Core::Hashable - # The eTag of this response for caching purposes. + # Etag of this resource. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag @@ -12316,7 +12452,8 @@ module Google # @return [Array] attr_accessor :items - # The kind of list this is, in this case dfareporting#userProfileList. + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#userProfileList". # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind diff --git a/generated/google/apis/dfareporting_v3_4/representations.rb b/generated/google/apis/dfareporting_v3_4/representations.rb index 553e7455e..d2a46f714 100644 --- a/generated/google/apis/dfareporting_v3_4/representations.rb +++ b/generated/google/apis/dfareporting_v3_4/representations.rb @@ -466,6 +466,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class CustomEventImpressionAnnotation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CustomEventInsert class Representation < Google::Apis::Core::JsonRepresentation; end @@ -868,6 +874,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ObaIcon + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ObjectFilter class Representation < Google::Apis::Core::JsonRepresentation; end @@ -2180,6 +2192,8 @@ module Google property :media_description, as: 'mediaDescription' property :media_duration, as: 'mediaDuration' property :name, as: 'name' + property :oba_icon, as: 'obaIcon', class: Google::Apis::DfareportingV3_4::ObaIcon, decorator: Google::Apis::DfareportingV3_4::ObaIcon::Representation + property :override_css, as: 'overrideCss' property :progress_offset, as: 'progressOffset', class: Google::Apis::DfareportingV3_4::VideoOffset, decorator: Google::Apis::DfareportingV3_4::VideoOffset::Representation @@ -2294,11 +2308,18 @@ module Google collection :click_tags, as: 'clickTags', class: Google::Apis::DfareportingV3_4::ClickTag, decorator: Google::Apis::DfareportingV3_4::ClickTag::Representation + collection :counter_custom_events, as: 'counterCustomEvents', class: Google::Apis::DfareportingV3_4::CreativeCustomEvent, decorator: Google::Apis::DfareportingV3_4::CreativeCustomEvent::Representation + collection :detected_features, as: 'detectedFeatures' + collection :exit_custom_events, as: 'exitCustomEvents', class: Google::Apis::DfareportingV3_4::CreativeCustomEvent, decorator: Google::Apis::DfareportingV3_4::CreativeCustomEvent::Representation + property :id, :numeric_string => true, as: 'id' property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_4::DimensionValue, decorator: Google::Apis::DfareportingV3_4::DimensionValue::Representation property :kind, as: 'kind' + property :rich_media, as: 'richMedia' + collection :timer_custom_events, as: 'timerCustomEvents', class: Google::Apis::DfareportingV3_4::CreativeCustomEvent, decorator: Google::Apis::DfareportingV3_4::CreativeCustomEvent::Representation + collection :warned_validation_rules, as: 'warnedValidationRules' end end @@ -2501,6 +2522,8 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :annotate_click_event, as: 'annotateClickEvent', class: Google::Apis::DfareportingV3_4::CustomEventClickAnnotation, decorator: Google::Apis::DfareportingV3_4::CustomEventClickAnnotation::Representation + property :annotate_impression_event, as: 'annotateImpressionEvent', class: Google::Apis::DfareportingV3_4::CustomEventImpressionAnnotation, decorator: Google::Apis::DfareportingV3_4::CustomEventImpressionAnnotation::Representation + collection :custom_variables, as: 'customVariables', class: Google::Apis::DfareportingV3_4::CustomVariable, decorator: Google::Apis::DfareportingV3_4::CustomVariable::Representation property :event_type, as: 'eventType' @@ -2530,6 +2553,14 @@ module Google end end + class CustomEventImpressionAnnotation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :path_impression_id, as: 'pathImpressionId' + end + end + class CustomEventInsert # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -3322,6 +3353,21 @@ module Google end end + class ObaIcon + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :icon_click_through_url, as: 'iconClickThroughUrl' + property :icon_click_tracking_url, as: 'iconClickTrackingUrl' + property :icon_view_tracking_url, as: 'iconViewTrackingUrl' + property :program, as: 'program' + property :resource_url, as: 'resourceUrl' + property :size, as: 'size', class: Google::Apis::DfareportingV3_4::Size, decorator: Google::Apis::DfareportingV3_4::Size::Representation + + property :x_position, as: 'xPosition' + property :y_position, as: 'yPosition' + end + end + class ObjectFilter # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/dfareporting_v3_4/service.rb b/generated/google/apis/dfareporting_v3_4/service.rb index 22727295e..c02580283 100644 --- a/generated/google/apis/dfareporting_v3_4/service.rb +++ b/generated/google/apis/dfareporting_v3_4/service.rb @@ -7202,9 +7202,10 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves a report file. This method supports media download. + # Retrieves a report file by its report ID and file ID. This method supports + # media download. # @param [Fixnum] profile_id - # The DFA profile ID. + # The DFA user profile ID. # @param [Fixnum] report_id # The ID of the report. # @param [Fixnum] file_id @@ -7250,9 +7251,9 @@ module Google # Lists files for a report. # @param [Fixnum] profile_id - # The DFA profile ID. + # The DFA user profile ID. # @param [Fixnum] report_id - # The ID of the parent report. + # The ID of the report. # @param [Fixnum] max_results # Maximum number of results to return. # @param [String] page_token diff --git a/generated/google/apis/dialogflow_v2.rb b/generated/google/apis/dialogflow_v2.rb index 1a77b97e2..cd3c1c533 100644 --- a/generated/google/apis/dialogflow_v2.rb +++ b/generated/google/apis/dialogflow_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/dialogflow/ module DialogflowV2 VERSION = 'V2' - REVISION = '20200303' + REVISION = '20200408' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dialogflow_v2/classes.rb b/generated/google/apis/dialogflow_v2/classes.rb index 289964916..03ee8a47f 100644 --- a/generated/google/apis/dialogflow_v2/classes.rb +++ b/generated/google/apis/dialogflow_v2/classes.rb @@ -184,12 +184,12 @@ module Google # @return [Array] attr_accessor :entities - # Optional. The language of entity synonyms defined in `entities`. If not - # specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -216,12 +216,12 @@ module Google # @return [Array] attr_accessor :entity_values - # Optional. The language of entity synonyms defined in `entities`. If not - # specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -286,12 +286,12 @@ module Google # @return [Array] attr_accessor :entities - # Optional. The language of entity synonyms defined in `entities`. If not - # specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -330,12 +330,12 @@ module Google # @return [String] attr_accessor :entity_type_batch_uri - # Optional. The language of entity synonyms defined in `entity_types`. If not - # specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -377,7 +377,7 @@ module Google end end - # The request message for Intents.BatchUpdateIntents. + # class GoogleCloudDialogflowV2BatchUpdateIntentsRequest include Google::Apis::Core::Hashable @@ -398,12 +398,12 @@ module Google # @return [String] attr_accessor :intent_view - # Optional. The language of training phrases, parameters and rich messages - # defined in `intents`. If not specified, the agent's default language is - # used. [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -451,7 +451,7 @@ module Google include Google::Apis::Core::Hashable # Optional. The number of conversational query requests after which the - # context expires. If set to `0` (the default) the context expires + # context expires. The default is `0`. If set to `0`, the context expires # immediately. Contexts expire automatically after 20 minutes if there # are no matching queries. # Corresponds to the JSON property `lifespanCount` @@ -476,9 +476,18 @@ module Google attr_accessor :name # Optional. The collection of parameters associated with this context. - # Refer to [this - # doc](https://cloud.google.com/dialogflow/docs/intents-actions-parameters) - # for syntax. + # Depending on your protocol or client library language, this is a + # map, associative array, symbol table, dictionary, or JSON object + # composed of a collection of (MapKey, MapValue) pairs: + # - MapKey type: string + # - MapKey value: parameter name + # - MapValue type: + # - If parameter's entity type is a composite entity: map + # - Else: string + # - MapValue value: + # - If parameter's entity type is a composite entity: + # map from composite entity property names to property values + # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -540,8 +549,6 @@ module Google end end - # ============================================================================ - # Requests and responses for custom methods. # The request to detect user's intent. class GoogleCloudDialogflowV2DetectIntentRequest include Google::Apis::Core::Hashable @@ -1009,7 +1016,7 @@ module Google # @return [String] attr_accessor :audio_encoding - # Optional. If `true`, Dialogflow returns SpeechWordInfo in + # If `true`, Dialogflow returns SpeechWordInfo in # StreamingRecognitionResult with information about the recognized speech # words, e.g. start and end time offsets. If false or unspecified, Speech # doesn't return any word-level information. @@ -1027,7 +1034,7 @@ module Google # @return [String] attr_accessor :language_code - # Optional. Which Speech model to select for the given request. Select the + # Which Speech model to select for the given request. Select the # model best suited to your domain to get best results. If a model is not # explicitly specified, then we auto-select a model based on the parameters # in the InputAudioConfig. @@ -1043,12 +1050,12 @@ module Google # @return [String] attr_accessor :model - # Optional. Which variant of the Speech model to use. + # Which variant of the Speech model to use. # Corresponds to the JSON property `modelVariant` # @return [String] attr_accessor :model_variant - # Optional. A list of strings containing words and phrases that the speech + # A list of strings containing words and phrases that the speech # recognizer should recognize with higher likelihood. # See [the Cloud Speech # documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase- @@ -1070,7 +1077,7 @@ module Google # @return [Fixnum] attr_accessor :sample_rate_hertz - # Optional. If `false` (default), recognition does not cease until the + # If `false` (default), recognition does not cease until the # client closes the stream. # If `true`, the recognizer will detect a single spoken utterance in input # audio. Recognition ceases when it detects the audio's voice has @@ -1085,7 +1092,7 @@ module Google attr_accessor :single_utterance alias_method :single_utterance?, :single_utterance - # Optional. Context information to assist speech recognition. + # Context information to assist speech recognition. # See [the Cloud Speech # documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase- # hints) @@ -1138,6 +1145,7 @@ module Google # Optional. The collection of event names that trigger the intent. # If the collection of input contexts is not empty, all of the contexts must # be present in the active user session for an event to trigger this intent. + # Event names are limited to 150 characters. # Corresponds to the JSON property `events` # @return [Array] attr_accessor :events @@ -1176,7 +1184,7 @@ module Google attr_accessor :ml_disabled alias_method :ml_disabled?, :ml_disabled - # The unique identifier of this intent. + # Optional. The unique identifier of this intent. # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents # methods. # Format: `projects//agent/intents/`. @@ -1319,7 +1327,11 @@ module Google end end - # Corresponds to the `Response` field in the Dialogflow console. + # A rich response message. + # Corresponds to the intent `Response` field in the Dialogflow console. + # For more information, see + # [Rich response + # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages). class GoogleCloudDialogflowV2IntentMessage include Google::Apis::Core::Hashable @@ -1365,9 +1377,7 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageMediaContent] attr_accessor :media_content - # Returns a response containing a custom, platform-specific payload. - # See the Intent.Message.Platform type for a description of the - # structure that may be required for your platform. + # A custom platform-specific response. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload @@ -2586,7 +2596,8 @@ module Google # Optional. This field is set to the value of the `QueryParameters.payload` # field passed in the request. Some integrations that query a Dialogflow # agent may provide additional information in the payload. - # In particular for the Telephony Gateway this field has the form: + # In particular, for the Dialogflow Phone Gateway integration, this field has + # the form: #
`
         # "telephony": `
         # "caller_id": "+18558363987"
@@ -2718,8 +2729,11 @@ module Google
         # @return [Google::Apis::DialogflowV2::GoogleTypeLatLng]
         attr_accessor :geo_location
       
-        # This field can be used to pass custom data into the webhook
-        # associated with the agent. Arbitrary JSON objects are supported.
+        # This field can be used to pass custom data to your webhook.
+        # Arbitrary JSON objects are supported.
+        # If supplied, the value is used to populate the
+        # `WebhookRequest.original_detect_intent_request.payload`
+        # field sent to your webhook.
         # Corresponds to the JSON property `payload`
         # @return [Hash]
         attr_accessor :payload
@@ -3400,28 +3414,18 @@ module Google
         # @return [Array]
         attr_accessor :output_contexts
       
-        # Optional. This value is passed directly to `QueryResult.webhook_payload`.
-        # See the related `fulfillment_messages[i].payload field`, which may be used
-        # as an alternative to this field.
-        # This field can be used for Actions on Google responses.
-        # It should have a structure similar to the JSON message shown here. For more
-        # information, see
-        # [Actions on Google Webhook
-        # Format](https://developers.google.com/actions/dialogflow/webhook)
-        # 
`
-        # "google": `
-        # "expectUserResponse": true,
-        # "richResponse": `
-        # "items": [
-        # `
-        # "simpleResponse": `
-        # "textToSpeech": "this is a simple response"
-        # `
-        # `
-        # ]
-        # `
-        # `
-        # `
+ # Optional. This field can be used to pass custom data from your webhook to the + # API + # caller. Arbitrary JSON objects are supported. + # When provided, Dialogflow uses this field to populate + # `QueryResult.webhook_payload` sent to the API caller. + # This field is also used by the + # [Google Assistant + # integration](https://cloud.google.com/dialogflow/docs/integrations/aog) + # for rich response messages. + # See the format definition at [Google Assistant Dialogflow webhook + # format](https://developers.google.com/assistant/actions/build/json/dialogflow- + # webhook-json) # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload @@ -3566,7 +3570,7 @@ module Google include Google::Apis::Core::Hashable # Optional. The number of conversational query requests after which the - # context expires. If set to `0` (the default) the context expires + # context expires. The default is `0`. If set to `0`, the context expires # immediately. Contexts expire automatically after 20 minutes if there # are no matching queries. # Corresponds to the JSON property `lifespanCount` @@ -3591,9 +3595,18 @@ module Google attr_accessor :name # Optional. The collection of parameters associated with this context. - # Refer to [this - # doc](https://cloud.google.com/dialogflow/docs/intents-actions-parameters) - # for syntax. + # Depending on your protocol or client library language, this is a + # map, associative array, symbol table, dictionary, or JSON object + # composed of a collection of (MapKey, MapValue) pairs: + # - MapKey type: string + # - MapKey value: parameter name + # - MapValue type: + # - If parameter's entity type is a composite entity: map + # - Else: string + # - MapValue value: + # - If parameter's entity type is a composite entity: + # map from composite entity property names to property values + # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -3801,6 +3814,7 @@ module Google # Optional. The collection of event names that trigger the intent. # If the collection of input contexts is not empty, all of the contexts must # be present in the active user session for an event to trigger this intent. + # Event names are limited to 150 characters. # Corresponds to the JSON property `events` # @return [Array] attr_accessor :events @@ -4027,9 +4041,7 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageMediaContent] attr_accessor :media_content - # Returns a response containing a custom, platform-specific payload. - # See the Intent.Message.Platform type for a description of the - # structure that may be required for your platform. + # A custom platform-specific response. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload @@ -4703,18 +4715,18 @@ module Google # Rich Business Messaging (RBM) Media displayed in Cards # The following media-types are currently supported: - # ## Image Types - # image/jpeg - # image/jpg' - # image/gif - # image/png - # ## Video Types - # video/h263 - # video/m4v - # video/mp4 - # video/mpeg - # video/mpeg4 - # video/webm + # Image Types + # * image/jpeg + # * image/jpg' + # * image/gif + # * image/png + # Video Types + # * video/h263 + # * video/m4v + # * video/mp4 + # * video/mpeg + # * video/mpeg4 + # * video/webm # Corresponds to the JSON property `media` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia] attr_accessor :media @@ -4745,18 +4757,18 @@ module Google # Rich Business Messaging (RBM) Media displayed in Cards # The following media-types are currently supported: - # ## Image Types - # image/jpeg - # image/jpg' - # image/gif - # image/png - # ## Video Types - # video/h263 - # video/m4v - # video/mp4 - # video/mpeg - # video/mpeg4 - # video/webm + # Image Types + # * image/jpeg + # * image/jpg' + # * image/gif + # * image/png + # Video Types + # * video/h263 + # * video/m4v + # * video/mp4 + # * video/mpeg + # * video/mpeg4 + # * video/webm class GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia include Google::Apis::Core::Hashable @@ -5678,7 +5690,8 @@ module Google # Optional. This field is set to the value of the `QueryParameters.payload` # field passed in the request. Some integrations that query a Dialogflow # agent may provide additional information in the payload. - # In particular for the Telephony Gateway this field has the form: + # In particular, for the Dialogflow Phone Gateway integration, this field has + # the form: #
`
         # "telephony": `
         # "caller_id": "+18558363987"
@@ -6059,28 +6072,18 @@ module Google
         # @return [Array]
         attr_accessor :output_contexts
       
-        # Optional. This value is passed directly to `QueryResult.webhook_payload`.
-        # See the related `fulfillment_messages[i].payload field`, which may be used
-        # as an alternative to this field.
-        # This field can be used for Actions on Google responses.
-        # It should have a structure similar to the JSON message shown here. For more
-        # information, see
-        # [Actions on Google Webhook
-        # Format](https://developers.google.com/actions/dialogflow/webhook)
-        # 
`
-        # "google": `
-        # "expectUserResponse": true,
-        # "richResponse": `
-        # "items": [
-        # `
-        # "simpleResponse": `
-        # "textToSpeech": "this is a simple response"
-        # `
-        # `
-        # ]
-        # `
-        # `
-        # `
+ # Optional. This field can be used to pass custom data from your webhook to the + # API + # caller. Arbitrary JSON objects are supported. + # When provided, Dialogflow uses this field to populate + # `QueryResult.webhook_payload` sent to the API caller. + # This field is also used by the + # [Google Assistant + # integration](https://cloud.google.com/dialogflow/docs/integrations/aog) + # for rich response messages. + # See the format definition at [Google Assistant Dialogflow webhook + # format](https://developers.google.com/assistant/actions/build/json/dialogflow- + # webhook-json) # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload diff --git a/generated/google/apis/dialogflow_v2/service.rb b/generated/google/apis/dialogflow_v2/service.rb index de4e50dfe..b10f29cdc 100644 --- a/generated/google/apis/dialogflow_v2/service.rb +++ b/generated/google/apis/dialogflow_v2/service.rb @@ -520,12 +520,12 @@ module Google # Format: `projects//agent`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType] google_cloud_dialogflow_v2_entity_type_object # @param [String] language_code - # Optional. The language of entity synonyms defined in `entity_type`. If not - # specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -592,12 +592,12 @@ module Google # Required. The name of the entity type. # Format: `projects//agent/entityTypes/`. # @param [String] language_code - # Optional. The language to retrieve entity synonyms for. If not specified, - # the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -631,12 +631,12 @@ module Google # Required. The agent to list all entity types from. # Format: `projects//agent`. # @param [String] language_code - # Optional. The language to list entity synonyms for. If not specified, - # the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By # default 100 and at most 1000. @@ -680,12 +680,12 @@ module Google # Format: `projects//agent/entityTypes/`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType] google_cloud_dialogflow_v2_entity_type_object # @param [String] language_code - # Optional. The language of entity synonyms defined in `entity_type`. If not - # specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] update_mask # Optional. The mask to control which fields get updated. # @param [String] fields @@ -1395,12 +1395,12 @@ module Google # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language of training phrases, parameters and rich messages - # defined in `intent`. If not specified, the agent's default language is - # used. [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1471,12 +1471,12 @@ module Google # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language to retrieve training phrases, parameters and rich - # messages for. If not specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1513,12 +1513,12 @@ module Google # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language to list training phrases, parameters and rich - # messages for. If not specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By # default 100 and at most 1000. @@ -1557,7 +1557,7 @@ module Google # Updates the specified intent. # @param [String] name - # The unique identifier of this intent. + # Optional. The unique identifier of this intent. # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents # methods. # Format: `projects//agent/intents/`. @@ -1565,12 +1565,12 @@ module Google # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language of training phrases, parameters and rich messages - # defined in `intent`. If not specified, the agent's default language is - # used. [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] update_mask # Optional. The mask to control which fields get updated. # @param [String] fields diff --git a/generated/google/apis/dialogflow_v2beta1.rb b/generated/google/apis/dialogflow_v2beta1.rb index 68490a49b..5c2eae4e7 100644 --- a/generated/google/apis/dialogflow_v2beta1.rb +++ b/generated/google/apis/dialogflow_v2beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/dialogflow/ module DialogflowV2beta1 VERSION = 'V2beta1' - REVISION = '20200303' + REVISION = '20200408' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dialogflow_v2beta1/classes.rb b/generated/google/apis/dialogflow_v2beta1/classes.rb index dff59a37a..a406107c0 100644 --- a/generated/google/apis/dialogflow_v2beta1/classes.rb +++ b/generated/google/apis/dialogflow_v2beta1/classes.rb @@ -110,7 +110,7 @@ module Google include Google::Apis::Core::Hashable # Optional. The number of conversational query requests after which the - # context expires. If set to `0` (the default) the context expires + # context expires. The default is `0`. If set to `0`, the context expires # immediately. Contexts expire automatically after 20 minutes if there # are no matching queries. # Corresponds to the JSON property `lifespanCount` @@ -135,9 +135,18 @@ module Google attr_accessor :name # Optional. The collection of parameters associated with this context. - # Refer to [this - # doc](https://cloud.google.com/dialogflow/docs/intents-actions-parameters) - # for syntax. + # Depending on your protocol or client library language, this is a + # map, associative array, symbol table, dictionary, or JSON object + # composed of a collection of (MapKey, MapValue) pairs: + # - MapKey type: string + # - MapKey value: parameter name + # - MapValue type: + # - If parameter's entity type is a composite entity: map + # - Else: string + # - MapValue value: + # - If parameter's entity type is a composite entity: + # map from composite entity property names to property values + # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -382,6 +391,7 @@ module Google # Optional. The collection of event names that trigger the intent. # If the collection of input contexts is not empty, all of the contexts must # be present in the active user session for an event to trigger this intent. + # Event names are limited to 150 characters. # Corresponds to the JSON property `events` # @return [Array] attr_accessor :events @@ -420,7 +430,7 @@ module Google attr_accessor :ml_disabled alias_method :ml_disabled?, :ml_disabled - # The unique identifier of this intent. + # Optional. The unique identifier of this intent. # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents # methods. # Format: `projects//agent/intents/`. @@ -544,7 +554,11 @@ module Google end end - # Corresponds to the `Response` field in the Dialogflow console. + # A rich response message. + # Corresponds to the intent `Response` field in the Dialogflow console. + # For more information, see + # [Rich response + # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages). class GoogleCloudDialogflowV2IntentMessage include Google::Apis::Core::Hashable @@ -590,9 +604,7 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentMessageMediaContent] attr_accessor :media_content - # Returns a response containing a custom, platform-specific payload. - # See the Intent.Message.Platform type for a description of the - # structure that may be required for your platform. + # A custom platform-specific response. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload @@ -1703,7 +1715,8 @@ module Google # Optional. This field is set to the value of the `QueryParameters.payload` # field passed in the request. Some integrations that query a Dialogflow # agent may provide additional information in the payload. - # In particular for the Telephony Gateway this field has the form: + # In particular, for the Dialogflow Phone Gateway integration, this field has + # the form: #
`
         # "telephony": `
         # "caller_id": "+18558363987"
@@ -2064,28 +2077,18 @@ module Google
         # @return [Array]
         attr_accessor :output_contexts
       
-        # Optional. This value is passed directly to `QueryResult.webhook_payload`.
-        # See the related `fulfillment_messages[i].payload field`, which may be used
-        # as an alternative to this field.
-        # This field can be used for Actions on Google responses.
-        # It should have a structure similar to the JSON message shown here. For more
-        # information, see
-        # [Actions on Google Webhook
-        # Format](https://developers.google.com/actions/dialogflow/webhook)
-        # 
`
-        # "google": `
-        # "expectUserResponse": true,
-        # "richResponse": `
-        # "items": [
-        # `
-        # "simpleResponse": `
-        # "textToSpeech": "this is a simple response"
-        # `
-        # `
-        # ]
-        # `
-        # `
-        # `
+ # Optional. This field can be used to pass custom data from your webhook to the + # API + # caller. Arbitrary JSON objects are supported. + # When provided, Dialogflow uses this field to populate + # `QueryResult.webhook_payload` sent to the API caller. + # This field is also used by the + # [Google Assistant + # integration](https://cloud.google.com/dialogflow/docs/integrations/aog) + # for rich response messages. + # See the format definition at [Google Assistant Dialogflow webhook + # format](https://developers.google.com/assistant/actions/build/json/dialogflow- + # webhook-json) # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload @@ -2304,12 +2307,12 @@ module Google # @return [Array] attr_accessor :entities - # Optional. The language of entity synonyms defined in `entities`. If not - # specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -2336,12 +2339,12 @@ module Google # @return [Array] attr_accessor :entity_values - # Optional. The language of entity synonyms defined in `entities`. If not - # specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -2406,12 +2409,12 @@ module Google # @return [Array] attr_accessor :entities - # Optional. The language of entity synonyms defined in `entities`. If not - # specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -2450,12 +2453,12 @@ module Google # @return [String] attr_accessor :entity_type_batch_uri - # Optional. The language of entity synonyms defined in `entity_types`. If not - # specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -2518,12 +2521,12 @@ module Google # @return [String] attr_accessor :intent_view - # Optional. The language of training phrases, parameters and rich messages - # defined in `intents`. If not specified, the agent's default language is - # used. [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -2571,7 +2574,7 @@ module Google include Google::Apis::Core::Hashable # Optional. The number of conversational query requests after which the - # context expires. If set to `0` (the default) the context expires + # context expires. The default is `0`. If set to `0`, the context expires # immediately. Contexts expire automatically after 20 minutes if there # are no matching queries. # Corresponds to the JSON property `lifespanCount` @@ -2596,9 +2599,18 @@ module Google attr_accessor :name # Optional. The collection of parameters associated with this context. - # Refer to [this - # doc](https://cloud.google.com/dialogflow/docs/intents-actions-parameters) - # for syntax. + # Depending on your protocol or client library language, this is a + # map, associative array, symbol table, dictionary, or JSON object + # composed of a collection of (MapKey, MapValue) pairs: + # - MapKey type: string + # - MapKey value: parameter name + # - MapValue type: + # - If parameter's entity type is a composite entity: map + # - Else: string + # - MapValue value: + # - If parameter's entity type is a composite entity: + # map from composite entity property names to property values + # - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -2615,8 +2627,6 @@ module Google end end - # ============================================================================ - # Requests and responses for custom methods. # The request to detect user's intent. class GoogleCloudDialogflowV2beta1DetectIntentRequest include Google::Apis::Core::Hashable @@ -3192,7 +3202,7 @@ module Google # @return [String] attr_accessor :audio_encoding - # Optional. If `true`, Dialogflow returns SpeechWordInfo in + # If `true`, Dialogflow returns SpeechWordInfo in # StreamingRecognitionResult with information about the recognized speech # words, e.g. start and end time offsets. If false or unspecified, Speech # doesn't return any word-level information. @@ -3210,7 +3220,7 @@ module Google # @return [String] attr_accessor :language_code - # Optional. Which Speech model to select for the given request. Select the + # Which Speech model to select for the given request. Select the # model best suited to your domain to get best results. If a model is not # explicitly specified, then we auto-select a model based on the parameters # in the InputAudioConfig. @@ -3226,12 +3236,12 @@ module Google # @return [String] attr_accessor :model - # Optional. Which variant of the Speech model to use. + # Which variant of the Speech model to use. # Corresponds to the JSON property `modelVariant` # @return [String] attr_accessor :model_variant - # Optional. A list of strings containing words and phrases that the speech + # A list of strings containing words and phrases that the speech # recognizer should recognize with higher likelihood. # See [the Cloud Speech # documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase- @@ -3253,7 +3263,7 @@ module Google # @return [Fixnum] attr_accessor :sample_rate_hertz - # Optional. If `false` (default), recognition does not cease until the + # If `false` (default), recognition does not cease until the # client closes the stream. # If `true`, the recognizer will detect a single spoken utterance in input # audio. Recognition ceases when it detects the audio's voice has @@ -3268,7 +3278,7 @@ module Google attr_accessor :single_utterance alias_method :single_utterance?, :single_utterance - # Optional. Context information to assist speech recognition. + # Context information to assist speech recognition. # See [the Cloud Speech # documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase- # hints) @@ -3329,6 +3339,7 @@ module Google # Optional. The collection of event names that trigger the intent. # If the collection of input contexts is not empty, all of the contexts must # be present in the active user session for an event to trigger this intent. + # Event names are limited to 150 characters. # Corresponds to the JSON property `events` # @return [Array] attr_accessor :events @@ -3574,9 +3585,7 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageMediaContent] attr_accessor :media_content - # Returns a response containing a custom, platform-specific payload. - # See the Intent.Message.Platform type for a description of the - # structure that may be required for your platform. + # A custom platform-specific response. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload @@ -4250,18 +4259,18 @@ module Google # Rich Business Messaging (RBM) Media displayed in Cards # The following media-types are currently supported: - # ## Image Types - # image/jpeg - # image/jpg' - # image/gif - # image/png - # ## Video Types - # video/h263 - # video/m4v - # video/mp4 - # video/mpeg - # video/mpeg4 - # video/webm + # Image Types + # * image/jpeg + # * image/jpg' + # * image/gif + # * image/png + # Video Types + # * video/h263 + # * video/m4v + # * video/mp4 + # * video/mpeg + # * video/mpeg4 + # * video/webm # Corresponds to the JSON property `media` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia] attr_accessor :media @@ -4292,18 +4301,18 @@ module Google # Rich Business Messaging (RBM) Media displayed in Cards # The following media-types are currently supported: - # ## Image Types - # image/jpeg - # image/jpg' - # image/gif - # image/png - # ## Video Types - # video/h263 - # video/m4v - # video/mp4 - # video/mpeg - # video/mpeg4 - # video/webm + # Image Types + # * image/jpeg + # * image/jpg' + # * image/gif + # * image/png + # Video Types + # * video/h263 + # * video/m4v + # * video/mp4 + # * video/mpeg + # * video/mpeg4 + # * video/webm class GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia include Google::Apis::Core::Hashable @@ -5423,7 +5432,8 @@ module Google # Optional. This field is set to the value of the `QueryParameters.payload` # field passed in the request. Some integrations that query a Dialogflow # agent may provide additional information in the payload. - # In particular for the Telephony Gateway this field has the form: + # In particular, for the Dialogflow Phone Gateway integration, this field has + # the form: #
`
         # "telephony": `
         # "caller_id": "+18558363987"
@@ -5562,8 +5572,11 @@ module Google
         # @return [Array]
         attr_accessor :knowledge_base_names
       
-        # This field can be used to pass custom data into the webhook
-        # associated with the agent. Arbitrary JSON objects are supported.
+        # This field can be used to pass custom data to your webhook.
+        # Arbitrary JSON objects are supported.
+        # If supplied, the value is used to populate the
+        # `WebhookRequest.original_detect_intent_request.payload`
+        # field sent to your webhook.
         # Corresponds to the JSON property `payload`
         # @return [Hash]
         attr_accessor :payload
@@ -6334,28 +6347,18 @@ module Google
         # @return [Array]
         attr_accessor :output_contexts
       
-        # Optional. This value is passed directly to `QueryResult.webhook_payload`.
-        # See the related `fulfillment_messages[i].payload field`, which may be used
-        # as an alternative to this field.
-        # This field can be used for Actions on Google responses.
-        # It should have a structure similar to the JSON message shown here. For more
-        # information, see
-        # [Actions on Google Webhook
-        # Format](https://developers.google.com/actions/dialogflow/webhook)
-        # 
`
-        # "google": `
-        # "expectUserResponse": true,
-        # "richResponse": `
-        # "items": [
-        # `
-        # "simpleResponse": `
-        # "textToSpeech": "this is a simple response"
-        # `
-        # `
-        # ]
-        # `
-        # `
-        # `
+ # Optional. This field can be used to pass custom data from your webhook to the + # API + # caller. Arbitrary JSON objects are supported. + # When provided, Dialogflow uses this field to populate + # `QueryResult.webhook_payload` sent to the API caller. + # This field is also used by the + # [Google Assistant + # integration](https://cloud.google.com/dialogflow/docs/integrations/aog) + # for rich response messages. + # See the format definition at [Google Assistant Dialogflow webhook + # format](https://developers.google.com/assistant/actions/build/json/dialogflow- + # webhook-json) # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload diff --git a/generated/google/apis/dialogflow_v2beta1/service.rb b/generated/google/apis/dialogflow_v2beta1/service.rb index 203643041..194d5bd18 100644 --- a/generated/google/apis/dialogflow_v2beta1/service.rb +++ b/generated/google/apis/dialogflow_v2beta1/service.rb @@ -520,12 +520,12 @@ module Google # Format: `projects//agent`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType] google_cloud_dialogflow_v2beta1_entity_type_object # @param [String] language_code - # Optional. The language of entity synonyms defined in `entity_type`. If not - # specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -592,12 +592,12 @@ module Google # Required. The name of the entity type. # Format: `projects//agent/entityTypes/`. # @param [String] language_code - # Optional. The language to retrieve entity synonyms for. If not specified, - # the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -631,12 +631,12 @@ module Google # Required. The agent to list all entity types from. # Format: `projects//agent`. # @param [String] language_code - # Optional. The language to list entity synonyms for. If not specified, - # the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By # default 100 and at most 1000. @@ -680,12 +680,12 @@ module Google # Format: `projects//agent/entityTypes/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType] google_cloud_dialogflow_v2beta1_entity_type_object # @param [String] language_code - # Optional. The language of entity synonyms defined in `entity_type`. If not - # specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] update_mask # Optional. The mask to control which fields get updated. # @param [String] fields @@ -1392,12 +1392,12 @@ module Google # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language of training phrases, parameters and rich messages - # defined in `intent`. If not specified, the agent's default language is - # used. [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1468,12 +1468,12 @@ module Google # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language to retrieve training phrases, parameters and rich - # messages for. If not specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1510,12 +1510,12 @@ module Google # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language to list training phrases, parameters and rich - # messages for. If not specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By # default 100 and at most 1000. @@ -1562,12 +1562,12 @@ module Google # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language of training phrases, parameters and rich messages - # defined in `intent`. If not specified, the agent's default language is - # used. [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] update_mask # Optional. The mask to control which fields get updated. # @param [String] fields @@ -3309,12 +3309,12 @@ module Google # Format: `projects//agent`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType] google_cloud_dialogflow_v2beta1_entity_type_object # @param [String] language_code - # Optional. The language of entity synonyms defined in `entity_type`. If not - # specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3381,12 +3381,12 @@ module Google # Required. The name of the entity type. # Format: `projects//agent/entityTypes/`. # @param [String] language_code - # Optional. The language to retrieve entity synonyms for. If not specified, - # the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3420,12 +3420,12 @@ module Google # Required. The agent to list all entity types from. # Format: `projects//agent`. # @param [String] language_code - # Optional. The language to list entity synonyms for. If not specified, - # the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By # default 100 and at most 1000. @@ -3469,12 +3469,12 @@ module Google # Format: `projects//agent/entityTypes/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType] google_cloud_dialogflow_v2beta1_entity_type_object # @param [String] language_code - # Optional. The language of entity synonyms defined in `entity_type`. If not - # specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] update_mask # Optional. The mask to control which fields get updated. # @param [String] fields @@ -4181,12 +4181,12 @@ module Google # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language of training phrases, parameters and rich messages - # defined in `intent`. If not specified, the agent's default language is - # used. [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4257,12 +4257,12 @@ module Google # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language to retrieve training phrases, parameters and rich - # messages for. If not specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4299,12 +4299,12 @@ module Google # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language to list training phrases, parameters and rich - # messages for. If not specified, the agent's default language is used. - # [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By # default 100 and at most 1000. @@ -4351,12 +4351,12 @@ module Google # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language of training phrases, parameters and rich messages - # defined in `intent`. If not specified, the agent's default language is - # used. [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # Optional. The language used to access language-specific data. + # If not specified, the agent's default language is used. + # For more information, see + # [Multilingual intent and entity + # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- + # entity). # @param [String] update_mask # Optional. The mask to control which fields get updated. # @param [String] fields diff --git a/generated/google/apis/dlp_v2.rb b/generated/google/apis/dlp_v2.rb index 98c461dbd..4f45e6079 100644 --- a/generated/google/apis/dlp_v2.rb +++ b/generated/google/apis/dlp_v2.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/dlp/docs/ module DlpV2 VERSION = 'V2' - REVISION = '20200308' + REVISION = '20200405' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dlp_v2/classes.rb b/generated/google/apis/dlp_v2/classes.rb index 1cff00c69..a484ce09c 100644 --- a/generated/google/apis/dlp_v2/classes.rb +++ b/generated/google/apis/dlp_v2/classes.rb @@ -747,6 +747,9 @@ module Google # If empty, all files are scanned and available data format processors # are applied. In addition, the binary content of the selected files # is always scanned as well. + # Images are scanned only as binary if the specified region + # does not support image inspection and no file_types were specified. + # Image inspection is restricted to 'global', 'us', 'asia', and 'europe'. # Corresponds to the JSON property `fileTypes` # @return [Array] attr_accessor :file_types @@ -1116,6 +1119,11 @@ module Google # @return [Google::Apis::DlpV2::GooglePrivacyDlpV2ImageLocation] attr_accessor :image_location + # Metadata Location + # Corresponds to the JSON property `metadataLocation` + # @return [Google::Apis::DlpV2::GooglePrivacyDlpV2MetadataLocation] + attr_accessor :metadata_location + # Location of a finding within a row or record. # Corresponds to the JSON property `recordLocation` # @return [Google::Apis::DlpV2::GooglePrivacyDlpV2RecordLocation] @@ -1132,6 +1140,7 @@ module Google @container_version = args[:container_version] if args.key?(:container_version) @document_location = args[:document_location] if args.key?(:document_location) @image_location = args[:image_location] if args.key?(:image_location) + @metadata_location = args[:metadata_location] if args.key?(:metadata_location) @record_location = args[:record_location] if args.key?(:record_location) end end @@ -2547,12 +2556,13 @@ module Google # The labels associated with this `Finding`. # Label keys must be between 1 and 63 characters long and must conform - # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. + # to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. # Label values must be between 0 and 63 characters long and must conform - # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. + # to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. # No more than 10 labels can be associated with a given finding. - # Example: "environment" : "production" - # Example: "pipeline" : "etl" + # Examples: + # * `"environment" : "production"` + # * `"pipeline" : "etl"` # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -2806,12 +2816,13 @@ module Google # The labels associated with `Finding`'s produced by hybrid # inspection. # Label keys must be between 1 and 63 characters long and must conform - # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. + # to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. # Label values must be between 0 and 63 characters long and must conform - # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. + # to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. # No more than 10 labels can be associated with a given finding. - # Example: "environment" : "production" - # Example: "pipeline" : "etl" + # Examples: + # * `"environment" : "production"` + # * `"pipeline" : "etl"` # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -2944,12 +2955,13 @@ module Google # To organize findings, these labels will be added to each finding. # Label keys must be between 1 and 63 characters long and must conform - # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. + # to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. # Label values must be between 0 and 63 characters long and must conform - # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. + # to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. # No more than 10 labels can be associated with a given finding. - # Example: "environment" : "production" - # Example: "pipeline" : "etl" + # Examples: + # * `"environment" : "production"` + # * `"pipeline" : "etl"` # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -2958,7 +2970,7 @@ module Google # 'finding_labels' map. Request may contain others, but any missing one of # these will be rejected. # Label keys must be between 1 and 63 characters long and must conform - # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. + # to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. # No more than 10 keys can be required. # Corresponds to the JSON property `requiredFindingLabelKeys` # @return [Array] @@ -3042,7 +3054,7 @@ module Google # creating a CustomInfoType, or one of the names listed # at https://cloud.google.com/dlp/docs/infotypes-reference when specifying # a built-in type. InfoType names should conform to the pattern - # [a-zA-Z0-9_]`1,64`. + # `[a-zA-Z0-9_]`1,64``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3304,6 +3316,8 @@ module Google # The geographic location to process content inspection. Reserved for future # extensions. + # When inspecting images location is restricted to 'global', 'us', 'asia', + # and 'europe'. # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id @@ -4398,6 +4412,12 @@ module Google # @return [Google::Apis::DlpV2::GooglePrivacyDlpV2Range] attr_accessor :codepoint_range + # Represents a container that may contain DLP findings. + # Examples of a container include a file, table, or database record. + # Corresponds to the JSON property `container` + # @return [Google::Apis::DlpV2::GooglePrivacyDlpV2Container] + attr_accessor :container + # List of nested objects pointing to the precise location of the finding # within the file or record. # Corresponds to the JSON property `contentLocations` @@ -4412,6 +4432,7 @@ module Google def update!(**args) @byte_range = args[:byte_range] if args.key?(:byte_range) @codepoint_range = args[:codepoint_range] if args.key?(:codepoint_range) + @container = args[:container] if args.key?(:container) @content_locations = args[:content_locations] if args.key?(:content_locations) end end @@ -4430,6 +4451,31 @@ module Google end end + # Metadata Location + class GooglePrivacyDlpV2MetadataLocation + include Google::Apis::Core::Hashable + + # Storage metadata label to indicate which metadata entry contains findings. + # Corresponds to the JSON property `storageLabel` + # @return [Google::Apis::DlpV2::GooglePrivacyDlpV2StorageMetadataLabel] + attr_accessor :storage_label + + # Type of metadata containing the finding. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @storage_label = args[:storage_label] if args.key?(:storage_label) + @type = args[:type] if args.key?(:type) + end + end + # Compute numerical stats over an individual column, including # min, max, and quantiles. class GooglePrivacyDlpV2NumericalStatsConfig @@ -5218,6 +5264,7 @@ module Google # The geographic location to process the request. Reserved for future # extensions. + # Location is restricted to 'global', 'us', 'asia', and 'europe'. # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id @@ -5676,6 +5723,25 @@ module Google end end + # Storage metadata label to indicate which metadata entry contains findings. + class GooglePrivacyDlpV2StorageMetadataLabel + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @key = args[:key] if args.key?(:key) + end + end + # StoredInfoType resource message that contains information about the current # version and any pending updates. class GooglePrivacyDlpV2StoredInfoType diff --git a/generated/google/apis/dlp_v2/representations.rb b/generated/google/apis/dlp_v2/representations.rb index fc5ff8b57..64b06e427 100644 --- a/generated/google/apis/dlp_v2/representations.rb +++ b/generated/google/apis/dlp_v2/representations.rb @@ -742,6 +742,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GooglePrivacyDlpV2MetadataLocation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GooglePrivacyDlpV2NumericalStatsConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -970,6 +976,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GooglePrivacyDlpV2StorageMetadataLabel + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GooglePrivacyDlpV2StoredInfoType class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1452,6 +1464,8 @@ module Google property :image_location, as: 'imageLocation', class: Google::Apis::DlpV2::GooglePrivacyDlpV2ImageLocation, decorator: Google::Apis::DlpV2::GooglePrivacyDlpV2ImageLocation::Representation + property :metadata_location, as: 'metadataLocation', class: Google::Apis::DlpV2::GooglePrivacyDlpV2MetadataLocation, decorator: Google::Apis::DlpV2::GooglePrivacyDlpV2MetadataLocation::Representation + property :record_location, as: 'recordLocation', class: Google::Apis::DlpV2::GooglePrivacyDlpV2RecordLocation, decorator: Google::Apis::DlpV2::GooglePrivacyDlpV2RecordLocation::Representation end @@ -2394,6 +2408,8 @@ module Google property :codepoint_range, as: 'codepointRange', class: Google::Apis::DlpV2::GooglePrivacyDlpV2Range, decorator: Google::Apis::DlpV2::GooglePrivacyDlpV2Range::Representation + property :container, as: 'container', class: Google::Apis::DlpV2::GooglePrivacyDlpV2Container, decorator: Google::Apis::DlpV2::GooglePrivacyDlpV2Container::Representation + collection :content_locations, as: 'contentLocations', class: Google::Apis::DlpV2::GooglePrivacyDlpV2ContentLocation, decorator: Google::Apis::DlpV2::GooglePrivacyDlpV2ContentLocation::Representation end @@ -2405,6 +2421,15 @@ module Google end end + class GooglePrivacyDlpV2MetadataLocation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :storage_label, as: 'storageLabel', class: Google::Apis::DlpV2::GooglePrivacyDlpV2StorageMetadataLabel, decorator: Google::Apis::DlpV2::GooglePrivacyDlpV2StorageMetadataLabel::Representation + + property :type, as: 'type' + end + end + class GooglePrivacyDlpV2NumericalStatsConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2788,6 +2813,13 @@ module Google end end + class GooglePrivacyDlpV2StorageMetadataLabel + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + end + end + class GooglePrivacyDlpV2StoredInfoType # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/dlp_v2/service.rb b/generated/google/apis/dlp_v2/service.rb index 32a04ca94..81cb6f0e4 100644 --- a/generated/google/apis/dlp_v2/service.rb +++ b/generated/google/apis/dlp_v2/service.rb @@ -2420,6 +2420,8 @@ module Google # @param [String] location_id # The geographic location to process content inspection. Reserved for future # extensions. + # When inspecting images location is restricted to 'global', 'us', 'asia', + # and 'europe'. # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2InspectContentRequest] google_privacy_dlp_v2_inspect_content_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3013,6 +3015,7 @@ module Google # @param [String] location_id # The geographic location to process the request. Reserved for future # extensions. + # Location is restricted to 'global', 'us', 'asia', and 'europe'. # @param [Google::Apis::DlpV2::GooglePrivacyDlpV2RedactImageRequest] google_privacy_dlp_v2_redact_image_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/doubleclickbidmanager_v1_1.rb b/generated/google/apis/doubleclickbidmanager_v1_1.rb index 34b122475..7447b08b8 100644 --- a/generated/google/apis/doubleclickbidmanager_v1_1.rb +++ b/generated/google/apis/doubleclickbidmanager_v1_1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/bid-manager/ module DoubleclickbidmanagerV1_1 VERSION = 'V1_1' - REVISION = '20200220' + REVISION = '20200316' # View and manage your reports in DoubleClick Bid Manager AUTH_DOUBLECLICKBIDMANAGER = 'https://www.googleapis.com/auth/doubleclickbidmanager' diff --git a/generated/google/apis/doubleclickbidmanager_v1_1/service.rb b/generated/google/apis/doubleclickbidmanager_v1_1/service.rb index 175eea979..248f5b47b 100644 --- a/generated/google/apis/doubleclickbidmanager_v1_1/service.rb +++ b/generated/google/apis/doubleclickbidmanager_v1_1/service.rb @@ -119,6 +119,9 @@ module Google # Creates a query. # @param [Google::Apis::DoubleclickbidmanagerV1_1::Query] query_object + # @param [Boolean] asynchronous + # If true, tries to run the query asynchronously. Only applicable when the + # frequency is ONE_TIME. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -138,12 +141,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def createquery_query(query_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def createquery_query(query_object = nil, asynchronous: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'query', options) command.request_representation = Google::Apis::DoubleclickbidmanagerV1_1::Query::Representation command.request_object = query_object command.response_representation = Google::Apis::DoubleclickbidmanagerV1_1::Query::Representation command.response_class = Google::Apis::DoubleclickbidmanagerV1_1::Query + command.query['asynchronous'] = asynchronous unless asynchronous.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -255,6 +259,8 @@ module Google # @param [Fixnum] query_id # Query ID to run. # @param [Google::Apis::DoubleclickbidmanagerV1_1::RunQueryRequest] run_query_request_object + # @param [Boolean] asynchronous + # If true, tries to run the query asynchronously. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -274,11 +280,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def runquery_query(query_id, run_query_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def runquery_query(query_id, run_query_request_object = nil, asynchronous: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'query/{queryId}', options) command.request_representation = Google::Apis::DoubleclickbidmanagerV1_1::RunQueryRequest::Representation command.request_object = run_query_request_object command.params['queryId'] = query_id unless query_id.nil? + command.query['asynchronous'] = asynchronous unless asynchronous.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? diff --git a/generated/google/apis/doubleclicksearch_v2.rb b/generated/google/apis/doubleclicksearch_v2.rb index 812ca11a0..49b075a95 100644 --- a/generated/google/apis/doubleclicksearch_v2.rb +++ b/generated/google/apis/doubleclicksearch_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/doubleclick-search/ module DoubleclicksearchV2 VERSION = 'V2' - REVISION = '20190821' + REVISION = '20200325' # View and manage your advertising data in DoubleClick Search AUTH_DOUBLECLICKSEARCH = 'https://www.googleapis.com/auth/doubleclicksearch' diff --git a/generated/google/apis/doubleclicksearch_v2/service.rb b/generated/google/apis/doubleclicksearch_v2/service.rb index 0d63dea03..a7605cab6 100644 --- a/generated/google/apis/doubleclicksearch_v2/service.rb +++ b/generated/google/apis/doubleclicksearch_v2/service.rb @@ -148,61 +148,6 @@ module Google execute_or_queue_command(command, &block) end - # Updates a batch of conversions in DoubleClick Search. This method supports - # patch semantics. - # @param [Fixnum] advertiser_id - # Numeric ID of the advertiser. - # @param [Fixnum] agency_id - # Numeric ID of the agency. - # @param [Fixnum] end_date - # Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. - # @param [Fixnum] engine_account_id - # Numeric ID of the engine account. - # @param [Fixnum] row_count - # The number of conversions to return per call. - # @param [Fixnum] start_date - # First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. - # @param [Fixnum] start_row - # The 0-based starting index for retrieving conversions results. - # @param [Google::Apis::DoubleclicksearchV2::ConversionList] conversion_list_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DoubleclicksearchV2::ConversionList] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DoubleclicksearchV2::ConversionList] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_conversion(advertiser_id, agency_id, end_date, engine_account_id, row_count, start_date, start_row, conversion_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'conversion', options) - command.request_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation - command.request_object = conversion_list_object - command.response_representation = Google::Apis::DoubleclicksearchV2::ConversionList::Representation - command.response_class = Google::Apis::DoubleclicksearchV2::ConversionList - command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? - command.query['agencyId'] = agency_id unless agency_id.nil? - command.query['endDate'] = end_date unless end_date.nil? - command.query['engineAccountId'] = engine_account_id unless engine_account_id.nil? - command.query['rowCount'] = row_count unless row_count.nil? - command.query['startDate'] = start_date unless start_date.nil? - command.query['startRow'] = start_row unless start_row.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - # Updates a batch of conversions in DoubleClick Search. # @param [Google::Apis::DoubleclicksearchV2::ConversionList] conversion_list_object # @param [String] fields diff --git a/generated/google/apis/drive_v2.rb b/generated/google/apis/drive_v2.rb index e794e077a..4b9968114 100644 --- a/generated/google/apis/drive_v2.rb +++ b/generated/google/apis/drive_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/drive/ module DriveV2 VERSION = 'V2' - REVISION = '20200110' + REVISION = '20200326' # See, edit, create, and delete all of your Google Drive files AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' diff --git a/generated/google/apis/drive_v2/classes.rb b/generated/google/apis/drive_v2/classes.rb index 3d4e5840c..d30a6e3c4 100644 --- a/generated/google/apis/drive_v2/classes.rb +++ b/generated/google/apis/drive_v2/classes.rb @@ -2040,6 +2040,12 @@ module Google # @return [Google::Apis::DriveV2::User] attr_accessor :sharing_user + # Shortcut file details. Only populated for shortcut files, which have the + # mimeType field set to application/vnd.google-apps.shortcut. + # Corresponds to the JSON property `shortcutDetails` + # @return [Google::Apis::DriveV2::File::ShortcutDetails] + attr_accessor :shortcut_details + # The list of spaces which contain the file. Supported values are 'drive', ' # appDataFolder' and 'photos'. # Corresponds to the JSON property `spaces` @@ -2183,6 +2189,7 @@ module Google @shared = args[:shared] if args.key?(:shared) @shared_with_me_date = args[:shared_with_me_date] if args.key?(:shared_with_me_date) @sharing_user = args[:sharing_user] if args.key?(:sharing_user) + @shortcut_details = args[:shortcut_details] if args.key?(:shortcut_details) @spaces = args[:spaces] if args.key?(:spaces) @team_drive_id = args[:team_drive_id] if args.key?(:team_drive_id) @thumbnail = args[:thumbnail] if args.key?(:thumbnail) @@ -2211,6 +2218,13 @@ module Google attr_accessor :can_add_children alias_method :can_add_children?, :can_add_children + # Whether the current user can add a parent for the item without removing an + # existing parent in the same request. Not populated for shared drive files. + # Corresponds to the JSON property `canAddMyDriveParent` + # @return [Boolean] + attr_accessor :can_add_my_drive_parent + alias_method :can_add_my_drive_parent?, :can_add_my_drive_parent + # Whether the current user can change the copyRequiresWriterPermission # restriction of this file. # Corresponds to the JSON property `canChangeCopyRequiresWriterPermission` @@ -2375,6 +2389,13 @@ module Google attr_accessor :can_remove_children alias_method :can_remove_children?, :can_remove_children + # Whether the current user can remove a parent from the item without adding + # another parent in the same request. Not populated for shared drive files. + # Corresponds to the JSON property `canRemoveMyDriveParent` + # @return [Boolean] + attr_accessor :can_remove_my_drive_parent + alias_method :can_remove_my_drive_parent?, :can_remove_my_drive_parent + # Whether the current user can rename this file. # Corresponds to the JSON property `canRename` # @return [Boolean] @@ -2413,6 +2434,7 @@ module Google # Update properties of this object def update!(**args) @can_add_children = args[:can_add_children] if args.key?(:can_add_children) + @can_add_my_drive_parent = args[:can_add_my_drive_parent] if args.key?(:can_add_my_drive_parent) @can_change_copy_requires_writer_permission = args[:can_change_copy_requires_writer_permission] if args.key?(:can_change_copy_requires_writer_permission) @can_change_restricted_download = args[:can_change_restricted_download] if args.key?(:can_change_restricted_download) @can_comment = args[:can_comment] if args.key?(:can_comment) @@ -2437,6 +2459,7 @@ module Google @can_read_revisions = args[:can_read_revisions] if args.key?(:can_read_revisions) @can_read_team_drive = args[:can_read_team_drive] if args.key?(:can_read_team_drive) @can_remove_children = args[:can_remove_children] if args.key?(:can_remove_children) + @can_remove_my_drive_parent = args[:can_remove_my_drive_parent] if args.key?(:can_remove_my_drive_parent) @can_rename = args[:can_rename] if args.key?(:can_rename) @can_share = args[:can_share] if args.key?(:can_share) @can_trash = args[:can_trash] if args.key?(:can_trash) @@ -2532,7 +2555,8 @@ module Google # @return [String] attr_accessor :metering_mode - # The rotation in clockwise degrees from the image's original orientation. + # The number of clockwise 90 degree rotations applied from the image's original + # orientation. # Corresponds to the JSON property `rotation` # @return [Fixnum] attr_accessor :rotation @@ -2693,6 +2717,34 @@ module Google end end + # Shortcut file details. Only populated for shortcut files, which have the + # mimeType field set to application/vnd.google-apps.shortcut. + class ShortcutDetails + include Google::Apis::Core::Hashable + + # The ID of the file that this shortcut points to. + # Corresponds to the JSON property `targetId` + # @return [String] + attr_accessor :target_id + + # The MIME type of the file that this shortcut points to. The value of this + # field is a snapshot of the target's MIME type, captured when the shortcut is + # created. + # Corresponds to the JSON property `targetMimeType` + # @return [String] + attr_accessor :target_mime_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @target_id = args[:target_id] if args.key?(:target_id) + @target_mime_type = args[:target_mime_type] if args.key?(:target_mime_type) + end + end + # A thumbnail for the file. This will only be used if a standard thumbnail # cannot be generated. class Thumbnail @@ -3097,7 +3149,7 @@ module Google alias_method :inherited?, :inherited # The ID of the item from which this permission is inherited. This is an output- - # only field and is only populated for members of the shared drive. + # only field. # Corresponds to the JSON property `inheritedFrom` # @return [String] attr_accessor :inherited_from diff --git a/generated/google/apis/drive_v2/representations.rb b/generated/google/apis/drive_v2/representations.rb index c8d149efa..4f571c177 100644 --- a/generated/google/apis/drive_v2/representations.rb +++ b/generated/google/apis/drive_v2/representations.rb @@ -223,6 +223,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ShortcutDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Thumbnail class Representation < Google::Apis::Core::JsonRepresentation; end @@ -835,6 +841,8 @@ module Google property :sharing_user, as: 'sharingUser', class: Google::Apis::DriveV2::User, decorator: Google::Apis::DriveV2::User::Representation + property :shortcut_details, as: 'shortcutDetails', class: Google::Apis::DriveV2::File::ShortcutDetails, decorator: Google::Apis::DriveV2::File::ShortcutDetails::Representation + collection :spaces, as: 'spaces' property :team_drive_id, as: 'teamDriveId' property :thumbnail, as: 'thumbnail', class: Google::Apis::DriveV2::File::Thumbnail, decorator: Google::Apis::DriveV2::File::Thumbnail::Representation @@ -860,6 +868,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :can_add_children, as: 'canAddChildren' + property :can_add_my_drive_parent, as: 'canAddMyDriveParent' property :can_change_copy_requires_writer_permission, as: 'canChangeCopyRequiresWriterPermission' property :can_change_restricted_download, as: 'canChangeRestrictedDownload' property :can_comment, as: 'canComment' @@ -884,6 +893,7 @@ module Google property :can_read_revisions, as: 'canReadRevisions' property :can_read_team_drive, as: 'canReadTeamDrive' property :can_remove_children, as: 'canRemoveChildren' + property :can_remove_my_drive_parent, as: 'canRemoveMyDriveParent' property :can_rename, as: 'canRename' property :can_share, as: 'canShare' property :can_trash, as: 'canTrash' @@ -948,6 +958,14 @@ module Google end end + class ShortcutDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :target_id, as: 'targetId' + property :target_mime_type, as: 'targetMimeType' + end + end + class Thumbnail # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/drive_v2/service.rb b/generated/google/apis/drive_v2/service.rb index 2276f38f5..8e72ea481 100644 --- a/generated/google/apis/drive_v2/service.rb +++ b/generated/google/apis/drive_v2/service.rb @@ -476,6 +476,11 @@ module Google # The ID of the folder. # @param [String] child_id # The ID of the child. + # @param [Boolean] enforce_single_parent + # Set to true to opt in to API behavior that aims for all items to have exactly + # one parent. This parameter will only take effect if the item is not in a + # shared drive. If the item's last parent is removed, the item will be placed + # under its owner's root. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -495,10 +500,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_child(folder_id, child_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def delete_child(folder_id, child_id, enforce_single_parent: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'files/{folderId}/children/{childId}', options) command.params['folderId'] = folder_id unless folder_id.nil? command.params['childId'] = child_id unless child_id.nil? + command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -545,6 +551,14 @@ module Google # @param [String] folder_id # The ID of the folder. # @param [Google::Apis::DriveV2::ChildReference] child_reference_object + # @param [Boolean] enforce_single_parent + # Set to true to opt in to API behavior that aims for all items to have exactly + # one parent. This parameter will only take effect if the item is not in a + # shared drive. If the child's owner makes the request, the child will be + # removed from all current folders and placed in the requested folder. Any other + # requests that increase the number of the child's parents will fail, except + # when the canAddMyDriveParent file capability is true and a single parent is + # being added. # @param [Boolean] supports_all_drives # Deprecated - Whether the requesting application supports both My Drives and # shared drives. This parameter will only be effective until June 1, 2020. @@ -570,13 +584,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_child(folder_id, child_reference_object = nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def insert_child(folder_id, child_reference_object = nil, enforce_single_parent: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'files/{folderId}/children', options) command.request_representation = Google::Apis::DriveV2::ChildReference::Representation command.request_object = child_reference_object command.response_representation = Google::Apis::DriveV2::ChildReference::Representation command.response_class = Google::Apis::DriveV2::ChildReference command.params['folderId'] = folder_id unless folder_id.nil? + command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil? command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil? command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil? command.query['fields'] = fields unless fields.nil? @@ -1139,6 +1154,10 @@ module Google # @param [Google::Apis::DriveV2::File] file_object # @param [Boolean] convert # Whether to convert this file to the corresponding Google Docs format. + # @param [Boolean] enforce_single_parent + # Set to true to opt in to API behavior that aims for all items to have exactly + # one parent. This parameter will only take effect if the item is not in a + # shared drive. Requests that specify more than one parent will fail. # @param [Boolean] ocr # Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. # @param [String] ocr_language @@ -1178,7 +1197,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def copy_file(file_id, file_object = nil, convert: nil, ocr: nil, ocr_language: nil, pinned: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def copy_file(file_id, file_object = nil, convert: nil, enforce_single_parent: nil, ocr: nil, ocr_language: nil, pinned: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'files/{fileId}/copy', options) command.request_representation = Google::Apis::DriveV2::File::Representation command.request_object = file_object @@ -1186,6 +1205,7 @@ module Google command.response_class = Google::Apis::DriveV2::File command.params['fileId'] = file_id unless file_id.nil? command.query['convert'] = convert unless convert.nil? + command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil? command.query['ocr'] = ocr unless ocr.nil? command.query['ocrLanguage'] = ocr_language unless ocr_language.nil? command.query['pinned'] = pinned unless pinned.nil? @@ -1414,6 +1434,10 @@ module Google # @param [Google::Apis::DriveV2::File] file_object # @param [Boolean] convert # Whether to convert this file to the corresponding Google Docs format. + # @param [Boolean] enforce_single_parent + # Set to true to opt in to API behavior that aims for all items to have exactly + # one parent. This parameter will only take effect if the item is not in a + # shared drive. Requests that specify more than one parent will fail. # @param [Boolean] ocr # Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. # @param [String] ocr_language @@ -1459,7 +1483,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_file(file_object = nil, convert: nil, ocr: nil, ocr_language: nil, pinned: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, use_content_as_indexable_text: nil, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) + def insert_file(file_object = nil, convert: nil, enforce_single_parent: nil, ocr: nil, ocr_language: nil, pinned: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, use_content_as_indexable_text: nil, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? command = make_simple_command(:post, 'files', options) else @@ -1472,6 +1496,7 @@ module Google command.response_representation = Google::Apis::DriveV2::File::Representation command.response_class = Google::Apis::DriveV2::File command.query['convert'] = convert unless convert.nil? + command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil? command.query['ocr'] = ocr unless ocr.nil? command.query['ocrLanguage'] = ocr_language unless ocr_language.nil? command.query['pinned'] = pinned unless pinned.nil? @@ -1582,6 +1607,14 @@ module Google # Comma-separated list of parent IDs to add. # @param [Boolean] convert # This parameter is deprecated and has no function. + # @param [Boolean] enforce_single_parent + # Set to true to opt in to API behavior that aims for all items to have exactly + # one parent. This parameter will only take effect if the item is not in a + # shared drive. If the item's owner makes a request to add a single parent, the + # item will be removed from all current folders and placed in the requested + # folder. Other requests that increase the number of parents will fail, except + # when the canAddMyDriveParent file capability is true and a single parent is + # being added. # @param [String] modified_date_behavior # Determines the behavior in which modifiedDate is updated. This overrides # setModifiedDate. @@ -1639,7 +1672,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_file(file_id, file_object = nil, add_parents: nil, convert: nil, modified_date_behavior: nil, new_revision: nil, ocr: nil, ocr_language: nil, pinned: nil, remove_parents: nil, set_modified_date: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, update_viewed_date: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def patch_file(file_id, file_object = nil, add_parents: nil, convert: nil, enforce_single_parent: nil, modified_date_behavior: nil, new_revision: nil, ocr: nil, ocr_language: nil, pinned: nil, remove_parents: nil, set_modified_date: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, update_viewed_date: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'files/{fileId}', options) command.request_representation = Google::Apis::DriveV2::File::Representation command.request_object = file_object @@ -1648,6 +1681,7 @@ module Google command.params['fileId'] = file_id unless file_id.nil? command.query['addParents'] = add_parents unless add_parents.nil? command.query['convert'] = convert unless convert.nil? + command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil? command.query['modifiedDateBehavior'] = modified_date_behavior unless modified_date_behavior.nil? command.query['newRevision'] = new_revision unless new_revision.nil? command.query['ocr'] = ocr unless ocr.nil? @@ -1799,6 +1833,14 @@ module Google # Comma-separated list of parent IDs to add. # @param [Boolean] convert # This parameter is deprecated and has no function. + # @param [Boolean] enforce_single_parent + # Set to true to opt in to API behavior that aims for all items to have exactly + # one parent. This parameter will only take effect if the item is not in a + # shared drive. If the item's owner makes a request to add a single parent, the + # item will be removed from all current folders and placed in the requested + # folder. Other requests that increase the number of parents will fail, except + # when the canAddMyDriveParent file capability is true and a single parent is + # being added. # @param [String] modified_date_behavior # Determines the behavior in which modifiedDate is updated. This overrides # setModifiedDate. @@ -1860,7 +1902,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_file(file_id, file_object = nil, add_parents: nil, convert: nil, modified_date_behavior: nil, new_revision: nil, ocr: nil, ocr_language: nil, pinned: nil, remove_parents: nil, set_modified_date: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, update_viewed_date: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) + def update_file(file_id, file_object = nil, add_parents: nil, convert: nil, enforce_single_parent: nil, modified_date_behavior: nil, new_revision: nil, ocr: nil, ocr_language: nil, pinned: nil, remove_parents: nil, set_modified_date: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, update_viewed_date: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? command = make_simple_command(:put, 'files/{fileId}', options) else @@ -1875,6 +1917,7 @@ module Google command.params['fileId'] = file_id unless file_id.nil? command.query['addParents'] = add_parents unless add_parents.nil? command.query['convert'] = convert unless convert.nil? + command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil? command.query['modifiedDateBehavior'] = modified_date_behavior unless modified_date_behavior.nil? command.query['newRevision'] = new_revision unless new_revision.nil? command.query['ocr'] = ocr unless ocr.nil? @@ -1965,6 +2008,11 @@ module Google # The ID of the file. # @param [String] parent_id # The ID of the parent. + # @param [Boolean] enforce_single_parent + # Set to true to opt in to API behavior that aims for all items to have exactly + # one parent. This parameter will only take effect if the item is not in a + # shared drive. If the item's last parent is removed, the item will be placed + # under its owner's root. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1984,10 +2032,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_parent(file_id, parent_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def delete_parent(file_id, parent_id, enforce_single_parent: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'files/{fileId}/parents/{parentId}', options) command.params['fileId'] = file_id unless file_id.nil? command.params['parentId'] = parent_id unless parent_id.nil? + command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -2034,6 +2083,14 @@ module Google # @param [String] file_id # The ID of the file. # @param [Google::Apis::DriveV2::ParentReference] parent_reference_object + # @param [Boolean] enforce_single_parent + # Set to true to opt in to API behavior that aims for all items to have exactly + # one parent. This parameter will only take effect if the item is not in a + # shared drive. If the child's owner makes the request, the child will be + # removed from all current folders and placed in the requested folder. Any other + # requests that increase the number of the child's parents will fail, except + # when the canAddMyDriveParent file capability is true and a single parent is + # being added. # @param [Boolean] supports_all_drives # Deprecated - Whether the requesting application supports both My Drives and # shared drives. This parameter will only be effective until June 1, 2020. @@ -2059,13 +2116,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_parent(file_id, parent_reference_object = nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def insert_parent(file_id, parent_reference_object = nil, enforce_single_parent: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'files/{fileId}/parents', options) command.request_representation = Google::Apis::DriveV2::ParentReference::Representation command.request_object = parent_reference_object command.response_representation = Google::Apis::DriveV2::ParentReference::Representation command.response_class = Google::Apis::DriveV2::ParentReference command.params['fileId'] = file_id unless file_id.nil? + command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil? command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil? command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil? command.query['fields'] = fields unless fields.nil? @@ -2244,6 +2302,18 @@ module Google # @param [Google::Apis::DriveV2::Permission] permission_object # @param [String] email_message # A plain text custom message to include in notification emails. + # @param [Boolean] enforce_single_parent + # Set to true to opt in to API behavior that aims for all items to have exactly + # one parent. This parameter will only take effect if the item is not in a + # shared drive. See moveToNewOwnersRoot for details. + # @param [Boolean] move_to_new_owners_root + # This parameter will only take effect if the item is not in a shared drive and + # the request is attempting to transfer the ownership of the item. When set to + # true, the item will be moved to the new owner's My Drive root folder and all + # prior parents removed. If set to false, when enforceSingleParent=true, parents + # are not changed. If set to false, when enforceSingleParent=false, existing + # parents are not changed; however, the file will be added to the new owner's My + # Drive root folder, unless it is already in the new owner's My Drive. # @param [Boolean] send_notification_emails # Whether to send notification emails when sharing to users or groups. This # parameter is ignored and an email is sent if the role is owner. @@ -2277,7 +2347,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_permission(file_id, permission_object = nil, email_message: nil, send_notification_emails: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def insert_permission(file_id, permission_object = nil, email_message: nil, enforce_single_parent: nil, move_to_new_owners_root: nil, send_notification_emails: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'files/{fileId}/permissions', options) command.request_representation = Google::Apis::DriveV2::Permission::Representation command.request_object = permission_object @@ -2285,6 +2355,8 @@ module Google command.response_class = Google::Apis::DriveV2::Permission command.params['fileId'] = file_id unless file_id.nil? command.query['emailMessage'] = email_message unless email_message.nil? + command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil? + command.query['moveToNewOwnersRoot'] = move_to_new_owners_root unless move_to_new_owners_root.nil? command.query['sendNotificationEmails'] = send_notification_emails unless send_notification_emails.nil? command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil? command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil? diff --git a/generated/google/apis/drive_v3.rb b/generated/google/apis/drive_v3.rb index d981c417e..58f25ef15 100644 --- a/generated/google/apis/drive_v3.rb +++ b/generated/google/apis/drive_v3.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/drive/ module DriveV3 VERSION = 'V3' - REVISION = '20191108' + REVISION = '20200326' # See, edit, create, and delete all of your Google Drive files AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' diff --git a/generated/google/apis/drive_v3/classes.rb b/generated/google/apis/drive_v3/classes.rb index c3ff29d0b..15de7406b 100644 --- a/generated/google/apis/drive_v3/classes.rb +++ b/generated/google/apis/drive_v3/classes.rb @@ -1192,6 +1192,12 @@ module Google # @return [Google::Apis::DriveV3::User] attr_accessor :sharing_user + # Shortcut file details. Only populated for shortcut files, which have the + # mimeType field set to application/vnd.google-apps.shortcut. + # Corresponds to the JSON property `shortcutDetails` + # @return [Google::Apis::DriveV3::File::ShortcutDetails] + attr_accessor :shortcut_details + # The size of the file's content in bytes. This is only applicable to files with # binary content in Google Drive. # Corresponds to the JSON property `size` @@ -1337,6 +1343,7 @@ module Google @shared = args[:shared] if args.key?(:shared) @shared_with_me_time = args[:shared_with_me_time] if args.key?(:shared_with_me_time) @sharing_user = args[:sharing_user] if args.key?(:sharing_user) + @shortcut_details = args[:shortcut_details] if args.key?(:shortcut_details) @size = args[:size] if args.key?(:size) @spaces = args[:spaces] if args.key?(:spaces) @starred = args[:starred] if args.key?(:starred) @@ -1368,6 +1375,13 @@ module Google attr_accessor :can_add_children alias_method :can_add_children?, :can_add_children + # Whether the current user can add a parent for the item without removing an + # existing parent in the same request. Not populated for shared drive files. + # Corresponds to the JSON property `canAddMyDriveParent` + # @return [Boolean] + attr_accessor :can_add_my_drive_parent + alias_method :can_add_my_drive_parent?, :can_add_my_drive_parent + # Whether the current user can change the copyRequiresWriterPermission # restriction of this file. # Corresponds to the JSON property `canChangeCopyRequiresWriterPermission` @@ -1532,6 +1546,13 @@ module Google attr_accessor :can_remove_children alias_method :can_remove_children?, :can_remove_children + # Whether the current user can remove a parent from the item without adding + # another parent in the same request. Not populated for shared drive files. + # Corresponds to the JSON property `canRemoveMyDriveParent` + # @return [Boolean] + attr_accessor :can_remove_my_drive_parent + alias_method :can_remove_my_drive_parent?, :can_remove_my_drive_parent + # Whether the current user can rename this file. # Corresponds to the JSON property `canRename` # @return [Boolean] @@ -1570,6 +1591,7 @@ module Google # Update properties of this object def update!(**args) @can_add_children = args[:can_add_children] if args.key?(:can_add_children) + @can_add_my_drive_parent = args[:can_add_my_drive_parent] if args.key?(:can_add_my_drive_parent) @can_change_copy_requires_writer_permission = args[:can_change_copy_requires_writer_permission] if args.key?(:can_change_copy_requires_writer_permission) @can_change_viewers_can_copy_content = args[:can_change_viewers_can_copy_content] if args.key?(:can_change_viewers_can_copy_content) @can_comment = args[:can_comment] if args.key?(:can_comment) @@ -1594,6 +1616,7 @@ module Google @can_read_revisions = args[:can_read_revisions] if args.key?(:can_read_revisions) @can_read_team_drive = args[:can_read_team_drive] if args.key?(:can_read_team_drive) @can_remove_children = args[:can_remove_children] if args.key?(:can_remove_children) + @can_remove_my_drive_parent = args[:can_remove_my_drive_parent] if args.key?(:can_remove_my_drive_parent) @can_rename = args[:can_rename] if args.key?(:can_rename) @can_share = args[:can_share] if args.key?(:can_share) @can_trash = args[:can_trash] if args.key?(:can_trash) @@ -1738,7 +1761,8 @@ module Google # @return [String] attr_accessor :metering_mode - # The rotation in clockwise degrees from the image's original orientation. + # The number of clockwise 90 degree rotations applied from the image's original + # orientation. # Corresponds to the JSON property `rotation` # @return [Fixnum] attr_accessor :rotation @@ -1829,6 +1853,34 @@ module Google end end + # Shortcut file details. Only populated for shortcut files, which have the + # mimeType field set to application/vnd.google-apps.shortcut. + class ShortcutDetails + include Google::Apis::Core::Hashable + + # The ID of the file that this shortcut points to. + # Corresponds to the JSON property `targetId` + # @return [String] + attr_accessor :target_id + + # The MIME type of the file that this shortcut points to. The value of this + # field is a snapshot of the target's MIME type, captured when the shortcut is + # created. + # Corresponds to the JSON property `targetMimeType` + # @return [String] + attr_accessor :target_mime_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @target_id = args[:target_id] if args.key?(:target_id) + @target_mime_type = args[:target_mime_type] if args.key?(:target_mime_type) + end + end + # Additional metadata about video media. This may not be available immediately # upon upload. class VideoMediaMetadata @@ -2076,7 +2128,7 @@ module Google alias_method :inherited?, :inherited # The ID of the item from which this permission is inherited. This is an output- - # only field and is only populated for members of the shared drive. + # only field. # Corresponds to the JSON property `inheritedFrom` # @return [String] attr_accessor :inherited_from diff --git a/generated/google/apis/drive_v3/representations.rb b/generated/google/apis/drive_v3/representations.rb index b9896c419..df964a52d 100644 --- a/generated/google/apis/drive_v3/representations.rb +++ b/generated/google/apis/drive_v3/representations.rb @@ -145,6 +145,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ShortcutDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class VideoMediaMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -531,6 +537,8 @@ module Google property :sharing_user, as: 'sharingUser', class: Google::Apis::DriveV3::User, decorator: Google::Apis::DriveV3::User::Representation + property :shortcut_details, as: 'shortcutDetails', class: Google::Apis::DriveV3::File::ShortcutDetails, decorator: Google::Apis::DriveV3::File::ShortcutDetails::Representation + property :size, :numeric_string => true, as: 'size' collection :spaces, as: 'spaces' property :starred, as: 'starred' @@ -558,6 +566,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :can_add_children, as: 'canAddChildren' + property :can_add_my_drive_parent, as: 'canAddMyDriveParent' property :can_change_copy_requires_writer_permission, as: 'canChangeCopyRequiresWriterPermission' property :can_change_viewers_can_copy_content, as: 'canChangeViewersCanCopyContent' property :can_comment, as: 'canComment' @@ -582,6 +591,7 @@ module Google property :can_read_revisions, as: 'canReadRevisions' property :can_read_team_drive, as: 'canReadTeamDrive' property :can_remove_children, as: 'canRemoveChildren' + property :can_remove_my_drive_parent, as: 'canRemoveMyDriveParent' property :can_rename, as: 'canRename' property :can_share, as: 'canShare' property :can_trash, as: 'canTrash' @@ -644,6 +654,14 @@ module Google end end + class ShortcutDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :target_id, as: 'targetId' + property :target_mime_type, as: 'targetMimeType' + end + end + class VideoMediaMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/drive_v3/service.rb b/generated/google/apis/drive_v3/service.rb index 2ef45b866..4364c088b 100644 --- a/generated/google/apis/drive_v3/service.rb +++ b/generated/google/apis/drive_v3/service.rb @@ -785,6 +785,10 @@ module Google # @param [String] file_id # The ID of the file. # @param [Google::Apis::DriveV3::File] file_object + # @param [Boolean] enforce_single_parent + # Set to true to opt in to API behavior that aims for all items to have exactly + # one parent. This parameter will only take effect if the item is not in a + # shared drive. Requests that specify more than one parent will fail. # @param [Boolean] ignore_default_visibility # Whether to ignore the domain's default visibility settings for the created # file. Domain administrators can choose to make all uploaded files visible to @@ -822,13 +826,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def copy_file(file_id, file_object = nil, ignore_default_visibility: nil, keep_revision_forever: nil, ocr_language: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def copy_file(file_id, file_object = nil, enforce_single_parent: nil, ignore_default_visibility: nil, keep_revision_forever: nil, ocr_language: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'files/{fileId}/copy', options) command.request_representation = Google::Apis::DriveV3::File::Representation command.request_object = file_object command.response_representation = Google::Apis::DriveV3::File::Representation command.response_class = Google::Apis::DriveV3::File command.params['fileId'] = file_id unless file_id.nil? + command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil? command.query['ignoreDefaultVisibility'] = ignore_default_visibility unless ignore_default_visibility.nil? command.query['keepRevisionForever'] = keep_revision_forever unless keep_revision_forever.nil? command.query['ocrLanguage'] = ocr_language unless ocr_language.nil? @@ -842,6 +847,10 @@ module Google # Creates a new file. # @param [Google::Apis::DriveV3::File] file_object + # @param [Boolean] enforce_single_parent + # Set to true to opt in to API behavior that aims for all items to have exactly + # one parent. This parameter will only take effect if the item is not in a + # shared drive. Requests that specify more than one parent will fail. # @param [Boolean] ignore_default_visibility # Whether to ignore the domain's default visibility settings for the created # file. Domain administrators can choose to make all uploaded files visible to @@ -885,7 +894,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_file(file_object = nil, ignore_default_visibility: nil, keep_revision_forever: nil, ocr_language: nil, supports_all_drives: nil, supports_team_drives: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) + def create_file(file_object = nil, enforce_single_parent: nil, ignore_default_visibility: nil, keep_revision_forever: nil, ocr_language: nil, supports_all_drives: nil, supports_team_drives: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? command = make_simple_command(:post, 'files', options) else @@ -897,6 +906,7 @@ module Google command.request_object = file_object command.response_representation = Google::Apis::DriveV3::File::Representation command.response_class = Google::Apis::DriveV3::File + command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil? command.query['ignoreDefaultVisibility'] = ignore_default_visibility unless ignore_default_visibility.nil? command.query['keepRevisionForever'] = keep_revision_forever unless keep_revision_forever.nil? command.query['ocrLanguage'] = ocr_language unless ocr_language.nil? @@ -1201,6 +1211,14 @@ module Google # @param [Google::Apis::DriveV3::File] file_object # @param [String] add_parents # A comma-separated list of parent IDs to add. + # @param [Boolean] enforce_single_parent + # Set to true to opt in to API behavior that aims for all items to have exactly + # one parent. This parameter will only take effect if the item is not in a + # shared drive. If the item's owner makes a request to add a single parent, the + # item will be removed from all current folders and placed in the requested + # folder. Other requests that increase the number of parents will fail, except + # when the canAddMyDriveParent file capability is true and a single parent is + # being added. # @param [Boolean] keep_revision_forever # Whether to set the 'keepForever' field in the new head revision. This is only # applicable to files with binary content in Google Drive. Only 200 revisions @@ -1241,7 +1259,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_file(file_id, file_object = nil, add_parents: nil, keep_revision_forever: nil, ocr_language: nil, remove_parents: nil, supports_all_drives: nil, supports_team_drives: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) + def update_file(file_id, file_object = nil, add_parents: nil, enforce_single_parent: nil, keep_revision_forever: nil, ocr_language: nil, remove_parents: nil, supports_all_drives: nil, supports_team_drives: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? command = make_simple_command(:patch, 'files/{fileId}', options) else @@ -1255,6 +1273,7 @@ module Google command.response_class = Google::Apis::DriveV3::File command.params['fileId'] = file_id unless file_id.nil? command.query['addParents'] = add_parents unless add_parents.nil? + command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil? command.query['keepRevisionForever'] = keep_revision_forever unless keep_revision_forever.nil? command.query['ocrLanguage'] = ocr_language unless ocr_language.nil? command.query['removeParents'] = remove_parents unless remove_parents.nil? @@ -1328,6 +1347,18 @@ module Google # @param [Google::Apis::DriveV3::Permission] permission_object # @param [String] email_message # A plain text custom message to include in the notification email. + # @param [Boolean] enforce_single_parent + # Set to true to opt in to API behavior that aims for all items to have exactly + # one parent. This parameter will only take effect if the item is not in a + # shared drive. See moveToNewOwnersRoot for details. + # @param [Boolean] move_to_new_owners_root + # This parameter will only take effect if the item is not in a shared drive and + # the request is attempting to transfer the ownership of the item. When set to + # true, the item will be moved to the new owner's My Drive root folder and all + # prior parents removed. If set to false, when enforceSingleParent=true, parents + # are not changed. If set to false, when enforceSingleParent=false, existing + # parents are not changed; however, the file will be added to the new owner's My + # Drive root folder, unless it is already in the new owner's My Drive. # @param [Boolean] send_notification_email # Whether to send a notification email when sharing to users or groups. This # defaults to true for users and groups, and is not allowed for other requests. @@ -1366,7 +1397,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_permission(file_id, permission_object = nil, email_message: nil, send_notification_email: nil, supports_all_drives: nil, supports_team_drives: nil, transfer_ownership: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def create_permission(file_id, permission_object = nil, email_message: nil, enforce_single_parent: nil, move_to_new_owners_root: nil, send_notification_email: nil, supports_all_drives: nil, supports_team_drives: nil, transfer_ownership: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'files/{fileId}/permissions', options) command.request_representation = Google::Apis::DriveV3::Permission::Representation command.request_object = permission_object @@ -1374,6 +1405,8 @@ module Google command.response_class = Google::Apis::DriveV3::Permission command.params['fileId'] = file_id unless file_id.nil? command.query['emailMessage'] = email_message unless email_message.nil? + command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil? + command.query['moveToNewOwnersRoot'] = move_to_new_owners_root unless move_to_new_owners_root.nil? command.query['sendNotificationEmail'] = send_notification_email unless send_notification_email.nil? command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil? command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil? diff --git a/generated/google/apis/file_v1.rb b/generated/google/apis/file_v1.rb index b753339cd..f455f590c 100644 --- a/generated/google/apis/file_v1.rb +++ b/generated/google/apis/file_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/filestore/ module FileV1 VERSION = 'V1' - REVISION = '20200305' + REVISION = '20200320' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/file_v1beta1.rb b/generated/google/apis/file_v1beta1.rb index 75cb31a93..5a48eb0df 100644 --- a/generated/google/apis/file_v1beta1.rb +++ b/generated/google/apis/file_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/filestore/ module FileV1beta1 VERSION = 'V1beta1' - REVISION = '20200305' + REVISION = '20200320' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/file_v1beta1/classes.rb b/generated/google/apis/file_v1beta1/classes.rb index 33090596f..efeaf7784 100644 --- a/generated/google/apis/file_v1beta1/classes.rb +++ b/generated/google/apis/file_v1beta1/classes.rb @@ -681,11 +681,11 @@ module Google # @return [String] attr_accessor :network - # A /29 CIDR block in one of the + # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the # [internal IP address # ranges](https://www.arin.net/knowledge/address_filters.html) that # identifies the range of IP addresses reserved for this instance. For - # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap + # example, 10.0.0.0/29 or 192.168.0.0/23. The range you specify can't overlap # with either existing subnets or assigned IP address ranges for other Cloud # Filestore instances in the selected VPC network. # Corresponds to the JSON property `reservedIpRange` diff --git a/generated/google/apis/firebase_v1beta1.rb b/generated/google/apis/firebase_v1beta1.rb index 42b2e6561..66c5e3649 100644 --- a/generated/google/apis/firebase_v1beta1.rb +++ b/generated/google/apis/firebase_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://firebase.google.com module FirebaseV1beta1 VERSION = 'V1beta1' - REVISION = '20200309' + REVISION = '20200402' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firebase_v1beta1/service.rb b/generated/google/apis/firebase_v1beta1/service.rb index 96afe91da..1d91203d7 100644 --- a/generated/google/apis/firebase_v1beta1/service.rb +++ b/generated/google/apis/firebase_v1beta1/service.rb @@ -893,11 +893,14 @@ module Google # resource location has already been set for the Project, then this setting # cannot be changed. #
- #
This call checks for any location restrictions for the specified - # Project and, thus, might return a subset of all possible GCP resource - # locations. To list all GCP resource locations (regardless of any - # restrictions), call the endpoint without specifying a `projectId` (that is, - # `/v1beta1/`parent=projects/-`/listAvailableLocations`). + #
This call checks for any possible + # [location + # restrictions](https://cloud.google.com/resource-manager/docs/organization- + # policy/defining-locations) + # for the specified Project and, thus, might return a subset of all possible + # GCP resource locations. To list all GCP resource locations (regardless of + # any restrictions), call the endpoint without specifying a `projectId` (that + # is, `/v1beta1/`parent=projects/-`/listAvailableLocations`). #
#
To call `ListAvailableLocations` with a specified project, a member # must be at minimum a Viewer of the project. Calls without a specified diff --git a/generated/google/apis/firebasehosting_v1beta1.rb b/generated/google/apis/firebasehosting_v1beta1.rb index 2092279b2..d71a2da3c 100644 --- a/generated/google/apis/firebasehosting_v1beta1.rb +++ b/generated/google/apis/firebasehosting_v1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://firebase.google.com/docs/hosting/ module FirebasehostingV1beta1 VERSION = 'V1beta1' - REVISION = '20200224' + REVISION = '20200407' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firebasehosting_v1beta1/classes.rb b/generated/google/apis/firebasehosting_v1beta1/classes.rb index e61c61e6d..1eb886acf 100644 --- a/generated/google/apis/firebasehosting_v1beta1/classes.rb +++ b/generated/google/apis/firebasehosting_v1beta1/classes.rb @@ -366,7 +366,7 @@ module Google end end - # + # The response to listing Domains. class ListDomainsResponse include Google::Apis::Core::Hashable @@ -391,7 +391,7 @@ module Google end end - # + # The response when listing Releases. class ListReleasesResponse include Google::Apis::Core::Hashable @@ -419,7 +419,7 @@ module Google end end - # + # The response when listing a Version's Files.. class ListVersionFilesResponse include Google::Apis::Core::Hashable @@ -444,7 +444,7 @@ module Google end end - # + # The response when listing Versions. class ListVersionsResponse include Google::Apis::Core::Hashable @@ -552,7 +552,7 @@ module Google end end - # + # The request to populate a Version's Files. class PopulateVersionFilesRequest include Google::Apis::Core::Hashable @@ -574,7 +574,7 @@ module Google end end - # + # The response to a PopulateVersionFilesRequest. class PopulateVersionFilesResponse include Google::Apis::Core::Hashable diff --git a/generated/google/apis/firebasehosting_v1beta1/service.rb b/generated/google/apis/firebasehosting_v1beta1/service.rb index f5cc97c79..892cd1243 100644 --- a/generated/google/apis/firebasehosting_v1beta1/service.rb +++ b/generated/google/apis/firebasehosting_v1beta1/service.rb @@ -81,6 +81,684 @@ module Google execute_or_queue_command(command, &block) end + # Gets the Hosting metadata for a specific site. + # @param [String] name + # Required. The site for which to get the SiteConfig, in the format: + # sites/site-name/config + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::SiteConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::SiteConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_site_config(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::FirebasehostingV1beta1::SiteConfig::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::SiteConfig + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the Hosting metadata for a specific site. + # @param [String] name + # Required. The site for which to update the SiteConfig, in the format: + # sites/site-name/config + # @param [Google::Apis::FirebasehostingV1beta1::SiteConfig] site_config_object + # @param [String] update_mask + # A set of field names from your [site configuration](../sites.SiteConfig) + # that you want to update. + #
A field will be overwritten if, and only if, it's in the mask. + #
If a mask is not provided then a default mask of only + # [`max_versions`](../sites.SiteConfig.max_versions) will be used. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::SiteConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::SiteConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_project_site_config(name, site_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta1/{+name}', options) + command.request_representation = Google::Apis::FirebasehostingV1beta1::SiteConfig::Representation + command.request_object = site_config_object + command.response_representation = Google::Apis::FirebasehostingV1beta1::SiteConfig::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::SiteConfig + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new release which makes the content of the specified version + # actively display on the appropriate URL(s). + # @param [String] parent + # Required. The site that the release belongs to, in the format: + # sites/site-name + # @param [Google::Apis::FirebasehostingV1beta1::Release] release_object + # @param [String] version_name + # The unique identifier for a version, in the format: + # /sites/site-name/versions/versionID + # The site-name in this version identifier must match the + # site-name in the `parent` parameter. + #
+ #
This query parameter must be empty if the `type` field in the + # request body is `SITE_DISABLE`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Release] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Release] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_site_channel_release(parent, release_object = nil, version_name: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+parent}/releases', options) + command.request_representation = Google::Apis::FirebasehostingV1beta1::Release::Representation + command.request_object = release_object + command.response_representation = Google::Apis::FirebasehostingV1beta1::Release::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Release + command.params['parent'] = parent unless parent.nil? + command.query['versionName'] = version_name unless version_name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the releases that have been created on the specified site. + # @param [String] parent + # Required. The parent for which to list files, in the format: + # sites/site-name + # @param [Fixnum] page_size + # The page size to return. Defaults to 100. + # @param [String] page_token + # The next_page_token from a previous request, if provided. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::ListReleasesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::ListReleasesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_site_channel_releases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/releases', options) + command.response_representation = Google::Apis::FirebasehostingV1beta1::ListReleasesResponse::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::ListReleasesResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a domain mapping on the specified site. + # @param [String] parent + # Required. The parent to create the domain association for, in the format: + # sites/site-name + # @param [Google::Apis::FirebasehostingV1beta1::Domain] domain_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Domain] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Domain] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_site_domain(parent, domain_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+parent}/domains', options) + command.request_representation = Google::Apis::FirebasehostingV1beta1::Domain::Representation + command.request_object = domain_object + command.response_representation = Google::Apis::FirebasehostingV1beta1::Domain::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Domain + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the existing domain mapping on the specified site. + # @param [String] name + # Required. The name of the domain association to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_site_domain(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::FirebasehostingV1beta1::Empty::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a domain mapping on the specified site. + # @param [String] name + # Required. The name of the domain configuration to get. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Domain] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Domain] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_site_domain(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::FirebasehostingV1beta1::Domain::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Domain + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the domains for the specified site. + # @param [String] parent + # Required. The parent for which to list domains, in the format: + # sites/site-name + # @param [Fixnum] page_size + # The page size to return. Defaults to 50. + # @param [String] page_token + # The next_page_token from a previous request, if provided. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::ListDomainsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::ListDomainsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_site_domains(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/domains', options) + command.response_representation = Google::Apis::FirebasehostingV1beta1::ListDomainsResponse::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::ListDomainsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the specified domain mapping, creating the mapping as if it does + # not exist. + # @param [String] name + # Required. The name of the domain association to update or create, if an + # association doesn't already exist. + # @param [Google::Apis::FirebasehostingV1beta1::Domain] domain_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Domain] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Domain] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_project_site_domain(name, domain_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1beta1/{+name}', options) + command.request_representation = Google::Apis::FirebasehostingV1beta1::Domain::Representation + command.request_object = domain_object + command.response_representation = Google::Apis::FirebasehostingV1beta1::Domain::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Domain + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new release which makes the content of the specified version + # actively display on the appropriate URL(s). + # @param [String] parent + # Required. The site that the release belongs to, in the format: + # sites/site-name + # @param [Google::Apis::FirebasehostingV1beta1::Release] release_object + # @param [String] version_name + # The unique identifier for a version, in the format: + # /sites/site-name/versions/versionID + # The site-name in this version identifier must match the + # site-name in the `parent` parameter. + #
+ #
This query parameter must be empty if the `type` field in the + # request body is `SITE_DISABLE`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Release] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Release] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_site_release(parent, release_object = nil, version_name: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+parent}/releases', options) + command.request_representation = Google::Apis::FirebasehostingV1beta1::Release::Representation + command.request_object = release_object + command.response_representation = Google::Apis::FirebasehostingV1beta1::Release::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Release + command.params['parent'] = parent unless parent.nil? + command.query['versionName'] = version_name unless version_name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the releases that have been created on the specified site. + # @param [String] parent + # Required. The parent for which to list files, in the format: + # sites/site-name + # @param [Fixnum] page_size + # The page size to return. Defaults to 100. + # @param [String] page_token + # The next_page_token from a previous request, if provided. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::ListReleasesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::ListReleasesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_site_releases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/releases', options) + command.response_representation = Google::Apis::FirebasehostingV1beta1::ListReleasesResponse::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::ListReleasesResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new version on the target site using the content + # of the specified version. + # @param [String] parent + # Required. The target site where the cloned version will reside, + # in the format: `sites/`site`` + # @param [Google::Apis::FirebasehostingV1beta1::CloneVersionRequest] clone_version_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def clone_project_site_version(parent, clone_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+parent}/versions:clone', options) + command.request_representation = Google::Apis::FirebasehostingV1beta1::CloneVersionRequest::Representation + command.request_object = clone_version_request_object + command.response_representation = Google::Apis::FirebasehostingV1beta1::Operation::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new version for a site. + # @param [String] parent + # Required. The parent to create the version for, in the format: + # sites/site-name + # @param [Google::Apis::FirebasehostingV1beta1::Version] version_object + # @param [Fixnum] size_bytes + # The self-reported size of the version. This value is used for a pre-emptive + # quota check for legacy version uploads. + # @param [String] version_id + # A unique id for the new version. This is only specified for legacy version + # creations. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Version] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Version] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_site_version(parent, version_object = nil, size_bytes: nil, version_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+parent}/versions', options) + command.request_representation = Google::Apis::FirebasehostingV1beta1::Version::Representation + command.request_object = version_object + command.response_representation = Google::Apis::FirebasehostingV1beta1::Version::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Version + command.params['parent'] = parent unless parent.nil? + command.query['sizeBytes'] = size_bytes unless size_bytes.nil? + command.query['versionId'] = version_id unless version_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified version. + # @param [String] name + # Required. The name of the version to be deleted, in the format: + # sites/site-name/versions/versionID + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_site_version(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::FirebasehostingV1beta1::Empty::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the versions that have been created on the specified site. + # Will include filtering in the future. + # @param [String] parent + # Required. The parent for which to list files, in the format: + # sites/site-name + # @param [String] filter + # The filter string used to return a subset of versions in the response. + # Currently supported fields for filtering are: name, status, + # and create_time. Filter processing will be implemented in accordance + # with go/filtering. + # @param [Fixnum] page_size + # The maximum number of versions to return. The service may return fewer than + # this value. + # If unspecified, at most 25 versions will be returned. + # The maximum value is 100; values above 100 will be coerced to 100 + # @param [String] page_token + # The next_page_token from a previous request, if provided. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::ListVersionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::ListVersionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_site_versions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/versions', options) + command.response_representation = Google::Apis::FirebasehostingV1beta1::ListVersionsResponse::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::ListVersionsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the specified metadata for a version. Note that this method will + # fail with `FAILED_PRECONDITION` in the event of an invalid state + # transition. The only valid transition for a version is currently from a + # `CREATED` status to a `FINALIZED` status. + # Use [`DeleteVersion`](../sites.versions/delete) to set the status of a + # version to `DELETED`. + # @param [String] name + # The unique identifier for a version, in the format: + # sites/site-name/versions/versionID + # This name is provided in the response body when you call the + # [`CreateVersion`](../sites.versions/create) endpoint. + # @param [Google::Apis::FirebasehostingV1beta1::Version] version_object + # @param [String] update_mask + # A set of field names from your [version](../sites.versions) that you want + # to update. + #
A field will be overwritten if, and only if, it's in the mask. + #
If a mask is not provided then a default mask of only + # [`status`](../sites.versions#Version.FIELDS.status) will be used. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Version] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Version] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_site_version(name, version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta1/{+name}', options) + command.request_representation = Google::Apis::FirebasehostingV1beta1::Version::Representation + command.request_object = version_object + command.response_representation = Google::Apis::FirebasehostingV1beta1::Version::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Version + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Adds content files to a version. + # @param [String] parent + # Required. The version to add files to, in the format: + # sites/site-name/versions/versionID + # @param [Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesRequest] populate_version_files_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def populate_project_site_version_files(parent, populate_version_files_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+parent}:populateFiles', options) + command.request_representation = Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesRequest::Representation + command.request_object = populate_version_files_request_object + command.response_representation = Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesResponse::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesResponse + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the remaining files to be uploaded for the specified version. + # @param [String] parent + # Required. The parent to list files for, in the format: + # sites/site-name/versions/versionID + # @param [Fixnum] page_size + # The page size to return. Defaults to 1000. + # @param [String] page_token + # The next_page_token from a previous request, if provided. This will be the + # encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken. + # @param [String] status + # The type of files in the version that should be listed. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::ListVersionFilesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::ListVersionFilesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_site_version_files(parent, page_size: nil, page_token: nil, status: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/files', options) + command.response_representation = Google::Apis::FirebasehostingV1beta1::ListVersionFilesResponse::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::ListVersionFilesResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['status'] = status unless status.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Gets the Hosting metadata for a specific site. # @param [String] name # Required. The site for which to get the SiteConfig, in the format: @@ -153,6 +831,87 @@ module Google execute_or_queue_command(command, &block) end + # Creates a new release which makes the content of the specified version + # actively display on the appropriate URL(s). + # @param [String] parent + # Required. The site that the release belongs to, in the format: + # sites/site-name + # @param [Google::Apis::FirebasehostingV1beta1::Release] release_object + # @param [String] version_name + # The unique identifier for a version, in the format: + # /sites/site-name/versions/versionID + # The site-name in this version identifier must match the + # site-name in the `parent` parameter. + #
+ #
This query parameter must be empty if the `type` field in the + # request body is `SITE_DISABLE`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Release] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::Release] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_site_channel_release(parent, release_object = nil, version_name: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+parent}/releases', options) + command.request_representation = Google::Apis::FirebasehostingV1beta1::Release::Representation + command.request_object = release_object + command.response_representation = Google::Apis::FirebasehostingV1beta1::Release::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::Release + command.params['parent'] = parent unless parent.nil? + command.query['versionName'] = version_name unless version_name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the releases that have been created on the specified site. + # @param [String] parent + # Required. The parent for which to list files, in the format: + # sites/site-name + # @param [Fixnum] page_size + # The page size to return. Defaults to 100. + # @param [String] page_token + # The next_page_token from a previous request, if provided. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebasehostingV1beta1::ListReleasesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebasehostingV1beta1::ListReleasesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_site_channel_releases(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/releases', options) + command.response_representation = Google::Apis::FirebasehostingV1beta1::ListReleasesResponse::Representation + command.response_class = Google::Apis::FirebasehostingV1beta1::ListReleasesResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a domain mapping on the specified site. # @param [String] parent # Required. The parent to create the domain association for, in the format: @@ -320,9 +1079,9 @@ module Google end # Creates a new release which makes the content of the specified version - # actively display on the site. + # actively display on the appropriate URL(s). # @param [String] parent - # The site that the release belongs to, in the format: + # Required. The site that the release belongs to, in the format: # sites/site-name # @param [Google::Apis::FirebasehostingV1beta1::Release] release_object # @param [String] version_name @@ -423,7 +1182,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def clone_version(parent, clone_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + def clone_site_version(parent, clone_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+parent}/versions:clone', options) command.request_representation = Google::Apis::FirebasehostingV1beta1::CloneVersionRequest::Representation command.request_object = clone_version_request_object diff --git a/generated/google/apis/firestore_v1.rb b/generated/google/apis/firestore_v1.rb index bb0a837b6..b9f0bfbef 100644 --- a/generated/google/apis/firestore_v1.rb +++ b/generated/google/apis/firestore_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/firestore module FirestoreV1 VERSION = 'V1' - REVISION = '20200215' + REVISION = '20200311' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firestore_v1/classes.rb b/generated/google/apis/firestore_v1/classes.rb index 759f98b77..b68fa7aa3 100644 --- a/generated/google/apis/firestore_v1/classes.rb +++ b/generated/google/apis/firestore_v1/classes.rb @@ -68,7 +68,7 @@ module Google attr_accessor :new_transaction # Reads documents as they were at the given time. - # This may not be older than 60 seconds. + # This may not be older than 270 seconds. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -1941,7 +1941,7 @@ module Google attr_accessor :new_transaction # Reads documents as they were at the given time. - # This may not be older than 60 seconds. + # This may not be older than 270 seconds. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -2427,6 +2427,14 @@ module Google # @return [Google::Apis::FirestoreV1::DocumentMask] attr_accessor :update_mask + # The transforms to perform after update. + # This field can be set only when the operation is `update`. If present, this + # write is equivalent to performing `update` and `transform` to the same + # document atomically and in order. + # Corresponds to the JSON property `updateTransforms` + # @return [Array] + attr_accessor :update_transforms + def initialize(**args) update!(**args) end @@ -2438,6 +2446,7 @@ module Google @transform = args[:transform] if args.key?(:transform) @update = args[:update] if args.key?(:update) @update_mask = args[:update_mask] if args.key?(:update_mask) + @update_transforms = args[:update_transforms] if args.key?(:update_transforms) end end diff --git a/generated/google/apis/firestore_v1/representations.rb b/generated/google/apis/firestore_v1/representations.rb index 66c8c4a4c..69001df9b 100644 --- a/generated/google/apis/firestore_v1/representations.rb +++ b/generated/google/apis/firestore_v1/representations.rb @@ -1125,6 +1125,8 @@ module Google property :update_mask, as: 'updateMask', class: Google::Apis::FirestoreV1::DocumentMask, decorator: Google::Apis::FirestoreV1::DocumentMask::Representation + collection :update_transforms, as: 'updateTransforms', class: Google::Apis::FirestoreV1::FieldTransform, decorator: Google::Apis::FirestoreV1::FieldTransform::Representation + end end diff --git a/generated/google/apis/firestore_v1/service.rb b/generated/google/apis/firestore_v1/service.rb index 3cd913fe1..4cec5dc2d 100644 --- a/generated/google/apis/firestore_v1/service.rb +++ b/generated/google/apis/firestore_v1/service.rb @@ -625,7 +625,7 @@ module Google # path syntax reference. # @param [String] read_time # Reads the version of the document at the given time. - # This may not be older than 60 seconds. + # This may not be older than 270 seconds. # @param [String] transaction # Reads the document in a transaction. # @param [String] fields @@ -681,7 +681,7 @@ module Google # The `next_page_token` value returned from a previous List request, if any. # @param [String] read_time # Reads documents as they were at the given time. - # This may not be older than 60 seconds. + # This may not be older than 270 seconds. # @param [Boolean] show_missing # If the list should show missing documents. A missing document is a # document that does not exist but has sub-documents. These documents will diff --git a/generated/google/apis/firestore_v1beta1.rb b/generated/google/apis/firestore_v1beta1.rb index f60a3741c..b032d1f8e 100644 --- a/generated/google/apis/firestore_v1beta1.rb +++ b/generated/google/apis/firestore_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/firestore module FirestoreV1beta1 VERSION = 'V1beta1' - REVISION = '20200216' + REVISION = '20200311' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firestore_v1beta1/classes.rb b/generated/google/apis/firestore_v1beta1/classes.rb index c32a1b8b9..8ff740908 100644 --- a/generated/google/apis/firestore_v1beta1/classes.rb +++ b/generated/google/apis/firestore_v1beta1/classes.rb @@ -68,7 +68,7 @@ module Google attr_accessor :new_transaction # Reads documents as they were at the given time. - # This may not be older than 60 seconds. + # This may not be older than 270 seconds. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -1579,7 +1579,7 @@ module Google attr_accessor :new_transaction # Reads documents as they were at the given time. - # This may not be older than 60 seconds. + # This may not be older than 270 seconds. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -2065,6 +2065,14 @@ module Google # @return [Google::Apis::FirestoreV1beta1::DocumentMask] attr_accessor :update_mask + # The transforms to perform after update. + # This field can be set only when the operation is `update`. If present, this + # write is equivalent to performing `update` and `transform` to the same + # document atomically and in order. + # Corresponds to the JSON property `updateTransforms` + # @return [Array] + attr_accessor :update_transforms + def initialize(**args) update!(**args) end @@ -2076,6 +2084,7 @@ module Google @transform = args[:transform] if args.key?(:transform) @update = args[:update] if args.key?(:update) @update_mask = args[:update_mask] if args.key?(:update_mask) + @update_transforms = args[:update_transforms] if args.key?(:update_transforms) end end diff --git a/generated/google/apis/firestore_v1beta1/representations.rb b/generated/google/apis/firestore_v1beta1/representations.rb index cf1bcdf1c..645265e44 100644 --- a/generated/google/apis/firestore_v1beta1/representations.rb +++ b/generated/google/apis/firestore_v1beta1/representations.rb @@ -980,6 +980,8 @@ module Google property :update_mask, as: 'updateMask', class: Google::Apis::FirestoreV1beta1::DocumentMask, decorator: Google::Apis::FirestoreV1beta1::DocumentMask::Representation + collection :update_transforms, as: 'updateTransforms', class: Google::Apis::FirestoreV1beta1::FieldTransform, decorator: Google::Apis::FirestoreV1beta1::FieldTransform::Representation + end end diff --git a/generated/google/apis/firestore_v1beta1/service.rb b/generated/google/apis/firestore_v1beta1/service.rb index d8a70cb33..04caed9fa 100644 --- a/generated/google/apis/firestore_v1beta1/service.rb +++ b/generated/google/apis/firestore_v1beta1/service.rb @@ -327,7 +327,7 @@ module Google # path syntax reference. # @param [String] read_time # Reads the version of the document at the given time. - # This may not be older than 60 seconds. + # This may not be older than 270 seconds. # @param [String] transaction # Reads the document in a transaction. # @param [String] fields @@ -383,7 +383,7 @@ module Google # The `next_page_token` value returned from a previous List request, if any. # @param [String] read_time # Reads documents as they were at the given time. - # This may not be older than 60 seconds. + # This may not be older than 270 seconds. # @param [Boolean] show_missing # If the list should show missing documents. A missing document is a # document that does not exist but has sub-documents. These documents will diff --git a/generated/google/apis/games_configuration_v1configuration.rb b/generated/google/apis/games_configuration_v1configuration.rb index 267adaf6d..f822df4d8 100644 --- a/generated/google/apis/games_configuration_v1configuration.rb +++ b/generated/google/apis/games_configuration_v1configuration.rb @@ -20,12 +20,13 @@ module Google module Apis # Google Play Game Services Publishing API # - # The Publishing API for Google Play Game Services. + # The Google Play Game Services Publishing API allows developers to configure + # their games in Game Services. # - # @see https://developers.google.com/games/services + # @see https://developers.google.com/games/ module GamesConfigurationV1configuration VERSION = 'V1configuration' - REVISION = '20180816' + REVISION = '20200317' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' diff --git a/generated/google/apis/games_configuration_v1configuration/classes.rb b/generated/google/apis/games_configuration_v1configuration/classes.rb index f3153312f..d06bdd3dc 100644 --- a/generated/google/apis/games_configuration_v1configuration/classes.rb +++ b/generated/google/apis/games_configuration_v1configuration/classes.rb @@ -22,19 +22,16 @@ module Google module Apis module GamesConfigurationV1configuration - # This is a JSON template for an achievement configuration resource. + # An achievement configuration resource. class AchievementConfiguration include Google::Apis::Core::Hashable # The type of the achievement. - # Possible values are: - # - "STANDARD" - Achievement is either locked or unlocked. - # - "INCREMENTAL" - Achievement is incremental. # Corresponds to the JSON property `achievementType` # @return [String] attr_accessor :achievement_type - # This is a JSON template for an achievement configuration detail. + # An achievement configuration detail. # Corresponds to the JSON property `draft` # @return [Google::Apis::GamesConfigurationV1configuration::AchievementConfigurationDetail] attr_accessor :draft @@ -45,26 +42,22 @@ module Google attr_accessor :id # The initial state of the achievement. - # Possible values are: - # - "HIDDEN" - Achievement is hidden. - # - "REVEALED" - Achievement is revealed. - # - "UNLOCKED" - Achievement is unlocked. # Corresponds to the JSON property `initialState` # @return [String] attr_accessor :initial_state # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesConfiguration#achievementConfiguration. + # string gamesConfiguration#achievementConfiguration. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # This is a JSON template for an achievement configuration detail. + # An achievement configuration detail. # Corresponds to the JSON property `published` # @return [Google::Apis::GamesConfigurationV1configuration::AchievementConfigurationDetail] attr_accessor :published - # Steps to unlock. Only applicable to incremental achievements. + # Steps to unlock. Only applicable to incremental achievements. # Corresponds to the JSON property `stepsToUnlock` # @return [Fixnum] attr_accessor :steps_to_unlock @@ -91,11 +84,11 @@ module Google end end - # This is a JSON template for an achievement configuration detail. + # An achievement configuration detail. class AchievementConfigurationDetail include Google::Apis::Core::Hashable - # This is a JSON template for a localized string bundle resource. + # A localized string bundle resource. # Corresponds to the JSON property `description` # @return [Google::Apis::GamesConfigurationV1configuration::LocalizedStringBundle] attr_accessor :description @@ -106,12 +99,12 @@ module Google attr_accessor :icon_url # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesConfiguration#achievementConfigurationDetail. + # string gamesConfiguration#achievementConfigurationDetail. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # This is a JSON template for a localized string bundle resource. + # A localized string bundle resource. # Corresponds to the JSON property `name` # @return [Google::Apis::GamesConfigurationV1configuration::LocalizedStringBundle] attr_accessor :name @@ -141,7 +134,7 @@ module Google end end - # This is a JSON template for a ListConfigurations response. + # A ListConfigurations response. class ListAchievementConfigurationResponse include Google::Apis::Core::Hashable @@ -151,7 +144,8 @@ module Google attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed - # string games#achievementConfigurationListResponse. + # string + # gamesConfiguration#achievementConfigurationListResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -173,36 +167,36 @@ module Google end end - # This is a JSON template for a number affix resource. + # A number affix resource. class GamesNumberAffixConfiguration include Google::Apis::Core::Hashable - # This is a JSON template for a localized string bundle resource. + # A localized string bundle resource. # Corresponds to the JSON property `few` # @return [Google::Apis::GamesConfigurationV1configuration::LocalizedStringBundle] attr_accessor :few - # This is a JSON template for a localized string bundle resource. + # A localized string bundle resource. # Corresponds to the JSON property `many` # @return [Google::Apis::GamesConfigurationV1configuration::LocalizedStringBundle] attr_accessor :many - # This is a JSON template for a localized string bundle resource. + # A localized string bundle resource. # Corresponds to the JSON property `one` # @return [Google::Apis::GamesConfigurationV1configuration::LocalizedStringBundle] attr_accessor :one - # This is a JSON template for a localized string bundle resource. + # A localized string bundle resource. # Corresponds to the JSON property `other` # @return [Google::Apis::GamesConfigurationV1configuration::LocalizedStringBundle] attr_accessor :other - # This is a JSON template for a localized string bundle resource. + # A localized string bundle resource. # Corresponds to the JSON property `two` # @return [Google::Apis::GamesConfigurationV1configuration::LocalizedStringBundle] attr_accessor :two - # This is a JSON template for a localized string bundle resource. + # A localized string bundle resource. # Corresponds to the JSON property `zero` # @return [Google::Apis::GamesConfigurationV1configuration::LocalizedStringBundle] attr_accessor :zero @@ -222,7 +216,7 @@ module Google end end - # This is a JSON template for a number format resource. + # A number format resource. class GamesNumberFormatConfiguration include Google::Apis::Core::Hashable @@ -237,17 +231,11 @@ module Google attr_accessor :num_decimal_places # The formatting for the number. - # Possible values are: - # - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of - # digits after the decimal point according to locale. An optional custom unit - # can be added. - # - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds. - # - "CURRENCY" - Numbers are formatted to currency according to locale. # Corresponds to the JSON property `numberFormatType` # @return [String] attr_accessor :number_format_type - # This is a JSON template for a number affix resource. + # A number affix resource. # Corresponds to the JSON property `suffix` # @return [Google::Apis::GamesConfigurationV1configuration::GamesNumberAffixConfiguration] attr_accessor :suffix @@ -265,7 +253,7 @@ module Google end end - # This is a JSON template for an image configuration resource. + # An image configuration resource. class ImageConfiguration include Google::Apis::Core::Hashable @@ -275,7 +263,7 @@ module Google attr_accessor :image_type # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesConfiguration#imageConfiguration. + # string gamesConfiguration#imageConfiguration. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -303,11 +291,11 @@ module Google end end - # This is a JSON template for an leaderboard configuration resource. + # An leaderboard configuration resource. class LeaderboardConfiguration include Google::Apis::Core::Hashable - # This is a JSON template for a leaderboard configuration detail. + # A leaderboard configuration detail. # Corresponds to the JSON property `draft` # @return [Google::Apis::GamesConfigurationV1configuration::LeaderboardConfigurationDetail] attr_accessor :draft @@ -318,12 +306,12 @@ module Google attr_accessor :id # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesConfiguration#leaderboardConfiguration. + # string gamesConfiguration#leaderboardConfiguration. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # This is a JSON template for a leaderboard configuration detail. + # A leaderboard configuration detail. # Corresponds to the JSON property `published` # @return [Google::Apis::GamesConfigurationV1configuration::LeaderboardConfigurationDetail] attr_accessor :published @@ -338,10 +326,7 @@ module Google # @return [Fixnum] attr_accessor :score_min - # The type of the leaderboard. - # Possible values are: - # - "LARGER_IS_BETTER" - Larger scores posted are ranked higher. - # - "SMALLER_IS_BETTER" - Smaller scores posted are ranked higher. + # # Corresponds to the JSON property `scoreOrder` # @return [String] attr_accessor :score_order @@ -368,7 +353,7 @@ module Google end end - # This is a JSON template for a leaderboard configuration detail. + # A leaderboard configuration detail. class LeaderboardConfigurationDetail include Google::Apis::Core::Hashable @@ -378,17 +363,17 @@ module Google attr_accessor :icon_url # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesConfiguration#leaderboardConfigurationDetail. + # string gamesConfiguration#leaderboardConfigurationDetail. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # This is a JSON template for a localized string bundle resource. + # A localized string bundle resource. # Corresponds to the JSON property `name` # @return [Google::Apis::GamesConfigurationV1configuration::LocalizedStringBundle] attr_accessor :name - # This is a JSON template for a number format resource. + # A number format resource. # Corresponds to the JSON property `scoreFormat` # @return [Google::Apis::GamesConfigurationV1configuration::GamesNumberFormatConfiguration] attr_accessor :score_format @@ -412,7 +397,7 @@ module Google end end - # This is a JSON template for a ListConfigurations response. + # A ListConfigurations response. class ListLeaderboardConfigurationResponse include Google::Apis::Core::Hashable @@ -422,7 +407,8 @@ module Google attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed - # string games#leaderboardConfigurationListResponse. + # string + # gamesConfiguration#leaderboardConfigurationListResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -444,12 +430,12 @@ module Google end end - # This is a JSON template for a localized string resource. + # A localized string resource. class LocalizedString include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesConfiguration#localizedString. + # string gamesConfiguration#localizedString. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -476,12 +462,12 @@ module Google end end - # This is a JSON template for a localized string bundle resource. + # A localized string bundle resource. class LocalizedStringBundle include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string gamesConfiguration#localizedStringBundle. + # string gamesConfiguration#localizedStringBundle. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind diff --git a/generated/google/apis/games_configuration_v1configuration/service.rb b/generated/google/apis/games_configuration_v1configuration/service.rb index 1efa7ba50..2afb4d266 100644 --- a/generated/google/apis/games_configuration_v1configuration/service.rb +++ b/generated/google/apis/games_configuration_v1configuration/service.rb @@ -22,7 +22,8 @@ module Google module GamesConfigurationV1configuration # Google Play Game Services Publishing API # - # The Publishing API for Google Play Game Services. + # The Google Play Game Services Publishing API allows developers to configure + # their games in Game Services. # # @example # require 'google/apis/games_configuration_v1configuration' @@ -30,7 +31,7 @@ module Google # GamesConfiguration = Google::Apis::GamesConfigurationV1configuration # Alias the module # service = GamesConfiguration::GamesConfigurationService.new # - # @see https://developers.google.com/games/services + # @see https://developers.google.com/games/ class GamesConfigurationService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, @@ -38,17 +39,13 @@ module Google attr_accessor :key # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. attr_accessor :quota_user - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - def initialize - super('https://www.googleapis.com/', 'games/v1configuration/') - @batch_path = 'batch/gamesConfiguration/v1configuration' + super('https://www.googleapis.com/', '') + @batch_path = 'batch' end # Delete the achievement configuration with the given ID. @@ -57,10 +54,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -73,12 +68,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_achievement_configuration(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'achievements/{achievementId}', options) + def delete_achievement_configuration(achievement_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'games/v1configuration/achievements/{achievementId}', options) command.params['achievementId'] = achievement_id unless achievement_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -88,10 +82,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -104,14 +96,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_achievement_configuration(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'achievements/{achievementId}', options) + def get_achievement_configuration(achievement_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1configuration/achievements/{achievementId}', options) command.response_representation = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration::Representation command.response_class = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration command.params['achievementId'] = achievement_id unless achievement_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -122,10 +113,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -138,8 +127,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_achievement_configuration(application_id, achievement_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'applications/{applicationId}/achievements', options) + def insert_achievement_configuration(application_id, achievement_configuration_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1configuration/applications/{applicationId}/achievements', options) command.request_representation = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration::Representation command.request_object = achievement_configuration_object command.response_representation = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration::Representation @@ -147,7 +136,6 @@ module Google command.params['applicationId'] = application_id unless application_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -155,18 +143,16 @@ module Google # @param [String] application_id # The application ID from the Google Play developer console. # @param [Fixnum] max_results - # The maximum number of resource configurations to return in the response, used - # for paging. For any response, the actual number of resources returned may be - # less than the specified maxResults. + # The maximum number of resource configurations to return in the response, + # used for paging. For any response, the actual number of resources returned + # may be less than the specified maxResults. # @param [String] page_token # The token returned by the previous request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -179,8 +165,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_achievement_configurations(application_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'applications/{applicationId}/achievements', options) + def list_achievement_configurations(application_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1configuration/applications/{applicationId}/achievements', options) command.response_representation = Google::Apis::GamesConfigurationV1configuration::ListAchievementConfigurationResponse::Representation command.response_class = Google::Apis::GamesConfigurationV1configuration::ListAchievementConfigurationResponse command.params['applicationId'] = application_id unless application_id.nil? @@ -188,44 +174,6 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Update the metadata of the achievement configuration with the given ID. This - # method supports patch semantics. - # @param [String] achievement_id - # The ID of the achievement used by this method. - # @param [Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration] achievement_configuration_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_achievement_configuration(achievement_id, achievement_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'achievements/{achievementId}', options) - command.request_representation = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration::Representation - command.request_object = achievement_configuration_object - command.response_representation = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration::Representation - command.response_class = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration - command.params['achievementId'] = achievement_id unless achievement_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -236,10 +184,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -252,8 +198,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_achievement_configuration(achievement_id, achievement_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'achievements/{achievementId}', options) + def update_achievement_configuration(achievement_id, achievement_configuration_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'games/v1configuration/achievements/{achievementId}', options) command.request_representation = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration::Representation command.request_object = achievement_configuration_object command.response_representation = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration::Representation @@ -261,7 +207,6 @@ module Google command.params['achievementId'] = achievement_id unless achievement_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -273,10 +218,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [IO, String] upload_source # IO stream or filename containing content to upload # @param [String] content_type @@ -293,11 +236,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def upload_image_configuration(resource_id, image_type, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) + def upload_image_configuration(resource_id, image_type, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? - command = make_simple_command(:post, 'images/{resourceId}/imageType/{imageType}', options) + command = make_simple_command(:post, 'games/v1configuration/images/{resourceId}/imageType/{imageType}', options) else - command = make_upload_command(:post, 'images/{resourceId}/imageType/{imageType}', options) + command = make_upload_command(:post, 'games/v1configuration/images/{resourceId}/imageType/{imageType}', options) command.upload_source = upload_source command.upload_content_type = content_type end @@ -307,7 +250,6 @@ module Google command.params['imageType'] = image_type unless image_type.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -317,10 +259,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -333,12 +273,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_leaderboard_configuration(leaderboard_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'leaderboards/{leaderboardId}', options) + def delete_leaderboard_configuration(leaderboard_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'games/v1configuration/leaderboards/{leaderboardId}', options) command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -348,10 +287,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -364,14 +301,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_leaderboard_configuration(leaderboard_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'leaderboards/{leaderboardId}', options) + def get_leaderboard_configuration(leaderboard_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1configuration/leaderboards/{leaderboardId}', options) command.response_representation = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration::Representation command.response_class = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -382,10 +318,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -398,8 +332,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_leaderboard_configuration(application_id, leaderboard_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'applications/{applicationId}/leaderboards', options) + def insert_leaderboard_configuration(application_id, leaderboard_configuration_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1configuration/applications/{applicationId}/leaderboards', options) command.request_representation = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration::Representation command.request_object = leaderboard_configuration_object command.response_representation = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration::Representation @@ -407,7 +341,6 @@ module Google command.params['applicationId'] = application_id unless application_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -415,18 +348,16 @@ module Google # @param [String] application_id # The application ID from the Google Play developer console. # @param [Fixnum] max_results - # The maximum number of resource configurations to return in the response, used - # for paging. For any response, the actual number of resources returned may be - # less than the specified maxResults. + # The maximum number of resource configurations to return in the response, + # used for paging. For any response, the actual number of resources returned + # may be less than the specified maxResults. # @param [String] page_token # The token returned by the previous request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -439,8 +370,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_leaderboard_configurations(application_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'applications/{applicationId}/leaderboards', options) + def list_leaderboard_configurations(application_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1configuration/applications/{applicationId}/leaderboards', options) command.response_representation = Google::Apis::GamesConfigurationV1configuration::ListLeaderboardConfigurationResponse::Representation command.response_class = Google::Apis::GamesConfigurationV1configuration::ListLeaderboardConfigurationResponse command.params['applicationId'] = application_id unless application_id.nil? @@ -448,44 +379,6 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Update the metadata of the leaderboard configuration with the given ID. This - # method supports patch semantics. - # @param [String] leaderboard_id - # The ID of the leaderboard. - # @param [Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration] leaderboard_configuration_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_leaderboard_configuration(leaderboard_id, leaderboard_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'leaderboards/{leaderboardId}', options) - command.request_representation = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration::Representation - command.request_object = leaderboard_configuration_object - command.response_representation = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration::Representation - command.response_class = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration - command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -496,10 +389,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -512,8 +403,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_leaderboard_configuration(leaderboard_id, leaderboard_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'leaderboards/{leaderboardId}', options) + def update_leaderboard_configuration(leaderboard_id, leaderboard_configuration_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'games/v1configuration/leaderboards/{leaderboardId}', options) command.request_representation = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration::Representation command.request_object = leaderboard_configuration_object command.response_representation = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration::Representation @@ -521,7 +412,6 @@ module Google command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -530,7 +420,6 @@ module Google def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? end end end diff --git a/generated/google/apis/games_management_v1management.rb b/generated/google/apis/games_management_v1management.rb index ce6cd5039..8604dd2b0 100644 --- a/generated/google/apis/games_management_v1management.rb +++ b/generated/google/apis/games_management_v1management.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/games/services module GamesManagementV1management VERSION = 'V1management' - REVISION = '20191205' + REVISION = '20200306' # Create, edit, and delete your Google Play Games activity AUTH_GAMES = 'https://www.googleapis.com/auth/games' diff --git a/generated/google/apis/games_management_v1management/classes.rb b/generated/google/apis/games_management_v1management/classes.rb index 8dc555a9b..156af5f88 100644 --- a/generated/google/apis/games_management_v1management/classes.rb +++ b/generated/google/apis/games_management_v1management/classes.rb @@ -333,6 +333,12 @@ module Google # @return [Google::Apis::GamesManagementV1management::GamesPlayerExperienceInfoResource] attr_accessor :experience_info + # The friend status of the given player, relative to the requester. This is + # unset if the player is not sharing their friends list with the game. + # Corresponds to the JSON property `friendStatus` + # @return [String] + attr_accessor :friend_status + # Uniquely identifies the type of this resource. Value is always the fixed # string gamesManagement#player. # Corresponds to the JSON property `kind` @@ -390,6 +396,7 @@ module Google @banner_url_portrait = args[:banner_url_portrait] if args.key?(:banner_url_portrait) @display_name = args[:display_name] if args.key?(:display_name) @experience_info = args[:experience_info] if args.key?(:experience_info) + @friend_status = args[:friend_status] if args.key?(:friend_status) @kind = args[:kind] if args.key?(:kind) @last_played_with = args[:last_played_with] if args.key?(:last_played_with) @name = args[:name] if args.key?(:name) diff --git a/generated/google/apis/games_management_v1management/representations.rb b/generated/google/apis/games_management_v1management/representations.rb index 5351235b6..2ac8f1cab 100644 --- a/generated/google/apis/games_management_v1management/representations.rb +++ b/generated/google/apis/games_management_v1management/representations.rb @@ -205,6 +205,7 @@ module Google property :display_name, as: 'displayName' property :experience_info, as: 'experienceInfo', class: Google::Apis::GamesManagementV1management::GamesPlayerExperienceInfoResource, decorator: Google::Apis::GamesManagementV1management::GamesPlayerExperienceInfoResource::Representation + property :friend_status, as: 'friendStatus' property :kind, as: 'kind' property :last_played_with, as: 'lastPlayedWith', class: Google::Apis::GamesManagementV1management::GamesPlayedResource, decorator: Google::Apis::GamesManagementV1management::GamesPlayedResource::Representation diff --git a/generated/google/apis/games_v1.rb b/generated/google/apis/games_v1.rb index e0c7300cb..b5a79a8bf 100644 --- a/generated/google/apis/games_v1.rb +++ b/generated/google/apis/games_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/games/services/ module GamesV1 VERSION = 'V1' - REVISION = '20191017' + REVISION = '20200330' # View and manage its own configuration data in your Google Drive AUTH_DRIVE_APPDATA = 'https://www.googleapis.com/auth/drive.appdata' diff --git a/generated/google/apis/games_v1/classes.rb b/generated/google/apis/games_v1/classes.rb index 5bc9177f0..0724de6e9 100644 --- a/generated/google/apis/games_v1/classes.rb +++ b/generated/google/apis/games_v1/classes.rb @@ -2007,6 +2007,12 @@ module Google # @return [Google::Apis::GamesV1::PlayerExperienceInfo] attr_accessor :experience_info + # The friend status of the given player, relative to the requester. This is + # unset if the player is not sharing their friends list with the game. + # Corresponds to the JSON property `friendStatus` + # @return [String] + attr_accessor :friend_status + # Uniquely identifies the type of this resource. Value is always the fixed # string games#player. # Corresponds to the JSON property `kind` @@ -2064,6 +2070,7 @@ module Google @banner_url_portrait = args[:banner_url_portrait] if args.key?(:banner_url_portrait) @display_name = args[:display_name] if args.key?(:display_name) @experience_info = args[:experience_info] if args.key?(:experience_info) + @friend_status = args[:friend_status] if args.key?(:friend_status) @kind = args[:kind] if args.key?(:kind) @last_played_with = args[:last_played_with] if args.key?(:last_played_with) @name = args[:name] if args.key?(:name) @@ -2662,6 +2669,11 @@ module Google class ProfileSettings include Google::Apis::Core::Hashable + # Whether the player's friends list is visible to the game. + # Corresponds to the JSON property `friendsListVisibility` + # @return [String] + attr_accessor :friends_list_visibility + # Uniquely identifies the type of this resource. Value is always the fixed # string games#profileSettings. # Corresponds to the JSON property `kind` @@ -2680,6 +2692,7 @@ module Google # Update properties of this object def update!(**args) + @friends_list_visibility = args[:friends_list_visibility] if args.key?(:friends_list_visibility) @kind = args[:kind] if args.key?(:kind) @profile_visible = args[:profile_visible] if args.key?(:profile_visible) end diff --git a/generated/google/apis/games_v1/representations.rb b/generated/google/apis/games_v1/representations.rb index 5e3310d59..b00f91086 100644 --- a/generated/google/apis/games_v1/representations.rb +++ b/generated/google/apis/games_v1/representations.rb @@ -1104,6 +1104,7 @@ module Google property :display_name, as: 'displayName' property :experience_info, as: 'experienceInfo', class: Google::Apis::GamesV1::PlayerExperienceInfo, decorator: Google::Apis::GamesV1::PlayerExperienceInfo::Representation + property :friend_status, as: 'friendStatus' property :kind, as: 'kind' property :last_played_with, as: 'lastPlayedWith', class: Google::Apis::GamesV1::Played, decorator: Google::Apis::GamesV1::Played::Representation @@ -1277,6 +1278,7 @@ module Google class ProfileSettings # @private class Representation < Google::Apis::Core::JsonRepresentation + property :friends_list_visibility, as: 'friendsListVisibility' property :kind, as: 'kind' property :profile_visible, as: 'profileVisible' end diff --git a/generated/google/apis/proximitybeacon_v1beta1.rb b/generated/google/apis/gameservices_v1beta.rb similarity index 53% rename from generated/google/apis/proximitybeacon_v1beta1.rb rename to generated/google/apis/gameservices_v1beta.rb index 49c7ac9a5..f51ef7713 100644 --- a/generated/google/apis/proximitybeacon_v1beta1.rb +++ b/generated/google/apis/gameservices_v1beta.rb @@ -12,23 +12,23 @@ # See the License for the specific language governing permissions and # limitations under the License. -require 'google/apis/proximitybeacon_v1beta1/service.rb' -require 'google/apis/proximitybeacon_v1beta1/classes.rb' -require 'google/apis/proximitybeacon_v1beta1/representations.rb' +require 'google/apis/gameservices_v1beta/service.rb' +require 'google/apis/gameservices_v1beta/classes.rb' +require 'google/apis/gameservices_v1beta/representations.rb' module Google module Apis - # Proximity Beacon API + # Game Services API # - # Registers, manages, indexes, and searches beacons. + # Deploy and manage infrastructure for global multiplayer gaming experiences. # - # @see https://developers.google.com/beacons/proximity/ - module ProximitybeaconV1beta1 - VERSION = 'V1beta1' - REVISION = '20190913' + # @see https://cloud.google.com/solutions/gaming/ + module GameservicesV1beta + VERSION = 'V1beta' + REVISION = '20200402' - # View and modify your beacons - AUTH_USERLOCATION_BEACON_REGISTRY = 'https://www.googleapis.com/auth/userlocation.beacon.registry' + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' end end end diff --git a/generated/google/apis/gameservices_v1beta/classes.rb b/generated/google/apis/gameservices_v1beta/classes.rb new file mode 100644 index 000000000..d30e63a0f --- /dev/null +++ b/generated/google/apis/gameservices_v1beta/classes.rb @@ -0,0 +1,2342 @@ +# Copyright 2015 Google Inc. +# +# 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 GameservicesV1beta + + # 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 AuditConfig + include Google::Apis::Core::Hashable + + # The configuration for logging of each type of permission. + # Corresponds to the JSON property `auditLogConfigs` + # @return [Array] + attr_accessor :audit_log_configs + + # + # Corresponds to the JSON property `exemptedMembers` + # @return [Array] + attr_accessor :exempted_members + + # 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) + @exempted_members = args[:exempted_members] if args.key?(:exempted_members) + @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 AuditLogConfig + 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] + attr_accessor :exempted_members + + # + # Corresponds to the JSON property `ignoreChildExemptions` + # @return [Boolean] + attr_accessor :ignore_child_exemptions + alias_method :ignore_child_exemptions?, :ignore_child_exemptions + + # 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) + @ignore_child_exemptions = args[:ignore_child_exemptions] if args.key?(:ignore_child_exemptions) + @log_type = args[:log_type] if args.key?(:log_type) + end + end + + # Authorization-related information used by Cloud Audit Logging. + class AuthorizationLoggingOptions + include Google::Apis::Core::Hashable + + # The type of the permission that was checked. + # Corresponds to the JSON property `permissionType` + # @return [String] + attr_accessor :permission_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @permission_type = args[:permission_type] if args.key?(:permission_type) + end + end + + # Associates `members` with a `role`. + class Binding + 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::GameservicesV1beta::Expr] + 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] + 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 CancelOperationRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Write a Cloud Audit log + class CloudAuditOptions + include Google::Apis::Core::Hashable + + # Authorization-related information used by Cloud Audit Logging. + # Corresponds to the JSON property `authorizationLoggingOptions` + # @return [Google::Apis::GameservicesV1beta::AuthorizationLoggingOptions] + attr_accessor :authorization_logging_options + + # The log_name to populate in the Cloud Audit Record. + # Corresponds to the JSON property `logName` + # @return [String] + attr_accessor :log_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @authorization_logging_options = args[:authorization_logging_options] if args.key?(:authorization_logging_options) + @log_name = args[:log_name] if args.key?(:log_name) + end + end + + # A condition to be met. + class Condition + include Google::Apis::Core::Hashable + + # Trusted attributes supplied by the IAM system. + # Corresponds to the JSON property `iam` + # @return [String] + attr_accessor :iam + + # An operator to apply the subject with. + # Corresponds to the JSON property `op` + # @return [String] + attr_accessor :op + + # Trusted attributes discharged by the service. + # Corresponds to the JSON property `svc` + # @return [String] + attr_accessor :svc + + # Trusted attributes supplied by any service that owns resources and uses + # the IAM system for access control. + # Corresponds to the JSON property `sys` + # @return [String] + attr_accessor :sys + + # The objects of the condition. + # Corresponds to the JSON property `values` + # @return [Array] + attr_accessor :values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @iam = args[:iam] if args.key?(:iam) + @op = args[:op] if args.key?(:op) + @svc = args[:svc] if args.key?(:svc) + @sys = args[:sys] if args.key?(:sys) + @values = args[:values] if args.key?(:values) + end + end + + # Increment a streamz counter with the specified metric and field names. + # Metric names should start with a '/', generally be lowercase-only, + # and end in "_count". Field names should not contain an initial slash. + # The actual exported metric names will have "/iam/policy" prepended. + # Field names correspond to IAM request parameters and field values are + # their respective values. + # Supported field names: + # - "authority", which is "[token]" if IAMContext.token is present, + # otherwise the value of IAMContext.authority_selector if present, and + # otherwise a representation of IAMContext.principal; or + # - "iam_principal", a representation of IAMContext.principal even if a + # token or authority selector is present; or + # - "" (empty string), resulting in a counter with no fields. + # Examples: + # counter ` metric: "/debug_access_count" field: "iam_principal" ` + # ==> increment counter /iam/policy/debug_access_count + # `iam_principal=[value of IAMContext.principal]` + class CounterOptions + include Google::Apis::Core::Hashable + + # Custom fields. + # Corresponds to the JSON property `customFields` + # @return [Array] + attr_accessor :custom_fields + + # The field value to attribute. + # Corresponds to the JSON property `field` + # @return [String] + attr_accessor :field + + # The metric to update. + # Corresponds to the JSON property `metric` + # @return [String] + attr_accessor :metric + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @custom_fields = args[:custom_fields] if args.key?(:custom_fields) + @field = args[:field] if args.key?(:field) + @metric = args[:metric] if args.key?(:metric) + end + end + + # Custom fields. + # These can be used to create a counter with arbitrary field/value + # pairs. + # See: go/rpcsp-custom-fields. + class CustomField + include Google::Apis::Core::Hashable + + # Name is the field name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Value is the field value. It is important that in contrast to the + # CounterOptions.field, the value here is a constant that is not + # derived from the IAMContext. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @value = args[:value] if args.key?(:value) + end + end + + # Write a Data Access (Gin) log + class DataAccessOptions + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `logMode` + # @return [String] + attr_accessor :log_mode + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @log_mode = args[:log_mode] if args.key?(:log_mode) + end + end + + # The Game Server Cluster changes made by the Game Server Deployment. + class DeployedClusterState + include Google::Apis::Core::Hashable + + # The name of the cluster. + # Corresponds to the JSON property `cluster` + # @return [String] + attr_accessor :cluster + + # The details about the Agones fleets and autoscalers created in the + # Game Server Cluster. + # Corresponds to the JSON property `fleetDetails` + # @return [Array] + attr_accessor :fleet_details + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cluster = args[:cluster] if args.key?(:cluster) + @fleet_details = args[:fleet_details] if args.key?(:fleet_details) + end + end + + # Agones fleet specification and details. + class DeployedFleet + include Google::Apis::Core::Hashable + + # The name of the Agones fleet. + # Corresponds to the JSON property `fleet` + # @return [String] + attr_accessor :fleet + + # The fleet spec retrieved from the Agones fleet. + # Corresponds to the JSON property `fleetSpec` + # @return [String] + attr_accessor :fleet_spec + + # Encapsulates Agones fleet spec and Agones autoscaler spec sources. + # Corresponds to the JSON property `specSource` + # @return [Google::Apis::GameservicesV1beta::SpecSource] + attr_accessor :spec_source + + # DeployedFleetStatus has details about the Agones fleets such as how many + # are running, how many allocated, and so on. + # Corresponds to the JSON property `status` + # @return [Google::Apis::GameservicesV1beta::DeployedFleetStatus] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fleet = args[:fleet] if args.key?(:fleet) + @fleet_spec = args[:fleet_spec] if args.key?(:fleet_spec) + @spec_source = args[:spec_source] if args.key?(:spec_source) + @status = args[:status] if args.key?(:status) + end + end + + # Details about the Agones autoscaler. + class DeployedFleetAutoscaler + include Google::Apis::Core::Hashable + + # The name of the Agones autoscaler. + # Corresponds to the JSON property `autoscaler` + # @return [String] + attr_accessor :autoscaler + + # The autoscaler spec retrieved from Agones. + # Corresponds to the JSON property `fleetAutoscalerSpec` + # @return [String] + attr_accessor :fleet_autoscaler_spec + + # Encapsulates Agones fleet spec and Agones autoscaler spec sources. + # Corresponds to the JSON property `specSource` + # @return [Google::Apis::GameservicesV1beta::SpecSource] + attr_accessor :spec_source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @autoscaler = args[:autoscaler] if args.key?(:autoscaler) + @fleet_autoscaler_spec = args[:fleet_autoscaler_spec] if args.key?(:fleet_autoscaler_spec) + @spec_source = args[:spec_source] if args.key?(:spec_source) + end + end + + # Details of the deployed Agones fleet. + class DeployedFleetDetails + include Google::Apis::Core::Hashable + + # Details about the Agones autoscaler. + # Corresponds to the JSON property `deployedAutoscaler` + # @return [Google::Apis::GameservicesV1beta::DeployedFleetAutoscaler] + attr_accessor :deployed_autoscaler + + # Agones fleet specification and details. + # Corresponds to the JSON property `deployedFleet` + # @return [Google::Apis::GameservicesV1beta::DeployedFleet] + attr_accessor :deployed_fleet + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @deployed_autoscaler = args[:deployed_autoscaler] if args.key?(:deployed_autoscaler) + @deployed_fleet = args[:deployed_fleet] if args.key?(:deployed_fleet) + end + end + + # DeployedFleetStatus has details about the Agones fleets such as how many + # are running, how many allocated, and so on. + class DeployedFleetStatus + include Google::Apis::Core::Hashable + + # The number of GameServer replicas in the ALLOCATED state in this fleet. + # Corresponds to the JSON property `allocatedReplicas` + # @return [Fixnum] + attr_accessor :allocated_replicas + + # The number of GameServer replicas in the READY state in this fleet. + # Corresponds to the JSON property `readyReplicas` + # @return [Fixnum] + attr_accessor :ready_replicas + + # The total number of current GameServer replicas in this fleet. + # Corresponds to the JSON property `replicas` + # @return [Fixnum] + attr_accessor :replicas + + # The number of GameServer replicas in the RESERVED state in this fleet. + # Reserved instances won't be deleted on scale down, but won't cause + # an autoscaler to scale up. + # Corresponds to the JSON property `reservedReplicas` + # @return [Fixnum] + attr_accessor :reserved_replicas + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allocated_replicas = args[:allocated_replicas] if args.key?(:allocated_replicas) + @ready_replicas = args[:ready_replicas] if args.key?(:ready_replicas) + @replicas = args[:replicas] if args.key?(:replicas) + @reserved_replicas = args[:reserved_replicas] if args.key?(:reserved_replicas) + 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 + + # 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 Expr + 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 + + # Request message for GameServerDeploymentsService.FetchDeploymentState. + class FetchDeploymentStateRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Response message for GameServerDeploymentsService.FetchDeploymentState. + class FetchDeploymentStateResponse + include Google::Apis::Core::Hashable + + # The state of the Game Server Deployment in each Game Server Cluster. + # Corresponds to the JSON property `clusterState` + # @return [Array] + attr_accessor :cluster_state + + # List of Locations that could not be reached. + # Corresponds to the JSON property `unavailable` + # @return [Array] + attr_accessor :unavailable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cluster_state = args[:cluster_state] if args.key?(:cluster_state) + @unavailable = args[:unavailable] if args.key?(:unavailable) + end + end + + # Fleet configs for Agones. + class FleetConfig + include Google::Apis::Core::Hashable + + # Agones fleet spec. Example spec: + # `https://agones.dev/site/docs/reference/fleet/`. + # Corresponds to the JSON property `fleetSpec` + # @return [String] + attr_accessor :fleet_spec + + # The name of the FleetConfig. + # 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) + @fleet_spec = args[:fleet_spec] if args.key?(:fleet_spec) + @name = args[:name] if args.key?(:name) + end + end + + # A Game Server Cluster resource. + class GameServerCluster + include Google::Apis::Core::Hashable + + # The Game Server Cluster connection information. + # Corresponds to the JSON property `connectionInfo` + # @return [Google::Apis::GameservicesV1beta::GameServerClusterConnectionInfo] + attr_accessor :connection_info + + # Output only. The creation time. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Human readable description of the cluster. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # ETag of the resource. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The labels associated with this Game Server Cluster. Each label is a + # key-value pair. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Required. The resource name of the Game Server Cluster. Uses the form: + # `projects/`project`/locations/`location`/realms/`realm`/gameServerClusters/` + # cluster``. + # For example, + # `projects/my-project/locations/`location`/realms/zanzibar/gameServerClusters/ + # my-onprem-cluster`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. The last-modified 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) + @connection_info = args[:connection_info] if args.key?(:connection_info) + @create_time = args[:create_time] if args.key?(:create_time) + @description = args[:description] if args.key?(:description) + @etag = args[:etag] if args.key?(:etag) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # The Game Server Cluster connection information. + class GameServerClusterConnectionInfo + include Google::Apis::Core::Hashable + + # A reference to a GKE cluster. + # Corresponds to the JSON property `gkeClusterReference` + # @return [Google::Apis::GameservicesV1beta::GkeClusterReference] + attr_accessor :gke_cluster_reference + + # Namespace designated on the Game Server Cluster where the Agones game + # server instances will be created. Existence of the namespace will be + # validated during creation. + # Corresponds to the JSON property `namespace` + # @return [String] + attr_accessor :namespace + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @gke_cluster_reference = args[:gke_cluster_reference] if args.key?(:gke_cluster_reference) + @namespace = args[:namespace] if args.key?(:namespace) + end + end + + # A Game Server Config resource. + class GameServerConfig + include Google::Apis::Core::Hashable + + # Output only. The creation time. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # The description of the Game Server Config. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # FleetConfig contains a list of Agones fleet specs. Only one FleetConfig + # is allowed. + # Corresponds to the JSON property `fleetConfigs` + # @return [Array] + attr_accessor :fleet_configs + + # The labels associated with this Game Server Config. Each label is a + # key-value pair. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # The resource name of the Game Server Config. Uses the form: + # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/ + # configs/`config``. + # For example, + # `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my- + # config`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The autoscaling settings. + # Corresponds to the JSON property `scalingConfigs` + # @return [Array] + attr_accessor :scaling_configs + + # Output only. The last-modified 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) + @description = args[:description] if args.key?(:description) + @fleet_configs = args[:fleet_configs] if args.key?(:fleet_configs) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @scaling_configs = args[:scaling_configs] if args.key?(:scaling_configs) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # A Game Server Config override. + class GameServerConfigOverride + include Google::Apis::Core::Hashable + + # The game server config for this override. + # Corresponds to the JSON property `configVersion` + # @return [String] + attr_accessor :config_version + + # The Realm selector, used to match Realm resources. + # Corresponds to the JSON property `realmsSelector` + # @return [Google::Apis::GameservicesV1beta::RealmSelector] + attr_accessor :realms_selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @config_version = args[:config_version] if args.key?(:config_version) + @realms_selector = args[:realms_selector] if args.key?(:realms_selector) + end + end + + # A Game Server Deployment resource. + class GameServerDeployment + include Google::Apis::Core::Hashable + + # Output only. The creation time. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Human readable description of the Game Server Deployment. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # ETag of the resource. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The labels associated with this Game Server Deployment. Each label is a + # key-value pair. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # The resource name of the Game Server Deployment. Uses the form: + # `projects/`project`/locations/`location`/gameServerDeployments/`deployment``. + # For example, + # `projects/my-project/locations/`location`/gameServerDeployments/my-deployment`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. The last-modified 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) + @description = args[:description] if args.key?(:description) + @etag = args[:etag] if args.key?(:etag) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # The Game Server Deployment Rollout which represents the desired rollout + # state. + class GameServerDeploymentRollout + include Google::Apis::Core::Hashable + + # Output only. The creation time. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # The default Game Server Config is applied to all Realms unless overridden + # in the Rollout. For example, + # `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my- + # config`. + # Corresponds to the JSON property `defaultGameServerConfig` + # @return [String] + attr_accessor :default_game_server_config + + # ETag of the resource. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # Contains the Game Server Config Rollout overrides. Overrides are processed + # in the order they are listed. Once a match is found for a Realm, the rest + # of the list is not processed. + # Corresponds to the JSON property `gameServerConfigOverrides` + # @return [Array] + attr_accessor :game_server_config_overrides + + # The resource name of the Game Server Deployment Rollout. Uses the form: + # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/ + # rollout`. + # For example, + # `projects/my-project/locations/`location`/gameServerDeployments/my-deployment/ + # rollout`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. The last-modified 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) + @default_game_server_config = args[:default_game_server_config] if args.key?(:default_game_server_config) + @etag = args[:etag] if args.key?(:etag) + @game_server_config_overrides = args[:game_server_config_overrides] if args.key?(:game_server_config_overrides) + @name = args[:name] if args.key?(:name) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # A reference to a GKE cluster. + class GkeClusterReference + include Google::Apis::Core::Hashable + + # The full or partial name of a GKE cluster, using one of the following + # forms: + # * `projects/`project`/locations/`location`/clusters/`cluster`` + # * `locations/`location`/clusters/`cluster`` + # * ``cluster`` + # If project and location are not specified, the project and location of the + # GameServerCluster resource are used to generate the full name of the + # GKE cluster. + # Corresponds to the JSON property `cluster` + # @return [String] + attr_accessor :cluster + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cluster = args[:cluster] if args.key?(:cluster) + end + end + + # The label selector, used to group labels on the resources. + class LabelSelector + include Google::Apis::Core::Hashable + + # Resource labels for this selector. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @labels = args[:labels] if args.key?(:labels) + end + end + + # Response message for GameServerClustersService.ListGameServerClusters. + class ListGameServerClustersResponse + include Google::Apis::Core::Hashable + + # The list of Game Server Clusters. + # Corresponds to the JSON property `gameServerClusters` + # @return [Array] + attr_accessor :game_server_clusters + + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # List of Locations that could not be reached. + # Corresponds to the JSON property `unreachable` + # @return [Array] + attr_accessor :unreachable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @game_server_clusters = args[:game_server_clusters] if args.key?(:game_server_clusters) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @unreachable = args[:unreachable] if args.key?(:unreachable) + end + end + + # Response message for GameServerConfigsService.ListGameServerConfigs. + class ListGameServerConfigsResponse + include Google::Apis::Core::Hashable + + # The list of Game Server Configs. + # Corresponds to the JSON property `gameServerConfigs` + # @return [Array] + attr_accessor :game_server_configs + + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # List of Locations that could not be reached. + # Corresponds to the JSON property `unreachable` + # @return [Array] + attr_accessor :unreachable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @game_server_configs = args[:game_server_configs] if args.key?(:game_server_configs) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @unreachable = args[:unreachable] if args.key?(:unreachable) + end + end + + # Response message for GameServerDeploymentsService.ListGameServerDeployments. + class ListGameServerDeploymentsResponse + include Google::Apis::Core::Hashable + + # The list of Game Server Delpoyments. + # Corresponds to the JSON property `gameServerDeployments` + # @return [Array] + attr_accessor :game_server_deployments + + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # List of Locations that could not be reached. + # Corresponds to the JSON property `unreachable` + # @return [Array] + attr_accessor :unreachable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @game_server_deployments = args[:game_server_deployments] if args.key?(:game_server_deployments) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @unreachable = args[:unreachable] if args.key?(:unreachable) + end + end + + # The response message for Locations.ListLocations. + class ListLocationsResponse + 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] + 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 ListOperationsResponse + 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] + 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 + + # Response message for RealmsService.ListRealms. + class ListRealmsResponse + include Google::Apis::Core::Hashable + + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The list of Realms. + # Corresponds to the JSON property `realms` + # @return [Array] + attr_accessor :realms + + # List of Locations that could not be reached. + # Corresponds to the JSON property `unreachable` + # @return [Array] + attr_accessor :unreachable + + 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) + @realms = args[:realms] if args.key?(:realms) + @unreachable = args[:unreachable] if args.key?(:unreachable) + end + end + + # A resource that represents Google Cloud Platform location. + class Location + 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] + 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] + 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 + + # Specifies what kind of log the caller must write + class LogConfig + include Google::Apis::Core::Hashable + + # Write a Cloud Audit log + # Corresponds to the JSON property `cloudAudit` + # @return [Google::Apis::GameservicesV1beta::CloudAuditOptions] + attr_accessor :cloud_audit + + # Increment a streamz counter with the specified metric and field names. + # Metric names should start with a '/', generally be lowercase-only, + # and end in "_count". Field names should not contain an initial slash. + # The actual exported metric names will have "/iam/policy" prepended. + # Field names correspond to IAM request parameters and field values are + # their respective values. + # Supported field names: + # - "authority", which is "[token]" if IAMContext.token is present, + # otherwise the value of IAMContext.authority_selector if present, and + # otherwise a representation of IAMContext.principal; or + # - "iam_principal", a representation of IAMContext.principal even if a + # token or authority selector is present; or + # - "" (empty string), resulting in a counter with no fields. + # Examples: + # counter ` metric: "/debug_access_count" field: "iam_principal" ` + # ==> increment counter /iam/policy/debug_access_count + # `iam_principal=[value of IAMContext.principal]` + # Corresponds to the JSON property `counter` + # @return [Google::Apis::GameservicesV1beta::CounterOptions] + attr_accessor :counter + + # Write a Data Access (Gin) log + # Corresponds to the JSON property `dataAccess` + # @return [Google::Apis::GameservicesV1beta::DataAccessOptions] + attr_accessor :data_access + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cloud_audit = args[:cloud_audit] if args.key?(:cloud_audit) + @counter = args[:counter] if args.key?(:counter) + @data_access = args[:data_access] if args.key?(:data_access) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + class Operation + 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::GameservicesV1beta::Status] + 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] + 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] + 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 OperationMetadata + 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. The time the operation finished running. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Output only. Operation status for gameservices API operations. Operation + # status is in + # the form of key-value pairs where keys are resource IDs and the values show + # the status of the operation. In case of failures, the value includes an + # error code and error message. + # Corresponds to the JSON property `operationStatus` + # @return [Hash] + attr_accessor :operation_status + + # 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. List of Locations that could not be reached. + # Corresponds to the JSON property `unreachable` + # @return [Array] + attr_accessor :unreachable + + # 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) + @end_time = args[:end_time] if args.key?(:end_time) + @operation_status = args[:operation_status] if args.key?(:operation_status) + @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) + @unreachable = args[:unreachable] if args.key?(:unreachable) + @verb = args[:verb] if args.key?(:verb) + end + end + + # + class OperationStatus + include Google::Apis::Core::Hashable + + # Output only. Whether the operation is done or still in progress. + # Corresponds to the JSON property `done` + # @return [Boolean] + attr_accessor :done + alias_method :done?, :done + + # The error code in case of failures. + # Corresponds to the JSON property `errorCode` + # @return [String] + attr_accessor :error_code + + # The human-readable error message. + # Corresponds to the JSON property `errorMessage` + # @return [String] + attr_accessor :error_message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @done = args[:done] if args.key?(:done) + @error_code = args[:error_code] if args.key?(:error_code) + @error_message = args[:error_message] if args.key?(:error_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. + # Optionally, a `binding` can 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. + # **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 Policy + include Google::Apis::Core::Hashable + + # Specifies cloud audit logging configuration for this policy. + # Corresponds to the JSON property `auditConfigs` + # @return [Array] + 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] + 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 + + # + # Corresponds to the JSON property `iamOwned` + # @return [Boolean] + attr_accessor :iam_owned + alias_method :iam_owned?, :iam_owned + + # If more than one rule is specified, the rules are applied in the following + # manner: + # - All matching LOG rules are always applied. + # - If any DENY/DENY_WITH_LOG rule matches, permission is denied. + # Logging will be applied if one or more matching rule requires logging. + # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is + # granted. + # Logging will be applied if one or more matching rule requires logging. + # - Otherwise, if no rule applies, permission is denied. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + # 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. + # 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) + @iam_owned = args[:iam_owned] if args.key?(:iam_owned) + @rules = args[:rules] if args.key?(:rules) + @version = args[:version] if args.key?(:version) + end + end + + # Response message for + # GameServerClustersService.PreviewCreateGameServerCluster. + class PreviewCreateGameServerClusterResponse + include Google::Apis::Core::Hashable + + # The ETag of the game server cluster. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # Encapsulates the Target state. + # Corresponds to the JSON property `targetState` + # @return [Google::Apis::GameservicesV1beta::TargetState] + attr_accessor :target_state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @target_state = args[:target_state] if args.key?(:target_state) + end + end + + # Response message for + # GameServerClustersService.PreviewDeleteGameServerCluster. + class PreviewDeleteGameServerClusterResponse + include Google::Apis::Core::Hashable + + # The ETag of the game server cluster. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # Encapsulates the Target state. + # Corresponds to the JSON property `targetState` + # @return [Google::Apis::GameservicesV1beta::TargetState] + attr_accessor :target_state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @target_state = args[:target_state] if args.key?(:target_state) + end + end + + # Response message for PreviewGameServerDeploymentRollout. + # This has details about the Agones fleet and autoscaler to be actuated. + class PreviewGameServerDeploymentRolloutResponse + include Google::Apis::Core::Hashable + + # ETag of the Game Server Deployment. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # Encapsulates the Target state. + # Corresponds to the JSON property `targetState` + # @return [Google::Apis::GameservicesV1beta::TargetState] + attr_accessor :target_state + + # Locations that could not be reached on this request. + # Corresponds to the JSON property `unavailable` + # @return [Array] + attr_accessor :unavailable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @target_state = args[:target_state] if args.key?(:target_state) + @unavailable = args[:unavailable] if args.key?(:unavailable) + end + end + + # Response message for RealmsService.PreviewRealmUpdate. + class PreviewRealmUpdateResponse + include Google::Apis::Core::Hashable + + # ETag of the realm. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # Encapsulates the Target state. + # Corresponds to the JSON property `targetState` + # @return [Google::Apis::GameservicesV1beta::TargetState] + attr_accessor :target_state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @target_state = args[:target_state] if args.key?(:target_state) + end + end + + # Response message for GameServerClustersService.PreviewUpdateGameServerCluster + class PreviewUpdateGameServerClusterResponse + include Google::Apis::Core::Hashable + + # The ETag of the game server cluster. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # Encapsulates the Target state. + # Corresponds to the JSON property `targetState` + # @return [Google::Apis::GameservicesV1beta::TargetState] + attr_accessor :target_state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @target_state = args[:target_state] if args.key?(:target_state) + end + end + + # A Realm resource. + class Realm + include Google::Apis::Core::Hashable + + # Output only. The creation time. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Human readable description of the Realm. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # ETag of the resource. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The labels associated with this Realm. Each label is a key-value pair. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # The resource name of the Realm. Uses the form: + # `projects/`project`/locations/`location`/realms/`realm``. For + # example, `projects/my-project/locations/`location`/realms/my-realm`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Required. Time zone where all policies targeting this Realm are evaluated. The + # value + # of this field must be from the IANA time zone database: + # https://www.iana.org/time-zones. + # Corresponds to the JSON property `timeZone` + # @return [String] + attr_accessor :time_zone + + # Output only. The last-modified 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) + @description = args[:description] if args.key?(:description) + @etag = args[:etag] if args.key?(:etag) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @time_zone = args[:time_zone] if args.key?(:time_zone) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # The Realm selector, used to match Realm resources. + class RealmSelector + include Google::Apis::Core::Hashable + + # List of Realms to match. + # Corresponds to the JSON property `realms` + # @return [Array] + attr_accessor :realms + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @realms = args[:realms] if args.key?(:realms) + end + end + + # A rule to be applied in a Policy. + class Rule + include Google::Apis::Core::Hashable + + # Required + # Corresponds to the JSON property `action` + # @return [String] + attr_accessor :action + + # Additional restrictions that must be met. All conditions must pass for the + # rule to match. + # Corresponds to the JSON property `conditions` + # @return [Array] + attr_accessor :conditions + + # Human-readable description of the rule. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # If one or more 'in' clauses are specified, the rule matches if + # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. + # Corresponds to the JSON property `in` + # @return [Array] + attr_accessor :in + + # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries + # that match the LOG action. + # Corresponds to the JSON property `logConfig` + # @return [Array] + attr_accessor :log_config + + # If one or more 'not_in' clauses are specified, the rule matches + # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. + # The format for in and not_in entries can be found at in the Local IAM + # documentation (see go/local-iam#features). + # Corresponds to the JSON property `notIn` + # @return [Array] + attr_accessor :not_in + + # A permission is a string of form '..' + # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, + # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. + # Corresponds to the JSON property `permissions` + # @return [Array] + attr_accessor :permissions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action = args[:action] if args.key?(:action) + @conditions = args[:conditions] if args.key?(:conditions) + @description = args[:description] if args.key?(:description) + @in = args[:in] if args.key?(:in) + @log_config = args[:log_config] if args.key?(:log_config) + @not_in = args[:not_in] if args.key?(:not_in) + @permissions = args[:permissions] if args.key?(:permissions) + end + end + + # Autoscaling config for an Agones fleet. + class ScalingConfig + include Google::Apis::Core::Hashable + + # Required. Agones fleet autoscaler spec. Example spec: + # https://agones.dev/site/docs/reference/fleetautoscaler/ + # Corresponds to the JSON property `fleetAutoscalerSpec` + # @return [String] + attr_accessor :fleet_autoscaler_spec + + # Required. The name of the Scaling Config + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The schedules to which this Scaling Config applies. + # Corresponds to the JSON property `schedules` + # @return [Array] + attr_accessor :schedules + + # Labels used to identify the Game Server Clusters to which this Agones + # scaling config applies. A Game Server Cluster is subject to this Agones + # scaling config if its labels match any of the selector entries. + # Corresponds to the JSON property `selectors` + # @return [Array] + attr_accessor :selectors + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fleet_autoscaler_spec = args[:fleet_autoscaler_spec] if args.key?(:fleet_autoscaler_spec) + @name = args[:name] if args.key?(:name) + @schedules = args[:schedules] if args.key?(:schedules) + @selectors = args[:selectors] if args.key?(:selectors) + end + end + + # The schedule of a recurring or one time event. The event's time span is + # specified by start_time and end_time. If the scheduled event's timespan is + # larger than the cron_spec + cron_job_duration, the event will be recurring. + # If only cron_spec + cron_job_duration are specified, the event is effective + # starting at the local time specified by cron_spec, and is recurring. + # start_time|-------[cron job]-------[cron job]-------[cron job]---|end_time + # cron job: cron spec start time + duration + class Schedule + include Google::Apis::Core::Hashable + + # The duration for the cron job event. The duration of the event is effective + # after the cron job's start time. + # Corresponds to the JSON property `cronJobDuration` + # @return [String] + attr_accessor :cron_job_duration + + # The cron definition of the scheduled event. See + # https://en.wikipedia.org/wiki/Cron. Cron spec specifies the local time as + # defined by the Realm. + # Corresponds to the JSON property `cronSpec` + # @return [String] + attr_accessor :cron_spec + + # The end time of the event. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # The start time of the event. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cron_job_duration = args[:cron_job_duration] if args.key?(:cron_job_duration) + @cron_spec = args[:cron_spec] if args.key?(:cron_spec) + @end_time = args[:end_time] if args.key?(:end_time) + @start_time = args[:start_time] if args.key?(:start_time) + end + end + + # Request message for `SetIamPolicy` method. + class SetIamPolicyRequest + 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. + # Optionally, a `binding` can 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. + # **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::GameservicesV1beta::Policy] + 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" + # This field is only used by Cloud IAM. + # 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 + + # Encapsulates Agones fleet spec and Agones autoscaler spec sources. + class SpecSource + include Google::Apis::Core::Hashable + + # The Game Server Config resource. Uses the form: + # `projects/`project`/locations/`location`/gameServerDeployments/`deployment_id`/ + # configs/`config_id``. + # Corresponds to the JSON property `gameServerConfigName` + # @return [String] + attr_accessor :game_server_config_name + + # The name of the Agones leet config or Agones scaling config used to derive + # the Agones fleet or Agones autoscaler spec. + # 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) + @game_server_config_name = args[:game_server_config_name] if args.key?(:game_server_config_name) + @name = args[:name] if args.key?(:name) + 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 Status + 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>] + 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 + + # Details about the Agones resources. + class TargetDetails + include Google::Apis::Core::Hashable + + # Agones fleet details for Game Server Clusters and Game Server Deployments. + # Corresponds to the JSON property `fleetDetails` + # @return [Array] + attr_accessor :fleet_details + + # The Game Server Cluster name. Uses the form: + # `projects/`project`/locations/`location`/realms/`realm`/gameServerClusters/` + # cluster``. + # Corresponds to the JSON property `gameServerClusterName` + # @return [String] + attr_accessor :game_server_cluster_name + + # The Game Server Deployment name. Uses the form: + # `projects/`project`/locations/`location`/gameServerDeployments/`deployment_id`` + # . + # Corresponds to the JSON property `gameServerDeploymentName` + # @return [String] + attr_accessor :game_server_deployment_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fleet_details = args[:fleet_details] if args.key?(:fleet_details) + @game_server_cluster_name = args[:game_server_cluster_name] if args.key?(:game_server_cluster_name) + @game_server_deployment_name = args[:game_server_deployment_name] if args.key?(:game_server_deployment_name) + end + end + + # Target Agones fleet specification. + class TargetFleet + include Google::Apis::Core::Hashable + + # The name of the Agones fleet. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Encapsulates Agones fleet spec and Agones autoscaler spec sources. + # Corresponds to the JSON property `specSource` + # @return [Google::Apis::GameservicesV1beta::SpecSource] + attr_accessor :spec_source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @spec_source = args[:spec_source] if args.key?(:spec_source) + end + end + + # Target Agones autoscaler policy reference. + class TargetFleetAutoscaler + include Google::Apis::Core::Hashable + + # The name of the Agones autoscaler. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Encapsulates Agones fleet spec and Agones autoscaler spec sources. + # Corresponds to the JSON property `specSource` + # @return [Google::Apis::GameservicesV1beta::SpecSource] + attr_accessor :spec_source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @spec_source = args[:spec_source] if args.key?(:spec_source) + end + end + + # Details of the target Agones fleet. + class TargetFleetDetails + include Google::Apis::Core::Hashable + + # Target Agones autoscaler policy reference. + # Corresponds to the JSON property `autoscaler` + # @return [Google::Apis::GameservicesV1beta::TargetFleetAutoscaler] + attr_accessor :autoscaler + + # Target Agones fleet specification. + # Corresponds to the JSON property `fleet` + # @return [Google::Apis::GameservicesV1beta::TargetFleet] + attr_accessor :fleet + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @autoscaler = args[:autoscaler] if args.key?(:autoscaler) + @fleet = args[:fleet] if args.key?(:fleet) + end + end + + # Encapsulates the Target state. + class TargetState + include Google::Apis::Core::Hashable + + # Details about Agones fleets. + # Corresponds to the JSON property `details` + # @return [Array] + attr_accessor :details + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @details = args[:details] if args.key?(:details) + end + end + + # Request message for `TestIamPermissions` method. + class TestIamPermissionsRequest + 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] + 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 TestIamPermissionsResponse + include Google::Apis::Core::Hashable + + # A subset of `TestPermissionsRequest.permissions` that the caller is + # allowed. + # Corresponds to the JSON property `permissions` + # @return [Array] + 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 + end + end +end diff --git a/generated/google/apis/gameservices_v1beta/representations.rb b/generated/google/apis/gameservices_v1beta/representations.rb new file mode 100644 index 000000000..d6b2aca91 --- /dev/null +++ b/generated/google/apis/gameservices_v1beta/representations.rb @@ -0,0 +1,971 @@ +# Copyright 2015 Google Inc. +# +# 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 GameservicesV1beta + + class AuditConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuditLogConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuthorizationLoggingOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Binding + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CancelOperationRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CloudAuditOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Condition + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CounterOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomField + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DataAccessOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeployedClusterState + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeployedFleet + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeployedFleetAutoscaler + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeployedFleetDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeployedFleetStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Expr + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FetchDeploymentStateRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FetchDeploymentStateResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FleetConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GameServerCluster + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GameServerClusterConnectionInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GameServerConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GameServerConfigOverride + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GameServerDeployment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GameServerDeploymentRollout + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GkeClusterReference + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LabelSelector + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListGameServerClustersResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListGameServerConfigsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListGameServerDeploymentsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListLocationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListOperationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListRealmsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Location + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LogConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Operation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OperationStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Policy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PreviewCreateGameServerClusterResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PreviewDeleteGameServerClusterResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PreviewGameServerDeploymentRolloutResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PreviewRealmUpdateResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PreviewUpdateGameServerClusterResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Realm + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RealmSelector + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Rule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ScalingConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Schedule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SetIamPolicyRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SpecSource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Status + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TargetDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TargetFleet + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TargetFleetAutoscaler + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TargetFleetDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TargetState + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TestIamPermissionsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TestIamPermissionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuditConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::GameservicesV1beta::AuditLogConfig, decorator: Google::Apis::GameservicesV1beta::AuditLogConfig::Representation + + collection :exempted_members, as: 'exemptedMembers' + property :service, as: 'service' + end + end + + class AuditLogConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :exempted_members, as: 'exemptedMembers' + property :ignore_child_exemptions, as: 'ignoreChildExemptions' + property :log_type, as: 'logType' + end + end + + class AuthorizationLoggingOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :permission_type, as: 'permissionType' + end + end + + class Binding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :condition, as: 'condition', class: Google::Apis::GameservicesV1beta::Expr, decorator: Google::Apis::GameservicesV1beta::Expr::Representation + + collection :members, as: 'members' + property :role, as: 'role' + end + end + + class CancelOperationRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class CloudAuditOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :authorization_logging_options, as: 'authorizationLoggingOptions', class: Google::Apis::GameservicesV1beta::AuthorizationLoggingOptions, decorator: Google::Apis::GameservicesV1beta::AuthorizationLoggingOptions::Representation + + property :log_name, as: 'logName' + end + end + + class Condition + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :iam, as: 'iam' + property :op, as: 'op' + property :svc, as: 'svc' + property :sys, as: 'sys' + collection :values, as: 'values' + end + end + + class CounterOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :custom_fields, as: 'customFields', class: Google::Apis::GameservicesV1beta::CustomField, decorator: Google::Apis::GameservicesV1beta::CustomField::Representation + + property :field, as: 'field' + property :metric, as: 'metric' + end + end + + class CustomField + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :value, as: 'value' + end + end + + class DataAccessOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :log_mode, as: 'logMode' + end + end + + class DeployedClusterState + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cluster, as: 'cluster' + collection :fleet_details, as: 'fleetDetails', class: Google::Apis::GameservicesV1beta::DeployedFleetDetails, decorator: Google::Apis::GameservicesV1beta::DeployedFleetDetails::Representation + + end + end + + class DeployedFleet + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :fleet, as: 'fleet' + property :fleet_spec, as: 'fleetSpec' + property :spec_source, as: 'specSource', class: Google::Apis::GameservicesV1beta::SpecSource, decorator: Google::Apis::GameservicesV1beta::SpecSource::Representation + + property :status, as: 'status', class: Google::Apis::GameservicesV1beta::DeployedFleetStatus, decorator: Google::Apis::GameservicesV1beta::DeployedFleetStatus::Representation + + end + end + + class DeployedFleetAutoscaler + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :autoscaler, as: 'autoscaler' + property :fleet_autoscaler_spec, as: 'fleetAutoscalerSpec' + property :spec_source, as: 'specSource', class: Google::Apis::GameservicesV1beta::SpecSource, decorator: Google::Apis::GameservicesV1beta::SpecSource::Representation + + end + end + + class DeployedFleetDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :deployed_autoscaler, as: 'deployedAutoscaler', class: Google::Apis::GameservicesV1beta::DeployedFleetAutoscaler, decorator: Google::Apis::GameservicesV1beta::DeployedFleetAutoscaler::Representation + + property :deployed_fleet, as: 'deployedFleet', class: Google::Apis::GameservicesV1beta::DeployedFleet, decorator: Google::Apis::GameservicesV1beta::DeployedFleet::Representation + + end + end + + class DeployedFleetStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :allocated_replicas, :numeric_string => true, as: 'allocatedReplicas' + property :ready_replicas, :numeric_string => true, as: 'readyReplicas' + property :replicas, :numeric_string => true, as: 'replicas' + property :reserved_replicas, :numeric_string => true, as: 'reservedReplicas' + end + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class Expr + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :expression, as: 'expression' + property :location, as: 'location' + property :title, as: 'title' + end + end + + class FetchDeploymentStateRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class FetchDeploymentStateResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :cluster_state, as: 'clusterState', class: Google::Apis::GameservicesV1beta::DeployedClusterState, decorator: Google::Apis::GameservicesV1beta::DeployedClusterState::Representation + + collection :unavailable, as: 'unavailable' + end + end + + class FleetConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :fleet_spec, as: 'fleetSpec' + property :name, as: 'name' + end + end + + class GameServerCluster + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :connection_info, as: 'connectionInfo', class: Google::Apis::GameservicesV1beta::GameServerClusterConnectionInfo, decorator: Google::Apis::GameservicesV1beta::GameServerClusterConnectionInfo::Representation + + property :create_time, as: 'createTime' + property :description, as: 'description' + property :etag, as: 'etag' + hash :labels, as: 'labels' + property :name, as: 'name' + property :update_time, as: 'updateTime' + end + end + + class GameServerClusterConnectionInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :gke_cluster_reference, as: 'gkeClusterReference', class: Google::Apis::GameservicesV1beta::GkeClusterReference, decorator: Google::Apis::GameservicesV1beta::GkeClusterReference::Representation + + property :namespace, as: 'namespace' + end + end + + class GameServerConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :description, as: 'description' + collection :fleet_configs, as: 'fleetConfigs', class: Google::Apis::GameservicesV1beta::FleetConfig, decorator: Google::Apis::GameservicesV1beta::FleetConfig::Representation + + hash :labels, as: 'labels' + property :name, as: 'name' + collection :scaling_configs, as: 'scalingConfigs', class: Google::Apis::GameservicesV1beta::ScalingConfig, decorator: Google::Apis::GameservicesV1beta::ScalingConfig::Representation + + property :update_time, as: 'updateTime' + end + end + + class GameServerConfigOverride + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :config_version, as: 'configVersion' + property :realms_selector, as: 'realmsSelector', class: Google::Apis::GameservicesV1beta::RealmSelector, decorator: Google::Apis::GameservicesV1beta::RealmSelector::Representation + + end + end + + class GameServerDeployment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :description, as: 'description' + property :etag, as: 'etag' + hash :labels, as: 'labels' + property :name, as: 'name' + property :update_time, as: 'updateTime' + end + end + + class GameServerDeploymentRollout + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :default_game_server_config, as: 'defaultGameServerConfig' + property :etag, as: 'etag' + collection :game_server_config_overrides, as: 'gameServerConfigOverrides', class: Google::Apis::GameservicesV1beta::GameServerConfigOverride, decorator: Google::Apis::GameservicesV1beta::GameServerConfigOverride::Representation + + property :name, as: 'name' + property :update_time, as: 'updateTime' + end + end + + class GkeClusterReference + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cluster, as: 'cluster' + end + end + + class LabelSelector + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :labels, as: 'labels' + end + end + + class ListGameServerClustersResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :game_server_clusters, as: 'gameServerClusters', class: Google::Apis::GameservicesV1beta::GameServerCluster, decorator: Google::Apis::GameservicesV1beta::GameServerCluster::Representation + + property :next_page_token, as: 'nextPageToken' + collection :unreachable, as: 'unreachable' + end + end + + class ListGameServerConfigsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :game_server_configs, as: 'gameServerConfigs', class: Google::Apis::GameservicesV1beta::GameServerConfig, decorator: Google::Apis::GameservicesV1beta::GameServerConfig::Representation + + property :next_page_token, as: 'nextPageToken' + collection :unreachable, as: 'unreachable' + end + end + + class ListGameServerDeploymentsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :game_server_deployments, as: 'gameServerDeployments', class: Google::Apis::GameservicesV1beta::GameServerDeployment, decorator: Google::Apis::GameservicesV1beta::GameServerDeployment::Representation + + property :next_page_token, as: 'nextPageToken' + collection :unreachable, as: 'unreachable' + end + end + + class ListLocationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :locations, as: 'locations', class: Google::Apis::GameservicesV1beta::Location, decorator: Google::Apis::GameservicesV1beta::Location::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListOperationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :operations, as: 'operations', class: Google::Apis::GameservicesV1beta::Operation, decorator: Google::Apis::GameservicesV1beta::Operation::Representation + + end + end + + class ListRealmsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :realms, as: 'realms', class: Google::Apis::GameservicesV1beta::Realm, decorator: Google::Apis::GameservicesV1beta::Realm::Representation + + collection :unreachable, as: 'unreachable' + end + end + + class Location + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + hash :labels, as: 'labels' + property :location_id, as: 'locationId' + hash :metadata, as: 'metadata' + property :name, as: 'name' + end + end + + class LogConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cloud_audit, as: 'cloudAudit', class: Google::Apis::GameservicesV1beta::CloudAuditOptions, decorator: Google::Apis::GameservicesV1beta::CloudAuditOptions::Representation + + property :counter, as: 'counter', class: Google::Apis::GameservicesV1beta::CounterOptions, decorator: Google::Apis::GameservicesV1beta::CounterOptions::Representation + + property :data_access, as: 'dataAccess', class: Google::Apis::GameservicesV1beta::DataAccessOptions, decorator: Google::Apis::GameservicesV1beta::DataAccessOptions::Representation + + end + end + + class Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::GameservicesV1beta::Status, decorator: Google::Apis::GameservicesV1beta::Status::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class OperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :api_version, as: 'apiVersion' + property :create_time, as: 'createTime' + property :end_time, as: 'endTime' + hash :operation_status, as: 'operationStatus', class: Google::Apis::GameservicesV1beta::OperationStatus, decorator: Google::Apis::GameservicesV1beta::OperationStatus::Representation + + property :requested_cancellation, as: 'requestedCancellation' + property :status_message, as: 'statusMessage' + property :target, as: 'target' + collection :unreachable, as: 'unreachable' + property :verb, as: 'verb' + end + end + + class OperationStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error_code, as: 'errorCode' + property :error_message, as: 'errorMessage' + end + end + + class Policy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_configs, as: 'auditConfigs', class: Google::Apis::GameservicesV1beta::AuditConfig, decorator: Google::Apis::GameservicesV1beta::AuditConfig::Representation + + collection :bindings, as: 'bindings', class: Google::Apis::GameservicesV1beta::Binding, decorator: Google::Apis::GameservicesV1beta::Binding::Representation + + property :etag, :base64 => true, as: 'etag' + property :iam_owned, as: 'iamOwned' + collection :rules, as: 'rules', class: Google::Apis::GameservicesV1beta::Rule, decorator: Google::Apis::GameservicesV1beta::Rule::Representation + + property :version, as: 'version' + end + end + + class PreviewCreateGameServerClusterResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + property :target_state, as: 'targetState', class: Google::Apis::GameservicesV1beta::TargetState, decorator: Google::Apis::GameservicesV1beta::TargetState::Representation + + end + end + + class PreviewDeleteGameServerClusterResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + property :target_state, as: 'targetState', class: Google::Apis::GameservicesV1beta::TargetState, decorator: Google::Apis::GameservicesV1beta::TargetState::Representation + + end + end + + class PreviewGameServerDeploymentRolloutResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + property :target_state, as: 'targetState', class: Google::Apis::GameservicesV1beta::TargetState, decorator: Google::Apis::GameservicesV1beta::TargetState::Representation + + collection :unavailable, as: 'unavailable' + end + end + + class PreviewRealmUpdateResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + property :target_state, as: 'targetState', class: Google::Apis::GameservicesV1beta::TargetState, decorator: Google::Apis::GameservicesV1beta::TargetState::Representation + + end + end + + class PreviewUpdateGameServerClusterResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + property :target_state, as: 'targetState', class: Google::Apis::GameservicesV1beta::TargetState, decorator: Google::Apis::GameservicesV1beta::TargetState::Representation + + end + end + + class Realm + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :description, as: 'description' + property :etag, as: 'etag' + hash :labels, as: 'labels' + property :name, as: 'name' + property :time_zone, as: 'timeZone' + property :update_time, as: 'updateTime' + end + end + + class RealmSelector + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :realms, as: 'realms' + end + end + + class Rule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action, as: 'action' + collection :conditions, as: 'conditions', class: Google::Apis::GameservicesV1beta::Condition, decorator: Google::Apis::GameservicesV1beta::Condition::Representation + + property :description, as: 'description' + collection :in, as: 'in' + collection :log_config, as: 'logConfig', class: Google::Apis::GameservicesV1beta::LogConfig, decorator: Google::Apis::GameservicesV1beta::LogConfig::Representation + + collection :not_in, as: 'notIn' + collection :permissions, as: 'permissions' + end + end + + class ScalingConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :fleet_autoscaler_spec, as: 'fleetAutoscalerSpec' + property :name, as: 'name' + collection :schedules, as: 'schedules', class: Google::Apis::GameservicesV1beta::Schedule, decorator: Google::Apis::GameservicesV1beta::Schedule::Representation + + collection :selectors, as: 'selectors', class: Google::Apis::GameservicesV1beta::LabelSelector, decorator: Google::Apis::GameservicesV1beta::LabelSelector::Representation + + end + end + + class Schedule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cron_job_duration, as: 'cronJobDuration' + property :cron_spec, as: 'cronSpec' + property :end_time, as: 'endTime' + property :start_time, as: 'startTime' + end + end + + class SetIamPolicyRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :policy, as: 'policy', class: Google::Apis::GameservicesV1beta::Policy, decorator: Google::Apis::GameservicesV1beta::Policy::Representation + + property :update_mask, as: 'updateMask' + end + end + + class SpecSource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :game_server_config_name, as: 'gameServerConfigName' + property :name, as: 'name' + end + end + + class Status + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + + class TargetDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :fleet_details, as: 'fleetDetails', class: Google::Apis::GameservicesV1beta::TargetFleetDetails, decorator: Google::Apis::GameservicesV1beta::TargetFleetDetails::Representation + + property :game_server_cluster_name, as: 'gameServerClusterName' + property :game_server_deployment_name, as: 'gameServerDeploymentName' + end + end + + class TargetFleet + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :spec_source, as: 'specSource', class: Google::Apis::GameservicesV1beta::SpecSource, decorator: Google::Apis::GameservicesV1beta::SpecSource::Representation + + end + end + + class TargetFleetAutoscaler + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :spec_source, as: 'specSource', class: Google::Apis::GameservicesV1beta::SpecSource, decorator: Google::Apis::GameservicesV1beta::SpecSource::Representation + + end + end + + class TargetFleetDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :autoscaler, as: 'autoscaler', class: Google::Apis::GameservicesV1beta::TargetFleetAutoscaler, decorator: Google::Apis::GameservicesV1beta::TargetFleetAutoscaler::Representation + + property :fleet, as: 'fleet', class: Google::Apis::GameservicesV1beta::TargetFleet, decorator: Google::Apis::GameservicesV1beta::TargetFleet::Representation + + end + end + + class TargetState + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :details, as: 'details', class: Google::Apis::GameservicesV1beta::TargetDetails, decorator: Google::Apis::GameservicesV1beta::TargetDetails::Representation + + end + end + + class TestIamPermissionsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class TestIamPermissionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + end + end +end diff --git a/generated/google/apis/gameservices_v1beta/service.rb b/generated/google/apis/gameservices_v1beta/service.rb new file mode 100644 index 000000000..2693b53d9 --- /dev/null +++ b/generated/google/apis/gameservices_v1beta/service.rb @@ -0,0 +1,1469 @@ +# Copyright 2015 Google Inc. +# +# 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 '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 GameservicesV1beta + # Game Services API + # + # Deploy and manage infrastructure for global multiplayer gaming experiences. + # + # @example + # require 'google/apis/gameservices_v1beta' + # + # Gameservices = Google::Apis::GameservicesV1beta # Alias the module + # service = Gameservices::GameServicesService.new + # + # @see https://cloud.google.com/solutions/gaming/ + class GameServicesService < Google::Apis::Core::BaseService + # @return [String] + # API key. Your API key identifies your project and provides you with API access, + # quota, and reports. Required unless you provide an OAuth 2.0 token. + attr_accessor :key + + # @return [String] + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + attr_accessor :quota_user + + def initialize + super('https://gameservices.googleapis.com/', '') + @batch_path = 'batch' + end + + # Gets information about a location. + # @param [String] name + # Resource name for the location. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Location] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Location] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::GameservicesV1beta::Location::Representation + command.response_class = Google::Apis::GameservicesV1beta::Location + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists information about the supported locations for this service. + # @param [String] name + # The resource that owns the locations collection, if applicable. + # @param [String] filter + # The standard list filter. + # @param [Boolean] include_unrevealed_locations + # If true, the returned list will include locations which are not yet + # revealed. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::ListLocationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::ListLocationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_locations(name, filter: nil, include_unrevealed_locations: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}/locations', options) + command.response_representation = Google::Apis::GameservicesV1beta::ListLocationsResponse::Representation + command.response_class = Google::Apis::GameservicesV1beta::ListLocationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['includeUnrevealedLocations'] = include_unrevealed_locations unless include_unrevealed_locations.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new Game Server Deployment in a given project and Location. + # @param [String] parent + # Required. The parent resource name. Uses the form: + # `projects/`project`/locations/`location``. + # @param [Google::Apis::GameservicesV1beta::GameServerDeployment] game_server_deployment_object + # @param [String] deployment_id + # Required. The ID of the Game Server Deployment resource to be created. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_game_server_deployment(parent, game_server_deployment_object = nil, deployment_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+parent}/gameServerDeployments', options) + command.request_representation = Google::Apis::GameservicesV1beta::GameServerDeployment::Representation + command.request_object = game_server_deployment_object + command.response_representation = Google::Apis::GameservicesV1beta::Operation::Representation + command.response_class = Google::Apis::GameservicesV1beta::Operation + command.params['parent'] = parent unless parent.nil? + command.query['deploymentId'] = deployment_id unless deployment_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a single Game Server Deployment. + # @param [String] name + # Required. The name of the Game Server Deployment to delete. Uses the form: + # `projects/`project`/locations/`location`/gameServerDeployments/`deployment``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_game_server_deployment(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::GameservicesV1beta::Operation::Representation + command.response_class = Google::Apis::GameservicesV1beta::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves information about the current state of the Game Server + # Ddeployment. Gathers all the Agones fleets and Agones autoscalers, + # including fleets running an older version of the Game Server Deployment. + # @param [String] name + # Required. The name of the Game Server Deployment. Uses the form: + # `projects/`project`/locations/`location`/gameServerDeployments/`deployment``. + # @param [Google::Apis::GameservicesV1beta::FetchDeploymentStateRequest] fetch_deployment_state_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::FetchDeploymentStateResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::FetchDeploymentStateResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def fetch_game_server_deployment_deployment_state(name, fetch_deployment_state_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+name}:fetchDeploymentState', options) + command.request_representation = Google::Apis::GameservicesV1beta::FetchDeploymentStateRequest::Representation + command.request_object = fetch_deployment_state_request_object + command.response_representation = Google::Apis::GameservicesV1beta::FetchDeploymentStateResponse::Representation + command.response_class = Google::Apis::GameservicesV1beta::FetchDeploymentStateResponse + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets details of a single Game Server Deployment. + # @param [String] name + # Required. The name of the Game Server Deployment to retrieve. Uses the form: + # `projects/`project`/locations/`location`/gameServerDeployments/`deployment``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::GameServerDeployment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::GameServerDeployment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_game_server_deployment(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::GameservicesV1beta::GameServerDeployment::Representation + command.response_class = Google::Apis::GameservicesV1beta::GameServerDeployment + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. + # Returns an empty policy if the resource exists and does not have a policy + # set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Fixnum] options_requested_policy_version + # Optional. The policy format version to be returned. + # Valid values are 0, 1, and 3. Requests specifying an invalid value will be + # rejected. + # Requests for policies with any conditional bindings must specify version 3. + # Policies without any conditional bindings may specify any valid value or + # leave the field unset. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_game_server_deployment_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::GameservicesV1beta::Policy::Representation + command.response_class = Google::Apis::GameservicesV1beta::Policy + command.params['resource'] = resource unless resource.nil? + command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets details a single Game Server Deployment Rollout. + # @param [String] name + # Required. The name of the Game Server Deployment to retrieve. Uses the form: + # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/ + # rollout`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::GameServerDeploymentRollout] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::GameServerDeploymentRollout] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_game_server_deployment_rollout(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}/rollout', options) + command.response_representation = Google::Apis::GameservicesV1beta::GameServerDeploymentRollout::Representation + command.response_class = Google::Apis::GameservicesV1beta::GameServerDeploymentRollout + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists Game Server Deployments in a given project and Location. + # @param [String] parent + # Required. The parent resource name. Uses the form: + # `projects/`project`/locations/`location``. + # @param [String] filter + # Optional. The filter to apply to list results. + # @param [String] order_by + # Optional. Specifies the ordering of results following syntax at + # https://cloud.google.com/apis/design/design_patterns#sorting_order. + # @param [Fixnum] page_size + # Optional. The maximum number of items to return. If unspecified, server + # will pick an appropriate default. Server may return fewer items than + # requested. A caller should only rely on response's + # next_page_token to + # determine if there are more GameServerDeployments left to be queried. + # @param [String] page_token + # Optional. The next_page_token value returned from a previous List request, + # if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::ListGameServerDeploymentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::ListGameServerDeploymentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_game_server_deployments(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+parent}/gameServerDeployments', options) + command.response_representation = Google::Apis::GameservicesV1beta::ListGameServerDeploymentsResponse::Representation + command.response_class = Google::Apis::GameservicesV1beta::ListGameServerDeploymentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Patches a Game Server Deployment. + # @param [String] name + # The resource name of the Game Server Deployment. Uses the form: + # `projects/`project`/locations/`location`/gameServerDeployments/`deployment``. + # For example, + # `projects/my-project/locations/`location`/gameServerDeployments/my-deployment`. + # @param [Google::Apis::GameservicesV1beta::GameServerDeployment] game_server_deployment_object + # @param [String] update_mask + # Required. Mask of fields to update. At least one path must be supplied in + # this field. For the `FieldMask` definition, see + # https: + # //developers.google.com/protocol-buffers + # // /docs/reference/google.protobuf#fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_game_server_deployment(name, game_server_deployment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta/{+name}', options) + command.request_representation = Google::Apis::GameservicesV1beta::GameServerDeployment::Representation + command.request_object = game_server_deployment_object + command.response_representation = Google::Apis::GameservicesV1beta::Operation::Representation + command.response_class = Google::Apis::GameservicesV1beta::Operation + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Previews the Game Server Deployment Rollout. This API does not mutate the + # Rollout resource. + # @param [String] name + # The resource name of the Game Server Deployment Rollout. Uses the form: + # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/ + # rollout`. + # For example, + # `projects/my-project/locations/`location`/gameServerDeployments/my-deployment/ + # rollout`. + # @param [Google::Apis::GameservicesV1beta::GameServerDeploymentRollout] game_server_deployment_rollout_object + # @param [String] preview_time + # Optional. The target timestamp to compute the preview. Defaults to the + # immediately + # after the proposed Rollout completes. + # @param [String] update_mask + # Optional. Mask of fields to update. At least one path must be supplied in + # this field. For the `FieldMask` definition, see + # https: + # //developers.google.com/protocol-buffers + # // /docs/reference/google.protobuf#fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::PreviewGameServerDeploymentRolloutResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::PreviewGameServerDeploymentRolloutResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def preview_project_location_game_server_deployment_rollout(name, game_server_deployment_rollout_object = nil, preview_time: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta/{+name}/rollout:preview', options) + command.request_representation = Google::Apis::GameservicesV1beta::GameServerDeploymentRollout::Representation + command.request_object = game_server_deployment_rollout_object + command.response_representation = Google::Apis::GameservicesV1beta::PreviewGameServerDeploymentRolloutResponse::Representation + command.response_class = Google::Apis::GameservicesV1beta::PreviewGameServerDeploymentRolloutResponse + command.params['name'] = name unless name.nil? + command.query['previewTime'] = preview_time unless preview_time.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. + # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::GameservicesV1beta::SetIamPolicyRequest] set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_game_server_deployment_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::GameservicesV1beta::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::GameservicesV1beta::Policy::Representation + command.response_class = Google::Apis::GameservicesV1beta::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns permissions that a caller has on the specified resource. + # If the resource does not exist, this will return an empty set of + # permissions, not a NOT_FOUND error. + # Note: This operation is designed to be used for building permission-aware + # UIs and command-line tools, not for authorization checking. This operation + # may "fail open" without warning. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::GameservicesV1beta::TestIamPermissionsRequest] test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_game_server_deployment_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::GameservicesV1beta::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::GameservicesV1beta::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::GameservicesV1beta::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Patches a single Game Server Deployment Rollout. + # The method will not return an error if the update does not affect any + # existing realms. For example - if the default_game_server_config is changed + # but all existing realms use the override, that is valid. Similarly, if a + # non existing realm is explicitly called out in game_server_config_overrides + # field, that will also not result in an error. + # @param [String] name + # The resource name of the Game Server Deployment Rollout. Uses the form: + # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/ + # rollout`. + # For example, + # `projects/my-project/locations/`location`/gameServerDeployments/my-deployment/ + # rollout`. + # @param [Google::Apis::GameservicesV1beta::GameServerDeploymentRollout] game_server_deployment_rollout_object + # @param [String] update_mask + # Required. Mask of fields to update. At least one path must be supplied in + # this field. For the `FieldMask` definition, see + # https: + # //developers.google.com/protocol-buffers + # // /docs/reference/google.protobuf#fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_project_location_game_server_deployment_rollout(name, game_server_deployment_rollout_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta/{+name}/rollout', options) + command.request_representation = Google::Apis::GameservicesV1beta::GameServerDeploymentRollout::Representation + command.request_object = game_server_deployment_rollout_object + command.response_representation = Google::Apis::GameservicesV1beta::Operation::Representation + command.response_class = Google::Apis::GameservicesV1beta::Operation + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new Game Server Config in a given project, Location, and Game + # Server Deployment. Game Server Configs are immutable, and are not applied + # until referenced in the Game Server Deployment Rollout resource. + # @param [String] parent + # Required. The parent resource name. Uses the form: + # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/`. + # @param [Google::Apis::GameservicesV1beta::GameServerConfig] game_server_config_object + # @param [String] config_id + # Required. The ID of the Game Server Config resource to be created. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_game_server_deployment_config(parent, game_server_config_object = nil, config_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+parent}/configs', options) + command.request_representation = Google::Apis::GameservicesV1beta::GameServerConfig::Representation + command.request_object = game_server_config_object + command.response_representation = Google::Apis::GameservicesV1beta::Operation::Representation + command.response_class = Google::Apis::GameservicesV1beta::Operation + command.params['parent'] = parent unless parent.nil? + command.query['configId'] = config_id unless config_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a single Game Server Config. The deletion will fail if the Game + # Server Config is referenced in a Game Server Deployment Rollout. + # @param [String] name + # Required. The name of the Game Server Config to delete. Uses the form: + # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/ + # configs/`config``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_game_server_deployment_config(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::GameservicesV1beta::Operation::Representation + command.response_class = Google::Apis::GameservicesV1beta::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets details of a single Game Server Config. + # @param [String] name + # Required. The name of the Game Server Config to retrieve. Uses the form: + # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/ + # configs/`config``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::GameServerConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::GameServerConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_game_server_deployment_config(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::GameservicesV1beta::GameServerConfig::Representation + command.response_class = Google::Apis::GameservicesV1beta::GameServerConfig + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists Game Server Configs in a given project, Location, and Game Server + # Deployment. + # @param [String] parent + # Required. The parent resource name. Uses the form: + # `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/ + # configs/*`. + # @param [String] filter + # Optional. The filter to apply to list results. + # @param [String] order_by + # Optional. Specifies the ordering of results following syntax at + # https://cloud.google.com/apis/design/design_patterns#sorting_order. + # @param [Fixnum] page_size + # Optional. The maximum number of items to return. If unspecified, server + # will pick an appropriate default. Server may return fewer items than + # requested. A caller should only rely on response's + # next_page_token to + # determine if there are more GameServerConfigs left to be queried. + # @param [String] page_token + # Optional. The next_page_token value returned from a previous List request, if + # any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::ListGameServerConfigsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::ListGameServerConfigsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_game_server_deployment_configs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+parent}/configs', options) + command.response_representation = Google::Apis::GameservicesV1beta::ListGameServerConfigsResponse::Representation + command.response_class = Google::Apis::GameservicesV1beta::ListGameServerConfigsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Starts asynchronous cancellation on a long-running operation. The server + # makes a best effort to cancel the operation, but success is not + # guaranteed. If the server doesn't support this method, it returns + # `google.rpc.Code.UNIMPLEMENTED`. Clients can use + # Operations.GetOperation or + # other methods to check whether the cancellation succeeded or whether the + # operation completed despite cancellation. On successful cancellation, + # the operation is not deleted; instead, it becomes an operation with + # an Operation.error value with a google.rpc.Status.code of 1, + # corresponding to `Code.CANCELLED`. + # @param [String] name + # The name of the operation resource to be cancelled. + # @param [Google::Apis::GameservicesV1beta::CancelOperationRequest] cancel_operation_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+name}:cancel', options) + command.request_representation = Google::Apis::GameservicesV1beta::CancelOperationRequest::Representation + command.request_object = cancel_operation_request_object + command.response_representation = Google::Apis::GameservicesV1beta::Empty::Representation + command.response_class = Google::Apis::GameservicesV1beta::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a long-running operation. This method indicates that the client is + # no longer interested in the operation result. It does not cancel the + # operation. If the server doesn't support this method, it returns + # `google.rpc.Code.UNIMPLEMENTED`. + # @param [String] name + # The name of the operation resource to be deleted. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::GameservicesV1beta::Empty::Representation + command.response_class = Google::Apis::GameservicesV1beta::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of a long-running operation. Clients can use this + # method to poll the operation result at intervals as recommended by the API + # service. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::GameservicesV1beta::Operation::Representation + command.response_class = Google::Apis::GameservicesV1beta::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists operations that match the specified filter in the request. If the + # server doesn't support this method, it returns `UNIMPLEMENTED`. + # NOTE: the `name` binding allows API services to override the binding + # to use different resource name schemes, such as `users/*/operations`. To + # override the binding, API services can add a binding such as + # `"/v1/`name=users/*`/operations"` to their service configuration. + # For backwards compatibility, the default name includes the operations + # collection id, however overriding users must ensure the name binding + # is the parent resource, without the operations collection id. + # @param [String] name + # The name of the operation's parent resource. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::ListOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::ListOperationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}/operations', options) + command.response_representation = Google::Apis::GameservicesV1beta::ListOperationsResponse::Representation + command.response_class = Google::Apis::GameservicesV1beta::ListOperationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new Realm in a given project and Location. + # @param [String] parent + # Required. The parent resource name. Uses the form: + # `projects/`project`/locations/`location``. + # @param [Google::Apis::GameservicesV1beta::Realm] realm_object + # @param [String] realm_id + # Required. The ID of the Realm resource to be created. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_realm(parent, realm_object = nil, realm_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+parent}/realms', options) + command.request_representation = Google::Apis::GameservicesV1beta::Realm::Representation + command.request_object = realm_object + command.response_representation = Google::Apis::GameservicesV1beta::Operation::Representation + command.response_class = Google::Apis::GameservicesV1beta::Operation + command.params['parent'] = parent unless parent.nil? + command.query['realmId'] = realm_id unless realm_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a single Realm. + # @param [String] name + # Required. The name of the Realm to delete. Uses the form: + # `projects/`project`/locations/`location`/realms/`realm``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_realm(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::GameservicesV1beta::Operation::Representation + command.response_class = Google::Apis::GameservicesV1beta::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets details of a single Realm. + # @param [String] name + # Required. The name of the Realm to retrieve. Uses the form: + # `projects/`project`/locations/`location`/realms/`realm``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Realm] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Realm] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_realm(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::GameservicesV1beta::Realm::Representation + command.response_class = Google::Apis::GameservicesV1beta::Realm + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists Realms in a given project and Location. + # @param [String] parent + # Required. The parent resource name. Uses the form: + # `projects/`project`/locations/`location``. + # @param [String] filter + # Optional. The filter to apply to list results. + # @param [String] order_by + # Optional. Specifies the ordering of results following syntax at + # https://cloud.google.com/apis/design/design_patterns#sorting_order. + # @param [Fixnum] page_size + # Optional. The maximum number of items to return. If unspecified, server + # will pick an appropriate default. Server may return fewer items than + # requested. A caller should only rely on response's + # next_page_token to + # determine if there are more Realms left to be queried. + # @param [String] page_token + # Optional. The next_page_token value returned from a previous List request, + # if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::ListRealmsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::ListRealmsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_realms(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+parent}/realms', options) + command.response_representation = Google::Apis::GameservicesV1beta::ListRealmsResponse::Representation + command.response_class = Google::Apis::GameservicesV1beta::ListRealmsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Patches a single Realm. + # @param [String] name + # The resource name of the Realm. Uses the form: + # `projects/`project`/locations/`location`/realms/`realm``. For + # example, `projects/my-project/locations/`location`/realms/my-realm`. + # @param [Google::Apis::GameservicesV1beta::Realm] realm_object + # @param [String] update_mask + # Required. The update mask applies to the resource. For the `FieldMask` + # definition, see + # https: + # //developers.google.com/protocol-buffers + # // /docs/reference/google.protobuf#fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_realm(name, realm_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta/{+name}', options) + command.request_representation = Google::Apis::GameservicesV1beta::Realm::Representation + command.request_object = realm_object + command.response_representation = Google::Apis::GameservicesV1beta::Operation::Representation + command.response_class = Google::Apis::GameservicesV1beta::Operation + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Previews patches to a single Realm. + # @param [String] name + # The resource name of the Realm. Uses the form: + # `projects/`project`/locations/`location`/realms/`realm``. For + # example, `projects/my-project/locations/`location`/realms/my-realm`. + # @param [Google::Apis::GameservicesV1beta::Realm] realm_object + # @param [String] preview_time + # Optional. The target timestamp to compute the preview. + # @param [String] update_mask + # Required. The update mask applies to the resource. For the `FieldMask` + # definition, see + # https: + # //developers.google.com/protocol-buffers + # // /docs/reference/google.protobuf#fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::PreviewRealmUpdateResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::PreviewRealmUpdateResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def preview_project_location_realm_update(name, realm_object = nil, preview_time: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta/{+name}:previewUpdate', options) + command.request_representation = Google::Apis::GameservicesV1beta::Realm::Representation + command.request_object = realm_object + command.response_representation = Google::Apis::GameservicesV1beta::PreviewRealmUpdateResponse::Representation + command.response_class = Google::Apis::GameservicesV1beta::PreviewRealmUpdateResponse + command.params['name'] = name unless name.nil? + command.query['previewTime'] = preview_time unless preview_time.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new game server cluster in a given project and location. + # @param [String] parent + # Required. The parent resource name. Uses the form: + # `projects/`project`/locations/`location`/realms/`realm-id``. + # @param [Google::Apis::GameservicesV1beta::GameServerCluster] game_server_cluster_object + # @param [String] game_server_cluster_id + # Required. The ID of the Game Server Cluster resource to be created. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_realm_game_server_cluster(parent, game_server_cluster_object = nil, game_server_cluster_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+parent}/gameServerClusters', options) + command.request_representation = Google::Apis::GameservicesV1beta::GameServerCluster::Representation + command.request_object = game_server_cluster_object + command.response_representation = Google::Apis::GameservicesV1beta::Operation::Representation + command.response_class = Google::Apis::GameservicesV1beta::Operation + command.params['parent'] = parent unless parent.nil? + command.query['gameServerClusterId'] = game_server_cluster_id unless game_server_cluster_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a single game server cluster. + # @param [String] name + # Required. The name of the Game Server Cluster to delete. Uses the form: + # `projects/`project`/locations/`location`/gameServerClusters/`cluster``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_realm_game_server_cluster(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::GameservicesV1beta::Operation::Representation + command.response_class = Google::Apis::GameservicesV1beta::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets details of a single game server cluster. + # @param [String] name + # Required. The name of the Game Server Cluster to retrieve. Uses the form: + # `projects/`project`/locations/`location`/realms/`realm-id`/gameServerClusters/` + # cluster``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::GameServerCluster] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::GameServerCluster] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_realm_game_server_cluster(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::GameservicesV1beta::GameServerCluster::Representation + command.response_class = Google::Apis::GameservicesV1beta::GameServerCluster + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists Game Server Clusters in a given project and location. + # @param [String] parent + # Required. The parent resource name. Uses the form: + # "projects/`project`/locations/`location`/realms/`realm`". + # @param [String] filter + # Optional. The filter to apply to list results. + # @param [String] order_by + # Optional. Specifies the ordering of results following syntax at + # https://cloud.google.com/apis/design/design_patterns#sorting_order. + # @param [Fixnum] page_size + # Optional. The maximum number of items to return. If unspecified, server + # will pick an appropriate default. Server may return fewer items than + # requested. A caller should only rely on response's + # next_page_token to + # determine if there are more GameServerClusters left to be queried. + # @param [String] page_token + # Optional. The next_page_token value returned from a previous List request, if + # any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::ListGameServerClustersResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::ListGameServerClustersResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_realm_game_server_clusters(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta/{+parent}/gameServerClusters', options) + command.response_representation = Google::Apis::GameservicesV1beta::ListGameServerClustersResponse::Representation + command.response_class = Google::Apis::GameservicesV1beta::ListGameServerClustersResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Patches a single game server cluster. + # @param [String] name + # Required. The resource name of the Game Server Cluster. Uses the form: + # `projects/`project`/locations/`location`/realms/`realm`/gameServerClusters/` + # cluster``. + # For example, + # `projects/my-project/locations/`location`/realms/zanzibar/gameServerClusters/ + # my-onprem-cluster`. + # @param [Google::Apis::GameservicesV1beta::GameServerCluster] game_server_cluster_object + # @param [String] update_mask + # Required. Mask of fields to update. At least one path must be supplied in + # this field. For the `FieldMask` definition, see + # https: + # //developers.google.com/protocol-buffers + # // /docs/reference/google.protobuf#fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_realm_game_server_cluster(name, game_server_cluster_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta/{+name}', options) + command.request_representation = Google::Apis::GameservicesV1beta::GameServerCluster::Representation + command.request_object = game_server_cluster_object + command.response_representation = Google::Apis::GameservicesV1beta::Operation::Representation + command.response_class = Google::Apis::GameservicesV1beta::Operation + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Previews creation of a new game server cluster in a given project and + # location. + # @param [String] parent + # Required. The parent resource name. Uses the form: + # `projects/`project`/locations/`location`/realms/`realm``. + # @param [Google::Apis::GameservicesV1beta::GameServerCluster] game_server_cluster_object + # @param [String] game_server_cluster_id + # Required. The ID of the Game Server Cluster resource to be created. + # @param [String] preview_time + # Optional. The target timestamp to compute the preview. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::PreviewCreateGameServerClusterResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::PreviewCreateGameServerClusterResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def preview_project_location_realm_game_server_cluster_create(parent, game_server_cluster_object = nil, game_server_cluster_id: nil, preview_time: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta/{+parent}/gameServerClusters:previewCreate', options) + command.request_representation = Google::Apis::GameservicesV1beta::GameServerCluster::Representation + command.request_object = game_server_cluster_object + command.response_representation = Google::Apis::GameservicesV1beta::PreviewCreateGameServerClusterResponse::Representation + command.response_class = Google::Apis::GameservicesV1beta::PreviewCreateGameServerClusterResponse + command.params['parent'] = parent unless parent.nil? + command.query['gameServerClusterId'] = game_server_cluster_id unless game_server_cluster_id.nil? + command.query['previewTime'] = preview_time unless preview_time.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Previews deletion of a single game server cluster. + # @param [String] name + # Required. The name of the Game Server Cluster to delete. Uses the form: + # `projects/`project`/locations/`location`/gameServerClusters/`cluster``. + # @param [String] preview_time + # Optional. The target timestamp to compute the preview. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::PreviewDeleteGameServerClusterResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::PreviewDeleteGameServerClusterResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def preview_project_location_realm_game_server_cluster_delete(name, preview_time: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta/{+name}:previewDelete', options) + command.response_representation = Google::Apis::GameservicesV1beta::PreviewDeleteGameServerClusterResponse::Representation + command.response_class = Google::Apis::GameservicesV1beta::PreviewDeleteGameServerClusterResponse + command.params['name'] = name unless name.nil? + command.query['previewTime'] = preview_time unless preview_time.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Previews updating a GameServerCluster. + # @param [String] name + # Required. The resource name of the Game Server Cluster. Uses the form: + # `projects/`project`/locations/`location`/realms/`realm`/gameServerClusters/` + # cluster``. + # For example, + # `projects/my-project/locations/`location`/realms/zanzibar/gameServerClusters/ + # my-onprem-cluster`. + # @param [Google::Apis::GameservicesV1beta::GameServerCluster] game_server_cluster_object + # @param [String] preview_time + # Optional. The target timestamp to compute the preview. + # @param [String] update_mask + # Required. Mask of fields to update. At least one path must be supplied in + # this field. For the `FieldMask` definition, see + # https: + # //developers.google.com/protocol-buffers + # // /docs/reference/google.protobuf#fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GameservicesV1beta::PreviewUpdateGameServerClusterResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GameservicesV1beta::PreviewUpdateGameServerClusterResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def preview_project_location_realm_game_server_cluster_update(name, game_server_cluster_object = nil, preview_time: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta/{+name}:previewUpdate', options) + command.request_representation = Google::Apis::GameservicesV1beta::GameServerCluster::Representation + command.request_object = game_server_cluster_object + command.response_representation = Google::Apis::GameservicesV1beta::PreviewUpdateGameServerClusterResponse::Representation + command.response_class = Google::Apis::GameservicesV1beta::PreviewUpdateGameServerClusterResponse + command.params['name'] = name unless name.nil? + command.query['previewTime'] = preview_time unless preview_time.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/genomics_v2alpha1.rb b/generated/google/apis/genomics_v2alpha1.rb index bbfa260b5..db10fec98 100644 --- a/generated/google/apis/genomics_v2alpha1.rb +++ b/generated/google/apis/genomics_v2alpha1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/genomics module GenomicsV2alpha1 VERSION = 'V2alpha1' - REVISION = '20200210' + REVISION = '20200330' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/genomics_v2alpha1/service.rb b/generated/google/apis/genomics_v2alpha1/service.rb index a3fe9e2fe..65fbbd8a7 100644 --- a/generated/google/apis/genomics_v2alpha1/service.rb +++ b/generated/google/apis/genomics_v2alpha1/service.rb @@ -234,6 +234,40 @@ module Google execute_or_queue_command(command, &block) end + # The worker uses this method to retrieve the assigned operation and + # provide periodic status updates. + # @param [String] id + # The worker id, assigned when it was created. + # @param [Google::Apis::GenomicsV2alpha1::CheckInRequest] check_in_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::GenomicsV2alpha1::CheckInResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::GenomicsV2alpha1::CheckInResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def check_project_worker_in(id, check_in_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2alpha1/{+id}:checkIn', options) + command.request_representation = Google::Apis::GenomicsV2alpha1::CheckInRequest::Representation + command.request_object = check_in_request_object + command.response_representation = Google::Apis::GenomicsV2alpha1::CheckInResponse::Representation + command.response_class = Google::Apis::GenomicsV2alpha1::CheckInResponse + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # The worker uses this method to retrieve the assigned operation and # provide periodic status updates. # @param [String] id diff --git a/generated/google/apis/gmail_v1.rb b/generated/google/apis/gmail_v1.rb index 69d598098..b2b4ae30d 100644 --- a/generated/google/apis/gmail_v1.rb +++ b/generated/google/apis/gmail_v1.rb @@ -20,12 +20,13 @@ module Google module Apis # Gmail API # - # Access Gmail mailboxes including sending user email. + # The Gmail API lets you view and manage Gmail mailbox data like + # threads, messages, and labels. # # @see https://developers.google.com/gmail/api/ module GmailV1 VERSION = 'V1' - REVISION = '20200203' + REVISION = '20200406' # Read, compose, send, and permanently delete all your email from Gmail AUTH_SCOPE = 'https://mail.google.com/' diff --git a/generated/google/apis/gmail_v1/classes.rb b/generated/google/apis/gmail_v1/classes.rb index 82fbda4ae..dae18fa09 100644 --- a/generated/google/apis/gmail_v1/classes.rb +++ b/generated/google/apis/gmail_v1/classes.rb @@ -31,8 +31,8 @@ module Google # @return [String] attr_accessor :disposition - # Email address to which all incoming messages are forwarded. This email address - # must be a verified member of the forwarding addresses. + # Email address to which all incoming messages are forwarded. This email + # address must be a verified member of the forwarding addresses. # Corresponds to the JSON property `emailAddress` # @return [String] attr_accessor :email_address @@ -83,7 +83,8 @@ module Google # @return [Array] attr_accessor :add_label_ids - # The IDs of the messages to modify. There is a limit of 1000 ids per request. + # The IDs of the messages to modify. There is a limit of 1000 ids per + # request. # Corresponds to the JSON property `ids` # @return [Array] attr_accessor :ids @@ -106,8 +107,9 @@ module Google end # Settings for a delegate. Delegates can read, send, and delete messages, as - # well as view and add contacts, for the delegator's account. See "Set up mail - # delegation" for more information about delegates. + # well as view and add contacts, for the delegator's account. See + # "Set up + # mail delegation" for more information about delegates. class Delegate include Google::Apis::Core::Hashable @@ -116,8 +118,8 @@ module Google # @return [String] attr_accessor :delegate_email - # Indicates whether this address has been verified and can act as a delegate for - # the account. Read-only. + # Indicates whether this address has been verified and can act as a delegate + # for the account. Read-only. # Corresponds to the JSON property `verificationStatus` # @return [String] attr_accessor :verification_status @@ -242,16 +244,18 @@ module Google attr_accessor :has_attachment alias_method :has_attachment?, :has_attachment - # Only return messages not matching the specified query. Supports the same query - # format as the Gmail search box. For example, "from:someuser@example.com - # rfc822msgid: is:unread". + # Only return messages not matching the specified query. Supports the same + # query format as the Gmail search box. For example, + # "from:someuser@example.com rfc822msgid: + # is:unread". # Corresponds to the JSON property `negatedQuery` # @return [String] attr_accessor :negated_query - # Only return messages matching the specified query. Supports the same query - # format as the Gmail search box. For example, "from:someuser@example.com - # rfc822msgid: is:unread". + # Only return messages matching the specified query. Supports the same + # query format as the Gmail search box. For example, + # "from:someuser@example.com rfc822msgid: + # is:unread". # Corresponds to the JSON property `query` # @return [String] attr_accessor :query @@ -267,16 +271,16 @@ module Google # @return [String] attr_accessor :size_comparison - # Case-insensitive phrase found in the message's subject. Trailing and leading - # whitespace are be trimmed and adjacent spaces are collapsed. + # Case-insensitive phrase found in the message's subject. Trailing and + # leading whitespace are be trimmed and adjacent spaces are collapsed. # Corresponds to the JSON property `subject` # @return [String] attr_accessor :subject - # The recipient's display name or email address. Includes recipients in the "to", - # "cc", and "bcc" header fields. You can use simply the local part of the email - # address. For example, "example" and "example@" both match "example@gmail.com". - # This field is case-insensitive. + # The recipient's display name or email address. Includes recipients in the + # "to", "cc", and "bcc" header fields. You can use simply the local part of + # the email address. For example, "example" and "example@" both match + # "example@gmail.com". This field is case-insensitive. # Corresponds to the JSON property `to` # @return [String] attr_accessor :to @@ -308,8 +312,8 @@ module Google # @return [String] attr_accessor :forwarding_email - # Indicates whether this address has been verified and is usable for forwarding. - # Read-only. + # Indicates whether this address has been verified and is usable for + # forwarding. Read-only. # Corresponds to the JSON property `verificationStatus` # @return [String] attr_accessor :verification_status @@ -345,9 +349,10 @@ module Google # @return [Array] attr_accessor :labels_removed - # List of messages changed in this history record. The fields for specific - # change types, such as messagesAdded may duplicate messages in this field. We - # recommend using the specific change-type fields instead of this. + # List of messages changed in this history record. The fields for specific + # change types, such as messagesAdded may duplicate messages in + # this field. We recommend using the specific change-type fields instead + # of this. # Corresponds to the JSON property `messages` # @return [Array] attr_accessor :messages @@ -470,8 +475,8 @@ module Google include Google::Apis::Core::Hashable # If this value is true, Gmail will immediately expunge a message when it is - # marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the - # client before expunging messages marked as deleted. + # marked as deleted in IMAP. Otherwise, Gmail will wait for an update from + # the client before expunging messages marked as deleted. # Corresponds to the JSON property `autoExpunge` # @return [Boolean] attr_accessor :auto_expunge @@ -483,15 +488,15 @@ module Google attr_accessor :enabled alias_method :enabled?, :enabled - # The action that will be executed on a message when it is marked as deleted and - # expunged from the last visible IMAP folder. + # The action that will be executed on a message when it is marked as deleted + # and expunged from the last visible IMAP folder. # Corresponds to the JSON property `expungeBehavior` # @return [String] attr_accessor :expunge_behavior - # An optional limit on the number of messages that an IMAP folder may contain. - # Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted - # to mean that there is no limit. + # An optional limit on the number of messages that an IMAP folder may + # contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero + # is interpreted to mean that there is no limit. # Corresponds to the JSON property `maxFolderSize` # @return [Fixnum] attr_accessor :max_folder_size @@ -509,12 +514,14 @@ module Google end end - # Labels are used to categorize messages and threads within the user's mailbox. + # Labels are used to categorize messages and threads within the + # user's mailbox. class Label include Google::Apis::Core::Hashable - # The color to assign to the label. Color is only available for labels that have - # their type set to user. + # The color to assign to the label. Color is only available for labels that + # have their type set to user. + # @mutable gmail.users.labels.create gmail.users.labels.update # Corresponds to the JSON property `color` # @return [Google::Apis::GmailV1::LabelColor] attr_accessor :color @@ -525,11 +532,14 @@ module Google attr_accessor :id # The visibility of the label in the label list in the Gmail web interface. + # @mutable gmail.users.labels.create gmail.users.labels.update # Corresponds to the JSON property `labelListVisibility` # @return [String] attr_accessor :label_list_visibility - # The visibility of the label in the message list in the Gmail web interface. + # The visibility of the label in the message list in the + # Gmail web interface. + # @mutable gmail.users.labels.create gmail.users.labels.update # Corresponds to the JSON property `messageListVisibility` # @return [String] attr_accessor :message_list_visibility @@ -545,6 +555,7 @@ module Google attr_accessor :messages_unread # The display name of the label. + # @mutable gmail.users.labels.create gmail.users.labels.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -559,14 +570,15 @@ module Google # @return [Fixnum] attr_accessor :threads_unread - # The owner type for the label. User labels are created by the user and can be - # modified and deleted by the user and can be applied to any message or thread. - # System labels are internally created and cannot be added, modified, or deleted. - # System labels may be able to be applied to or removed from messages and - # threads under some circumstances but this is not guaranteed. For example, - # users can apply and remove the INBOX and UNREAD labels from messages and - # threads, but cannot apply or remove the DRAFTS or SENT labels from messages or - # threads. + # The owner type for the label. User labels are created by the user and + # can be modified and deleted by the user and can be applied to any + # message or thread. System labels are internally created and cannot be + # added, modified, or deleted. System labels may be able to be applied to or + # removed from messages and threads under some circumstances but this is + # not guaranteed. For example, users can apply and remove the + # INBOX and UNREAD labels from messages and + # threads, but cannot apply or remove the DRAFTS or + # SENT labels from messages or threads. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -594,40 +606,46 @@ module Google class LabelColor include Google::Apis::Core::Hashable - # The background color represented as hex string #RRGGBB (ex #000000). This - # field is required in order to set the color of a label. Only the following - # predefined set of color values are allowed: - # #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, # - # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, - # #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, # - # ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, - # #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, # - # f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, - # #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, # - # 076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, - # #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, # - # 7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, - # #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, # - # f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + # The background color represented as hex string #RRGGBB (ex #000000). + # This field is required in order to set the color of a label. + # Only the following predefined set of color values are allowed: + #
+ # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, + # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, + # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, + # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, + # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, + # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, + # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, + # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c + # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, + # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, + # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, + # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, + # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + # @mutable gmail.users.labels.create gmail.users.labels.update # Corresponds to the JSON property `backgroundColor` # @return [String] attr_accessor :background_color - # The text color of the label, represented as hex string. This field is required - # in order to set the color of a label. Only the following predefined set of - # color values are allowed: - # #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, # - # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, - # #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, # - # ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, - # #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, # - # f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, - # #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, # - # 076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, - # #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, # - # 7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, - # #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, # - # f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + # The text color of the label, represented as hex string. + # This field is required in order to set the color of a label. + # Only the following predefined set of color values are allowed: + #
+ # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, + # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, + # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, + # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, + # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, + # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, + # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, + # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c + # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, + # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, + # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, + # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, + # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + # @mutable gmail.users.labels.create gmail.users.labels.update # Corresponds to the JSON property `textColor` # @return [String] attr_accessor :text_color @@ -643,21 +661,28 @@ module Google end end - # Language settings for an account. These settings correspond to the "Language - # settings" feature in the web interface. + # Language settings for an account. These settings correspond to + # the "Language + # settings" feature in the web interface. class LanguageSettings include Google::Apis::Core::Hashable - # The language to display Gmail in, formatted as an RFC 3066 Language Tag (for - # example en-GB, fr or ja for British English, French, or Japanese respectively). - # The set of languages supported by Gmail evolves over time, so please refer to - # the "Language" dropdown in the Gmail settings for all available options, as - # described in the language settings help article. A table of sample values is - # also provided in the Managing Language Settings guide - # Not all Gmail clients can display the same set of languages. In the case that - # a user's display language is not available for use on a particular client, - # said client automatically chooses to display in the closest supported variant ( - # or a reasonable default). + # The language to display Gmail in, formatted as an + # RFC 3066 + # Language Tag (for example en-GB, fr or + # ja for British English, French, or Japanese respectively). + # The set of languages supported by Gmail evolves over time, so please refer + # to the "Language" dropdown in the + # Gmail settings + # for all available options, as described in the + # language settings + # help article. A table of sample values is also provided in the + # Managing + # Language Settings guide + # Not all Gmail clients can display the same set of languages. In the case + # that a user's display language is not available for use on a particular + # client, said client automatically chooses to display in the closest + # supported variant (or a reasonable default). # Corresponds to the JSON property `displayLanguage` # @return [String] attr_accessor :display_language @@ -695,9 +720,11 @@ module Google class ListDraftsResponse include Google::Apis::Core::Hashable - # List of drafts. Note that the Message property in each Draft resource only - # contains an id and a threadId. The messages.get method can fetch additional - # message details. + # List of drafts. Note that the Message property in each + # Draft resource only contains an id and a + # threadId. The + # messages.get + # method can fetch additional message details. # Corresponds to the JSON property `drafts` # @return [Array] attr_accessor :drafts @@ -766,8 +793,9 @@ module Google class ListHistoryResponse include Google::Apis::Core::Hashable - # List of history records. Any messages contained in the response will typically - # only have id and threadId fields populated. + # List of history records. Any messages contained in the + # response will typically only have id and + # threadId fields populated. # Corresponds to the JSON property `history` # @return [Array] attr_accessor :history @@ -798,8 +826,10 @@ module Google class ListLabelsResponse include Google::Apis::Core::Hashable - # List of labels. Note that each label resource only contains an id, name, - # messageListVisibility, labelListVisibility, and type. The labels.get method + # List of labels. Note that each label resource only contains an + # id, name, messageListVisibility, + # labelListVisibility, and type. The + # labels.get method # can fetch additional label details. # Corresponds to the JSON property `labels` # @return [Array] @@ -819,8 +849,10 @@ module Google class ListMessagesResponse include Google::Apis::Core::Hashable - # List of messages. Note that each message resource contains only an id and a - # threadId. Additional message details can be fetched using the messages.get + # List of messages. Note that each message resource contains only an + # id and a threadId. Additional message details can + # be fetched using the + # messages.get # method. # Corresponds to the JSON property `messages` # @return [Array] @@ -901,8 +933,9 @@ module Google attr_accessor :result_size_estimate # List of threads. Note that each thread resource does not contain a list of - # messages. The list of messages for a given thread can be fetched using the - # threads.get method. + # messages. The list of messages for a given thread + # can be fetched using the + # threads.get method. # Corresponds to the JSON property `threads` # @return [Array] attr_accessor :threads @@ -933,16 +966,17 @@ module Google # @return [String] attr_accessor :id - # The internal message creation timestamp (epoch ms), which determines ordering - # in the inbox. For normal SMTP-received email, this represents the time the - # message was originally accepted by Google, which is more reliable than the - # Date header. However, for API-migrated mail, it can be configured by client to - # be based on the Date header. + # The internal message creation timestamp (epoch ms), which determines + # ordering in the inbox. For normal SMTP-received email, this represents the + # time the message was originally accepted by Google, which is more reliable + # than the Date header. However, for API-migrated mail, it can + # be configured by client to be based on the Date header. # Corresponds to the JSON property `internalDate` # @return [Fixnum] attr_accessor :internal_date # List of IDs of labels applied to this message. + # @mutable gmail.users.messages.insert gmail.users.messages.modify # Corresponds to the JSON property `labelIds` # @return [Array] attr_accessor :label_ids @@ -952,9 +986,12 @@ module Google # @return [Google::Apis::GmailV1::MessagePart] attr_accessor :payload - # The entire email message in an RFC 2822 formatted and base64url encoded string. - # Returned in messages.get and drafts.get responses when the format=RAW + # The entire email message in an RFC 2822 formatted and base64url + # encoded string. Returned in messages.get and + # drafts.get responses when the format=RAW # parameter is supplied. + # @mutable gmail.users.messages.insert gmail.users.messages.send + # @mutable gmail.users.drafts.create gmail.users.drafts.update # Corresponds to the JSON property `raw` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -970,13 +1007,17 @@ module Google # @return [String] attr_accessor :snippet - # The ID of the thread the message belongs to. To add a message or draft to a - # thread, the following criteria must be met: - # - The requested threadId must be specified on the Message or Draft.Message you - # supply with your request. - # - The References and In-Reply-To headers must be set in compliance with the - # RFC 2822 standard. - # - The Subject headers must match. + # The ID of the thread the message belongs to. To add a message or draft to + # a thread, the following criteria must be met: + #
  1. The requested threadId must be specified on the + # Message or Draft.Message you supply with your + # request.
  2. + #
  3. The References and In-Reply-To headers must + # be set in compliance with the + # RFC 2822 standard.
  4. + #
  5. The Subject headers must match. + # @mutable gmail.users.messages.insert gmail.users.messages.send + # @mutable gmail.users.drafts.create gmail.users.drafts.update # Corresponds to the JSON property `threadId` # @return [String] attr_accessor :thread_id @@ -1008,15 +1049,16 @@ module Google # @return [Google::Apis::GmailV1::MessagePartBody] attr_accessor :body - # The filename of the attachment. Only present if this message part represents - # an attachment. + # The filename of the attachment. Only present if this message part + # represents an attachment. # Corresponds to the JSON property `filename` # @return [String] attr_accessor :filename # List of headers on this message part. For the top-level message part, - # representing the entire message payload, it will contain the standard RFC 2822 - # email headers such as To, From, and Subject. + # representing the entire message payload, it will contain the standard + # RFC 2822 email headers such as To, From, and + # Subject. # Corresponds to the JSON property `headers` # @return [Array] attr_accessor :headers @@ -1031,10 +1073,11 @@ module Google # @return [String] attr_accessor :part_id - # The child MIME message parts of this part. This only applies to container MIME - # message parts, for example multipart/*. For non- container MIME message part - # types, such as text/plain, this field is empty. For more information, see RFC - # 1521. + # The child MIME message parts of this part. This only applies to container + # MIME message parts, for example multipart/*. For non- + # container MIME message part types, such as text/plain, this + # field is empty. For more information, see + # RFC 1521. # Corresponds to the JSON property `parts` # @return [Array] attr_accessor :parts @@ -1058,17 +1101,19 @@ module Google class MessagePartBody include Google::Apis::Core::Hashable - # When present, contains the ID of an external attachment that can be retrieved - # in a separate messages.attachments.get request. When not present, the entire - # content of the message part body is contained in the data field. + # When present, contains the ID of an external attachment that can be + # retrieved in a separate messages.attachments.get request. + # When not present, the entire content of the message part body is + # contained in the data field. # Corresponds to the JSON property `attachmentId` # @return [String] attr_accessor :attachment_id - # The body data of a MIME message part as a base64url encoded string. May be - # empty for MIME container types that have no message body or when the body data - # is sent as a separate attachment. An attachment ID is present if the body data - # is contained in a separate attachment. + # The body data of a MIME message part as a base64url encoded string. + # May be empty for MIME container + # types that have no message body or when the body data is sent as a + # separate attachment. An attachment ID is present if the body data is + # contained in a separate attachment. # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1095,13 +1140,14 @@ module Google class MessagePartHeader include Google::Apis::Core::Hashable - # The name of the header before the : separator. For example, To. + # The name of the header before the : separator. For + # example, To. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The value of the header after the : separator. For example, someuser@example. - # com. + # The value of the header after the : separator. For example, + # someuser@example.com. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -1231,48 +1277,53 @@ module Google end # Settings associated with a send-as alias, which can be either the primary - # login address associated with the account or a custom "from" address. Send-as - # aliases correspond to the "Send Mail As" feature in the web interface. + # login address associated with the account or a custom "from" address. + # Send-as aliases correspond to the + # "Send Mail As" + # feature in the web interface. class SendAs include Google::Apis::Core::Hashable - # A name that appears in the "From:" header for mail sent using this alias. For - # custom "from" addresses, when this is empty, Gmail will populate the "From:" - # header with the name that is used for the primary address associated with the - # account. If the admin has disabled the ability for users to update their name - # format, requests to update this field for the primary login will silently fail. + # A name that appears in the "From:" header for mail sent using this alias. + # For custom "from" addresses, when this is empty, Gmail will populate the + # "From:" header with the name that is used for the primary address + # associated with the account. + # If the admin has disabled the ability for users to update their name + # format, requests to update this field for the primary login will silently + # fail. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Whether this address is selected as the default "From:" address in situations - # such as composing a new message or sending a vacation auto-reply. Every Gmail - # account has exactly one default send-as address, so the only legal value that - # clients may write to this field is true. Changing this from false to true for - # an address will result in this field becoming false for the other previous - # default address. + # Whether this address is selected as the default "From:" address in + # situations such as composing a new message or sending a vacation + # auto-reply. Every Gmail account has exactly one default send-as address, + # so the only legal value that clients may write to this field is + # true. Changing this from false to + # true for an address will result in this field becoming + # false for the other previous default address. # Corresponds to the JSON property `isDefault` # @return [Boolean] attr_accessor :is_default alias_method :is_default?, :is_default # Whether this address is the primary address used to login to the account. - # Every Gmail account has exactly one primary address, and it cannot be deleted - # from the collection of send-as aliases. This field is read-only. + # Every Gmail account has exactly one primary address, and it cannot be + # deleted from the collection of send-as aliases. This field is read-only. # Corresponds to the JSON property `isPrimary` # @return [Boolean] attr_accessor :is_primary alias_method :is_primary?, :is_primary # An optional email address that is included in a "Reply-To:" header for mail - # sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" - # header. + # sent using this alias. If this is empty, Gmail will not generate a + # "Reply-To:" header. # Corresponds to the JSON property `replyToAddress` # @return [String] attr_accessor :reply_to_address - # The email address that appears in the "From:" header for mail sent using this - # alias. This is read-only for all operations except create. + # The email address that appears in the "From:" header for mail sent using + # this alias. This is read-only for all operations except create. # Corresponds to the JSON property `sendAsEmail` # @return [String] attr_accessor :send_as_email @@ -1288,15 +1339,16 @@ module Google # @return [Google::Apis::GmailV1::SmtpMsa] attr_accessor :smtp_msa - # Whether Gmail should treat this address as an alias for the user's primary - # email address. This setting only applies to custom "from" aliases. + # Whether Gmail should + # treat this address as an alias for the user's primary email address. + # This setting only applies to custom "from" aliases. # Corresponds to the JSON property `treatAsAlias` # @return [Boolean] attr_accessor :treat_as_alias alias_method :treat_as_alias?, :treat_as_alias - # Indicates whether this address has been verified for use as a send-as alias. - # Read-only. This setting only applies to custom "from" aliases. + # Indicates whether this address has been verified for use as a send-as + # alias. Read-only. This setting only applies to custom "from" aliases. # Corresponds to the JSON property `verificationStatus` # @return [String] attr_accessor :verification_status @@ -1349,18 +1401,18 @@ module Google # @return [String] attr_accessor :issuer_cn - # PEM formatted X509 concatenated certificate string (standard base64 encoding). - # Format used for returning key, which includes public key as well as - # certificate chain (not private key). + # PEM formatted X509 concatenated certificate string (standard base64 + # encoding). Format used for returning key, which includes public key + # as well as certificate chain (not private key). # Corresponds to the JSON property `pem` # @return [String] attr_accessor :pem - # PKCS#12 format containing a single private/public key pair and certificate - # chain. This format is only accepted from client for creating a new SmimeInfo - # and is never returned, because the private key is not intended to be exported. - # PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set - # appropriately. + # PKCS#12 format containing a single private/public key pair and + # certificate chain. This format is only accepted from client + # for creating a new SmimeInfo and is never returned, because the + # private key is not intended to be exported. PKCS#12 may be encrypted, + # in which case encryptedKeyPassword should be set appropriately. # Corresponds to the JSON property `pkcs12` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1386,32 +1438,32 @@ module Google class SmtpMsa include Google::Apis::Core::Hashable - # The hostname of the SMTP service. Required. + # The hostname of the SMTP service. Required. # Corresponds to the JSON property `host` # @return [String] attr_accessor :host - # The password that will be used for authentication with the SMTP service. This - # is a write-only field that can be specified in requests to create or update - # SendAs settings; it is never populated in responses. + # The password that will be used for authentication with the SMTP service. + # This is a write-only field that can be specified in requests to create or + # update SendAs settings; it is never populated in responses. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password - # The port of the SMTP service. Required. + # The port of the SMTP service. Required. # Corresponds to the JSON property `port` # @return [Fixnum] attr_accessor :port - # The protocol that will be used to secure communication with the SMTP service. - # Required. + # The protocol that will be used to secure communication with the SMTP + # service. Required. # Corresponds to the JSON property `securityMode` # @return [String] attr_accessor :security_mode - # The username that will be used for authentication with the SMTP service. This - # is a write-only field that can be specified in requests to create or update - # SendAs settings; it is never populated in responses. + # The username that will be used for authentication with the SMTP service. + # This is a write-only field that can be specified in requests to create or + # update SendAs settings; it is never populated in responses. # Corresponds to the JSON property `username` # @return [String] attr_accessor :username @@ -1467,8 +1519,9 @@ module Google end end - # Vacation auto-reply settings for an account. These settings correspond to the " - # Vacation responder" feature in the web interface. + # Vacation auto-reply settings for an account. These settings correspond to + # the "Vacation + # responder" feature in the web interface. class VacationSettings include Google::Apis::Core::Hashable @@ -1478,15 +1531,17 @@ module Google attr_accessor :enable_auto_reply alias_method :enable_auto_reply?, :enable_auto_reply - # An optional end time for sending auto-replies (epoch ms). When this is - # specified, Gmail will automatically reply only to messages that it receives - # before the end time. If both startTime and endTime are specified, startTime - # must precede endTime. + # An optional end time for sending auto-replies (epoch ms). + # When this is specified, Gmail will automatically reply only to messages + # that it receives before the end time. If both startTime and + # endTime are specified, startTime must precede + # endTime. # Corresponds to the JSON property `endTime` # @return [Fixnum] attr_accessor :end_time - # Response body in HTML format. Gmail will sanitize the HTML before storing it. + # Response body in HTML format. Gmail will sanitize the HTML before + # storing it. # Corresponds to the JSON property `responseBodyHtml` # @return [String] attr_accessor :response_body_html @@ -1496,31 +1551,33 @@ module Google # @return [String] attr_accessor :response_body_plain_text - # Optional text to prepend to the subject line in vacation responses. In order - # to enable auto-replies, either the response subject or the response body must - # be nonempty. + # Optional text to prepend to the subject line in vacation responses. In + # order to enable auto-replies, either the response subject or the response + # body must be nonempty. # Corresponds to the JSON property `responseSubject` # @return [String] attr_accessor :response_subject - # Flag that determines whether responses are sent to recipients who are not in - # the user's list of contacts. + # Flag that determines whether responses are sent to recipients who are not + # in the user's list of contacts. # Corresponds to the JSON property `restrictToContacts` # @return [Boolean] attr_accessor :restrict_to_contacts alias_method :restrict_to_contacts?, :restrict_to_contacts - # Flag that determines whether responses are sent to recipients who are outside - # of the user's domain. This feature is only available for G Suite users. + # Flag that determines whether responses are sent to recipients who are + # outside of the user's domain. This feature is only available for G Suite + # users. # Corresponds to the JSON property `restrictToDomain` # @return [Boolean] attr_accessor :restrict_to_domain alias_method :restrict_to_domain?, :restrict_to_domain - # An optional start time for sending auto-replies (epoch ms). When this is - # specified, Gmail will automatically reply only to messages that it receives - # after the start time. If both startTime and endTime are specified, startTime - # must precede endTime. + # An optional start time for sending auto-replies (epoch ms). + # When this is specified, Gmail will automatically reply only to messages + # that it receives after the start time. If both startTime and + # endTime are specified, startTime must precede + # endTime. # Corresponds to the JSON property `startTime` # @return [Fixnum] attr_accessor :start_time @@ -1551,20 +1608,21 @@ module Google # @return [String] attr_accessor :label_filter_action - # List of label_ids to restrict notifications about. By default, if unspecified, - # all changes are pushed out. If specified then dictates which labels are - # required for a push notification to be generated. + # List of label_ids to restrict notifications about. By default, + # if unspecified, all changes are pushed out. If specified then + # dictates which labels are required for a push notification to + # be generated. # Corresponds to the JSON property `labelIds` # @return [Array] attr_accessor :label_ids - # A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. - # This topic name **must** already exist in Cloud Pub/Sub and you **must** have - # already granted gmail "publish" permission on it. For example, "projects/my- - # project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic - # naming format). - # Note that the "my-project-identifier" portion must exactly match your Google - # developer project id (the one executing this watch request). + # A fully qualified Google Cloud Pub/Sub API topic name to publish the + # events to. This topic name **must** already exist in Cloud Pub/Sub and + # you **must** have already granted gmail "publish" permission on it. + # For example, "projects/my-project-identifier/topics/my-topic-name" + # (using the Cloud Pub/Sub "v1" topic naming format). + # Note that the "my-project-identifier" portion must exactly match your + # Google developer project id (the one executing this watch request). # Corresponds to the JSON property `topicName` # @return [String] attr_accessor :topic_name @@ -1585,8 +1643,9 @@ module Google class WatchResponse include Google::Apis::Core::Hashable - # When Gmail will stop sending notifications for mailbox updates (epoch millis). - # Call watch again before this time to renew the watch. + # When Gmail will stop sending notifications for mailbox updates + # (epoch millis). Call watch again before this time to renew + # the watch. # Corresponds to the JSON property `expiration` # @return [Fixnum] attr_accessor :expiration diff --git a/generated/google/apis/gmail_v1/service.rb b/generated/google/apis/gmail_v1/service.rb index 980b56899..59625b461 100644 --- a/generated/google/apis/gmail_v1/service.rb +++ b/generated/google/apis/gmail_v1/service.rb @@ -22,7 +22,8 @@ module Google module GmailV1 # Gmail API # - # Access Gmail mailboxes including sending user email. + # The Gmail API lets you view and manage Gmail mailbox data like + # threads, messages, and labels. # # @example # require 'google/apis/gmail_v1' @@ -38,30 +39,24 @@ module Google attr_accessor :key # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. attr_accessor :quota_user - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - def initialize - super('https://www.googleapis.com/', 'gmail/v1/users/') - @batch_path = 'batch/gmail/v1' + super('https://www.googleapis.com/', '') + @batch_path = 'batch' end # Gets the current user's Gmail profile. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -74,28 +69,25 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_profile(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/profile', options) + def get_user_profile(user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/profile', options) command.response_representation = Google::Apis::GmailV1::Profile::Representation command.response_class = Google::Apis::GmailV1::Profile command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Stop receiving push notifications for the given user mailbox. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -108,27 +100,24 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def stop_user(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/stop', options) + def stop_user(user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/stop', options) command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Set up or update a push notification watch on the given user mailbox. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::WatchRequest] watch_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -141,8 +130,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def watch_user(user_id, watch_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/watch', options) + def watch_user(user_id, watch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/watch', options) command.request_representation = Google::Apis::GmailV1::WatchRequest::Representation command.request_object = watch_request_object command.response_representation = Google::Apis::GmailV1::WatchResponse::Representation @@ -150,22 +139,19 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Creates a new draft with the DRAFT label. + # Creates a new draft with the DRAFT label. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::Draft] draft_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [IO, String] upload_source # IO stream or filename containing content to upload # @param [String] content_type @@ -182,11 +168,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) + def create_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? - command = make_simple_command(:post, '{userId}/drafts', options) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/drafts', options) else - command = make_upload_command(:post, '{userId}/drafts', options) + command = make_upload_command(:post, 'gmail/v1/users/{userId}/drafts', options) command.upload_source = upload_source command.upload_content_type = content_type end @@ -197,24 +183,21 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Immediately and permanently deletes the specified draft. Does not simply trash - # it. + # Immediately and permanently deletes the specified draft. + # Does not simply trash it. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] id # The ID of the draft to delete. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -227,20 +210,19 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_user_draft(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{userId}/drafts/{id}', options) + def delete_user_draft(user_id, id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'gmail/v1/users/{userId}/drafts/{id}', options) command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the specified draft. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] id # The ID of the draft to retrieve. # @param [String] format @@ -248,10 +230,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -264,8 +244,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_draft(user_id, id, format: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/drafts/{id}', options) + def get_user_draft(user_id, id, format: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/drafts/{id}', options) command.response_representation = Google::Apis::GmailV1::Draft::Representation command.response_class = Google::Apis::GmailV1::Draft command.params['userId'] = user_id unless user_id.nil? @@ -273,31 +253,30 @@ module Google command.query['format'] = format unless format.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists the drafts in the user's mailbox. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [Boolean] include_spam_trash - # Include drafts from SPAM and TRASH in the results. + # Include drafts from SPAM and TRASH + # in the results. # @param [Fixnum] max_results # Maximum number of drafts to return. # @param [String] page_token # Page token to retrieve a specific page of results in the list. # @param [String] q # Only return draft messages matching the specified query. Supports the same - # query format as the Gmail search box. For example, "from:someuser@example.com - # rfc822msgid: is:unread". + # query format as the Gmail search box. For example, + # "from:someuser@example.com rfc822msgid: + # is:unread". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -310,8 +289,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_user_drafts(user_id, include_spam_trash: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/drafts', options) + def list_user_drafts(user_id, include_spam_trash: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/drafts', options) command.response_representation = Google::Apis::GmailV1::ListDraftsResponse::Representation command.response_class = Google::Apis::GmailV1::ListDraftsResponse command.params['userId'] = user_id unless user_id.nil? @@ -321,23 +300,20 @@ module Google command.query['q'] = q unless q.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Sends the specified, existing draft to the recipients in the To, Cc, and Bcc - # headers. + # Sends the specified, existing draft to the recipients in the + # To, Cc, and Bcc headers. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::Draft] draft_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [IO, String] upload_source # IO stream or filename containing content to upload # @param [String] content_type @@ -354,11 +330,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def send_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) + def send_user_draft(user_id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? - command = make_simple_command(:post, '{userId}/drafts/send', options) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/drafts/send', options) else - command = make_upload_command(:post, '{userId}/drafts/send', options) + command = make_upload_command(:post, 'gmail/v1/users/{userId}/drafts/send', options) command.upload_source = upload_source command.upload_content_type = content_type end @@ -369,24 +345,21 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Replaces a draft's content. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] id # The ID of the draft to update. # @param [Google::Apis::GmailV1::Draft] draft_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [IO, String] upload_source # IO stream or filename containing content to upload # @param [String] content_type @@ -403,11 +376,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_user_draft(user_id, id, draft_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) + def update_user_draft(user_id, id, draft_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? - command = make_simple_command(:put, '{userId}/drafts/{id}', options) + command = make_simple_command(:put, 'gmail/v1/users/{userId}/drafts/{id}', options) else - command = make_upload_command(:put, '{userId}/drafts/{id}', options) + command = make_upload_command(:put, 'gmail/v1/users/{userId}/drafts/{id}', options) command.upload_source = upload_source command.upload_content_type = content_type end @@ -419,15 +392,14 @@ module Google command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists the history of all changes to the given mailbox. History results are - # returned in chronological order (increasing historyId). + # returned in chronological order (increasing historyId). # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [Array, String] history_types # History types to be returned by the function # @param [String] label_id @@ -437,23 +409,24 @@ module Google # @param [String] page_token # Page token to retrieve a specific page of results in the list. # @param [Fixnum] start_history_id - # Required. Returns history records after the specified startHistoryId. The - # supplied startHistoryId should be obtained from the historyId of a message, - # thread, or previous list response. History IDs increase chronologically but - # are not contiguous with random gaps in between valid IDs. Supplying an invalid - # or out of date startHistoryId typically returns an HTTP 404 error code. A - # historyId is typically valid for at least a week, but in some rare - # circumstances may be valid for only a few hours. If you receive an HTTP 404 - # error response, your application should perform a full sync. If you receive no - # nextPageToken in the response, there are no updates to retrieve and you can - # store the returned historyId for a future request. + # Required. Returns history records after the specified + # startHistoryId. The supplied startHistoryId + # should be obtained from the historyId of a message, thread, or + # previous list response. History IDs increase + # chronologically but are not contiguous with random gaps in between valid + # IDs. Supplying an invalid or out of date startHistoryId + # typically returns an HTTP 404 error code. A + # historyId is typically valid for at least a week, but in some + # rare circumstances may be valid for only a few hours. If you receive an + # HTTP 404 error response, your application should perform a + # full sync. If you receive no nextPageToken in the response, + # there are no updates to retrieve and you can store the returned + # historyId for a future request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -466,8 +439,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_user_histories(user_id, history_types: nil, label_id: nil, max_results: nil, page_token: nil, start_history_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/history', options) + def list_user_histories(user_id, history_types: nil, label_id: nil, max_results: nil, page_token: nil, start_history_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/history', options) command.response_representation = Google::Apis::GmailV1::ListHistoryResponse::Representation command.response_class = Google::Apis::GmailV1::ListHistoryResponse command.params['userId'] = user_id unless user_id.nil? @@ -478,22 +451,19 @@ module Google command.query['startHistoryId'] = start_history_id unless start_history_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Creates a new label. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::Label] label_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -506,8 +476,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_user_label(user_id, label_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/labels', options) + def create_user_label(user_id, label_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/labels', options) command.request_representation = Google::Apis::GmailV1::Label::Representation command.request_object = label_object command.response_representation = Google::Apis::GmailV1::Label::Representation @@ -515,24 +485,21 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Immediately and permanently deletes the specified label and removes it from # any messages and threads that it is applied to. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] id # The ID of the label to delete. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -545,29 +512,26 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_user_label(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{userId}/labels/{id}', options) + def delete_user_label(user_id, id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'gmail/v1/users/{userId}/labels/{id}', options) command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the specified label. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] id # The ID of the label to retrieve. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -580,29 +544,26 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_label(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/labels/{id}', options) + def get_user_label(user_id, id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/labels/{id}', options) command.response_representation = Google::Apis::GmailV1::Label::Representation command.response_class = Google::Apis::GmailV1::Label command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists all labels in the user's mailbox. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -615,31 +576,28 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_user_labels(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/labels', options) + def list_user_labels(user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/labels', options) command.response_representation = Google::Apis::GmailV1::ListLabelsResponse::Representation command.response_class = Google::Apis::GmailV1::ListLabelsResponse command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates the specified label. This method supports patch semantics. + # Patch the specified label. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] id # The ID of the label to update. # @param [Google::Apis::GmailV1::Label] label_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -652,8 +610,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, '{userId}/labels/{id}', options) + def patch_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'gmail/v1/users/{userId}/labels/{id}', options) command.request_representation = Google::Apis::GmailV1::Label::Representation command.request_object = label_object command.response_representation = Google::Apis::GmailV1::Label::Representation @@ -662,24 +620,21 @@ module Google command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates the specified label. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] id # The ID of the label to update. # @param [Google::Apis::GmailV1::Label] label_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -692,8 +647,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{userId}/labels/{id}', options) + def update_user_label(user_id, id, label_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'gmail/v1/users/{userId}/labels/{id}', options) command.request_representation = Google::Apis::GmailV1::Label::Representation command.request_object = label_object command.response_representation = Google::Apis::GmailV1::Label::Representation @@ -702,23 +657,20 @@ module Google command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Deletes many messages by message ID. Provides no guarantees that messages were - # not already deleted or even existed at all. + # Deletes many messages by message ID. Provides no guarantees that messages + # were not already deleted or even existed at all. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::BatchDeleteMessagesRequest] batch_delete_messages_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -731,29 +683,26 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def batch_delete_messages(user_id, batch_delete_messages_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/messages/batchDelete', options) + def batch_delete_messages(user_id, batch_delete_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/batchDelete', options) command.request_representation = Google::Apis::GmailV1::BatchDeleteMessagesRequest::Representation command.request_object = batch_delete_messages_request_object command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Modifies the labels on the specified messages. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::BatchModifyMessagesRequest] batch_modify_messages_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -766,31 +715,28 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def batch_modify_messages(user_id, batch_modify_messages_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/messages/batchModify', options) + def batch_modify_messages(user_id, batch_modify_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/batchModify', options) command.request_representation = Google::Apis::GmailV1::BatchModifyMessagesRequest::Representation command.request_object = batch_modify_messages_request_object command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Immediately and permanently deletes the specified message. This operation - # cannot be undone. Prefer messages.trash instead. + # cannot be undone. Prefer messages.trash instead. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] id # The ID of the message to delete. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -803,20 +749,19 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_user_message(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{userId}/messages/{id}', options) + def delete_user_message(user_id, id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'gmail/v1/users/{userId}/messages/{id}', options) command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the specified message. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] id # The ID of the message to retrieve. # @param [String] format @@ -826,10 +771,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -842,8 +785,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_message(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/messages/{id}', options) + def get_user_message(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/messages/{id}', options) command.response_representation = Google::Apis::GmailV1::Message::Representation command.response_class = Google::Apis::GmailV1::Message command.params['userId'] = user_id unless user_id.nil? @@ -852,35 +795,34 @@ module Google command.query['metadataHeaders'] = metadata_headers unless metadata_headers.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Imports a message into only this user's mailbox, with standard email delivery - # scanning and classification similar to receiving via SMTP. Does not send a - # message. + # Imports a message into only this user's mailbox, with standard + # email delivery scanning and classification similar to receiving via SMTP. + # Does not send a message. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::Message] message_object # @param [Boolean] deleted - # Mark the email as permanently deleted (not TRASH) and only visible in Google - # Vault to a Vault administrator. Only used for G Suite accounts. + # Mark the email as permanently deleted (not TRASH) and + # only visible in + # Google Vault to + # a Vault administrator. Only used for G Suite accounts. # @param [String] internal_date_source # Source for Gmail's internal date of the message. # @param [Boolean] never_mark_spam - # Ignore the Gmail spam classifier decision and never mark this email as SPAM in - # the mailbox. + # Ignore the Gmail spam classifier decision and never mark + # this email as SPAM in the mailbox. # @param [Boolean] process_for_calendar - # Process calendar invites in the email and add any extracted meetings to the - # Google Calendar for this user. + # Process calendar invites in the email and add any extracted + # meetings to the Google Calendar for this user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [IO, String] upload_source # IO stream or filename containing content to upload # @param [String] content_type @@ -897,11 +839,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def import_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, never_mark_spam: nil, process_for_calendar: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) + def import_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, never_mark_spam: nil, process_for_calendar: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? - command = make_simple_command(:post, '{userId}/messages/import', options) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/import', options) else - command = make_upload_command(:post, '{userId}/messages/import', options) + command = make_upload_command(:post, 'gmail/v1/users/{userId}/messages/import', options) command.upload_source = upload_source command.upload_content_type = content_type end @@ -916,28 +858,28 @@ module Google command.query['processForCalendar'] = process_for_calendar unless process_for_calendar.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Directly inserts a message into only this user's mailbox similar to IMAP - # APPEND, bypassing most scanning and classification. Does not send a message. + # Directly inserts a message into only this user's mailbox similar to + # IMAP APPEND, bypassing most scanning and classification. + # Does not send a message. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::Message] message_object # @param [Boolean] deleted - # Mark the email as permanently deleted (not TRASH) and only visible in Google - # Vault to a Vault administrator. Only used for G Suite accounts. + # Mark the email as permanently deleted (not TRASH) and + # only visible in + # Google Vault to + # a Vault administrator. Only used for G Suite accounts. # @param [String] internal_date_source # Source for Gmail's internal date of the message. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [IO, String] upload_source # IO stream or filename containing content to upload # @param [String] content_type @@ -954,11 +896,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) + def insert_user_message(user_id, message_object = nil, deleted: nil, internal_date_source: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? - command = make_simple_command(:post, '{userId}/messages', options) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages', options) else - command = make_upload_command(:post, '{userId}/messages', options) + command = make_upload_command(:post, 'gmail/v1/users/{userId}/messages', options) command.upload_source = upload_source command.upload_content_type = content_type end @@ -971,16 +913,16 @@ module Google command.query['internalDateSource'] = internal_date_source unless internal_date_source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists the messages in the user's mailbox. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [Boolean] include_spam_trash - # Include messages from SPAM and TRASH in the results. + # Include messages from SPAM and TRASH + # in the results. # @param [Array, String] label_ids # Only return messages with labels that match all of the specified label IDs. # @param [Fixnum] max_results @@ -988,17 +930,16 @@ module Google # @param [String] page_token # Page token to retrieve a specific page of results in the list. # @param [String] q - # Only return messages matching the specified query. Supports the same query - # format as the Gmail search box. For example, "from:someuser@example.com - # rfc822msgid: is:unread". Parameter cannot be used when - # accessing the api using the gmail.metadata scope. + # Only return messages matching the specified query. Supports the same + # query format as the Gmail search box. For example, + # "from:someuser@example.com rfc822msgid:<somemsgid@example.com> + # is:unread". Parameter cannot be used when accessing the api + # using the gmail.metadata scope. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1011,8 +952,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_user_messages(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/messages', options) + def list_user_messages(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/messages', options) command.response_representation = Google::Apis::GmailV1::ListMessagesResponse::Representation command.response_class = Google::Apis::GmailV1::ListMessagesResponse command.params['userId'] = user_id unless user_id.nil? @@ -1023,24 +964,21 @@ module Google command.query['q'] = q unless q.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Modifies the labels on the specified message. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] id # The ID of the message to modify. # @param [Google::Apis::GmailV1::ModifyMessageRequest] modify_message_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1053,8 +991,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def modify_message(user_id, id, modify_message_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/messages/{id}/modify', options) + def modify_message(user_id, id, modify_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/{id}/modify', options) command.request_representation = Google::Apis::GmailV1::ModifyMessageRequest::Representation command.request_object = modify_message_request_object command.response_representation = Google::Apis::GmailV1::Message::Representation @@ -1063,22 +1001,20 @@ module Google command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Sends the specified message to the recipients in the To, Cc, and Bcc headers. + # Sends the specified message to the recipients in the + # To, Cc, and Bcc headers. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::Message] message_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [IO, String] upload_source # IO stream or filename containing content to upload # @param [String] content_type @@ -1095,11 +1031,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def send_user_message(user_id, message_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) + def send_user_message(user_id, message_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? - command = make_simple_command(:post, '{userId}/messages/send', options) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/send', options) else - command = make_upload_command(:post, '{userId}/messages/send', options) + command = make_upload_command(:post, 'gmail/v1/users/{userId}/messages/send', options) command.upload_source = upload_source command.upload_content_type = content_type end @@ -1110,23 +1046,20 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Moves the specified message to the trash. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] id # The ID of the message to Trash. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1139,31 +1072,28 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def trash_user_message(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/messages/{id}/trash', options) + def trash_user_message(user_id, id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/{id}/trash', options) command.response_representation = Google::Apis::GmailV1::Message::Representation command.response_class = Google::Apis::GmailV1::Message command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Removes the specified message from the trash. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] id # The ID of the message to remove from Trash. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1176,22 +1106,21 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def untrash_user_message(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/messages/{id}/untrash', options) + def untrash_user_message(user_id, id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/messages/{id}/untrash', options) command.response_representation = Google::Apis::GmailV1::Message::Representation command.response_class = Google::Apis::GmailV1::Message command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the specified message attachment. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] message_id # The ID of the message containing the attachment. # @param [String] id @@ -1199,10 +1128,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1215,8 +1142,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_message_attachment(user_id, message_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/messages/{messageId}/attachments/{id}', options) + def get_user_message_attachment(user_id, message_id, id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}', options) command.response_representation = Google::Apis::GmailV1::MessagePartBody::Representation command.response_class = Google::Apis::GmailV1::MessagePartBody command.params['userId'] = user_id unless user_id.nil? @@ -1224,21 +1151,18 @@ module Google command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the auto-forwarding setting for the specified account. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1251,28 +1175,25 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_setting_auto_forwarding(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/settings/autoForwarding', options) + def get_user_setting_auto_forwarding(user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/autoForwarding', options) command.response_representation = Google::Apis::GmailV1::AutoForwarding::Representation command.response_class = Google::Apis::GmailV1::AutoForwarding command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets IMAP settings. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1285,28 +1206,25 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_setting_imap(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/settings/imap', options) + def get_user_setting_imap(user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/imap', options) command.response_representation = Google::Apis::GmailV1::ImapSettings::Representation command.response_class = Google::Apis::GmailV1::ImapSettings command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets language settings. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1319,28 +1237,25 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_setting_language(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/settings/language', options) + def get_user_setting_language(user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/language', options) command.response_representation = Google::Apis::GmailV1::LanguageSettings::Representation command.response_class = Google::Apis::GmailV1::LanguageSettings command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets POP settings. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1353,28 +1268,25 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_setting_pop(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/settings/pop', options) + def get_user_setting_pop(user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/pop', options) command.response_representation = Google::Apis::GmailV1::PopSettings::Representation command.response_class = Google::Apis::GmailV1::PopSettings command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets vacation responder settings. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1387,32 +1299,29 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_setting_vacation(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/settings/vacation', options) + def get_user_setting_vacation(user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/vacation', options) command.response_representation = Google::Apis::GmailV1::VacationSettings::Representation command.response_class = Google::Apis::GmailV1::VacationSettings command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates the auto-forwarding setting for the specified account. A verified + # Updates the auto-forwarding setting for the specified account. A verified # forwarding address must be specified when auto-forwarding is enabled. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::AutoForwarding] auto_forwarding_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1425,8 +1334,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_user_setting_auto_forwarding(user_id, auto_forwarding_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{userId}/settings/autoForwarding', options) + def update_user_setting_auto_forwarding(user_id, auto_forwarding_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/autoForwarding', options) command.request_representation = Google::Apis::GmailV1::AutoForwarding::Representation command.request_object = auto_forwarding_object command.response_representation = Google::Apis::GmailV1::AutoForwarding::Representation @@ -1434,22 +1343,19 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates IMAP settings. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::ImapSettings] imap_settings_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1462,8 +1368,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_user_setting_imap(user_id, imap_settings_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{userId}/settings/imap', options) + def update_user_setting_imap(user_id, imap_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/imap', options) command.request_representation = Google::Apis::GmailV1::ImapSettings::Representation command.request_object = imap_settings_object command.response_representation = Google::Apis::GmailV1::ImapSettings::Representation @@ -1471,27 +1377,24 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates language settings. - # If successful, the return object contains the displayLanguage that was saved - # for the user, which may differ from the value passed into the request. This is - # because the requested displayLanguage may not be directly supported by Gmail - # but have a close variant that is, and so the variant may be chosen and saved - # instead. + # If successful, the return object contains the displayLanguage + # that was saved for the user, which may differ from the value passed into + # the request. This is because the requested displayLanguage may + # not be directly supported by Gmail but have a close variant that is, and so + # the variant may be chosen and saved instead. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::LanguageSettings] language_settings_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1504,8 +1407,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_user_setting_language(user_id, language_settings_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{userId}/settings/language', options) + def update_user_setting_language(user_id, language_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/language', options) command.request_representation = Google::Apis::GmailV1::LanguageSettings::Representation command.request_object = language_settings_object command.response_representation = Google::Apis::GmailV1::LanguageSettings::Representation @@ -1513,22 +1416,19 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates POP settings. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::PopSettings] pop_settings_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1541,8 +1441,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_user_setting_pop(user_id, pop_settings_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{userId}/settings/pop', options) + def update_user_setting_pop(user_id, pop_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/pop', options) command.request_representation = Google::Apis::GmailV1::PopSettings::Representation command.request_object = pop_settings_object command.response_representation = Google::Apis::GmailV1::PopSettings::Representation @@ -1550,22 +1450,19 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates vacation responder settings. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::VacationSettings] vacation_settings_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1578,8 +1475,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_user_setting_vacation(user_id, vacation_settings_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{userId}/settings/vacation', options) + def update_user_setting_vacation(user_id, vacation_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/vacation', options) command.request_representation = Google::Apis::GmailV1::VacationSettings::Representation command.request_object = vacation_settings_object command.response_representation = Google::Apis::GmailV1::VacationSettings::Representation @@ -1587,33 +1484,32 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Adds a delegate with its verification status set directly to accepted, without - # sending any verification email. The delegate user must be a member of the same - # G Suite organization as the delegator user. - # Gmail imposes limitations on the number of delegates and delegators each user - # in a G Suite organization can have. These limits depend on your organization, - # but in general each user can have up to 25 delegates and up to 10 delegators. - # Note that a delegate user must be referred to by their primary email address, - # and not an email alias. - # Also note that when a new delegate is created, there may be up to a one minute - # delay before the new delegate is available for use. + # Adds a delegate with its verification status set directly to + # accepted, without sending any verification email. The + # delegate user must be a member of the same G Suite organization as the + # delegator user. + # Gmail imposes limitations on the number of delegates and delegators each + # user in a G Suite organization can have. These limits depend on your + # organization, but in general each user can have up to 25 delegates and + # up to 10 delegators. + # Note that a delegate user must be referred to by their primary email + # address, and not an email alias. + # Also note that when a new delegate is created, there may be up to a one + # minute delay before the new delegate is available for use. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::Delegate] delegate_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1626,8 +1522,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_user_setting_delegate(user_id, delegate_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/settings/delegates', options) + def create_user_setting_delegate(user_id, delegate_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/delegates', options) command.request_representation = Google::Apis::GmailV1::Delegate::Representation command.request_object = delegate_object command.response_representation = Google::Apis::GmailV1::Delegate::Representation @@ -1635,28 +1531,25 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Removes the specified delegate (which can be of any verification status), and - # revokes any verification that may have been required for using it. - # Note that a delegate user must be referred to by their primary email address, - # and not an email alias. + # Removes the specified delegate (which can be of any verification status), + # and revokes any verification that may have been required for using it. + # Note that a delegate user must be referred to by their primary email + # address, and not an email alias. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] delegate_email # The email address of the user to be removed as a delegate. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1669,33 +1562,31 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{userId}/settings/delegates/{delegateEmail}', options) + def delete_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'gmail/v1/users/{userId}/settings/delegates/{delegateEmail}', options) command.params['userId'] = user_id unless user_id.nil? command.params['delegateEmail'] = delegate_email unless delegate_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the specified delegate. - # Note that a delegate user must be referred to by their primary email address, - # and not an email alias. + # Note that a delegate user must be referred to by their primary email + # address, and not an email alias. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] delegate_email - # The email address of the user whose delegate relationship is to be retrieved. + # The email address of the user whose delegate relationship is to be + # retrieved. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1708,15 +1599,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/settings/delegates/{delegateEmail}', options) + def get_user_setting_delegate(user_id, delegate_email, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/delegates/{delegateEmail}', options) command.response_representation = Google::Apis::GmailV1::Delegate::Representation command.response_class = Google::Apis::GmailV1::Delegate command.params['userId'] = user_id unless user_id.nil? command.params['delegateEmail'] = delegate_email unless delegate_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1724,15 +1614,13 @@ module Google # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1745,29 +1633,26 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_user_setting_delegates(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/settings/delegates', options) + def list_user_setting_delegates(user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/delegates', options) command.response_representation = Google::Apis::GmailV1::ListDelegatesResponse::Representation command.response_class = Google::Apis::GmailV1::ListDelegatesResponse command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Creates a filter. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::Filter] filter_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1780,8 +1665,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_user_setting_filter(user_id, filter_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/settings/filters', options) + def create_user_setting_filter(user_id, filter_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/filters', options) command.request_representation = Google::Apis::GmailV1::Filter::Representation command.request_object = filter_object command.response_representation = Google::Apis::GmailV1::Filter::Representation @@ -1789,23 +1674,20 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes a filter. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] id # The ID of the filter to be deleted. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1818,29 +1700,26 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_user_setting_filter(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{userId}/settings/filters/{id}', options) + def delete_user_setting_filter(user_id, id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'gmail/v1/users/{userId}/settings/filters/{id}', options) command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets a filter. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] id # The ID of the filter to be fetched. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1853,29 +1732,26 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_setting_filter(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/settings/filters/{id}', options) + def get_user_setting_filter(user_id, id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/filters/{id}', options) command.response_representation = Google::Apis::GmailV1::Filter::Representation command.response_class = Google::Apis::GmailV1::Filter command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists the message filters of a Gmail user. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1888,34 +1764,31 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_user_setting_filters(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/settings/filters', options) + def list_user_setting_filters(user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/filters', options) command.response_representation = Google::Apis::GmailV1::ListFiltersResponse::Representation command.response_class = Google::Apis::GmailV1::ListFiltersResponse command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Creates a forwarding address. If ownership verification is required, a message - # will be sent to the recipient and the resource's verification status will be - # set to pending; otherwise, the resource will be created with verification - # status set to accepted. + # Creates a forwarding address. If ownership verification is required, a + # message will be sent to the recipient and the resource's verification + # status will be set to pending; otherwise, the resource will be + # created with verification status set to accepted. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::ForwardingAddress] forwarding_address_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1928,8 +1801,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_user_setting_forwarding_address(user_id, forwarding_address_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/settings/forwardingAddresses', options) + def create_user_setting_forwarding_address(user_id, forwarding_address_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/forwardingAddresses', options) command.request_representation = Google::Apis::GmailV1::ForwardingAddress::Representation command.request_object = forwarding_address_object command.response_representation = Google::Apis::GmailV1::ForwardingAddress::Representation @@ -1937,26 +1810,23 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Deletes the specified forwarding address and revokes any verification that may - # have been required. + # Deletes the specified forwarding address and revokes any verification that + # may have been required. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] forwarding_email # The forwarding address to be deleted. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1969,29 +1839,26 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{userId}/settings/forwardingAddresses/{forwardingEmail}', options) + def delete_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}', options) command.params['userId'] = user_id unless user_id.nil? command.params['forwardingEmail'] = forwarding_email unless forwarding_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the specified forwarding address. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] forwarding_email # The forwarding address to be retrieved. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2004,29 +1871,26 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/settings/forwardingAddresses/{forwardingEmail}', options) + def get_user_setting_forwarding_address(user_id, forwarding_email, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}', options) command.response_representation = Google::Apis::GmailV1::ForwardingAddress::Representation command.response_class = Google::Apis::GmailV1::ForwardingAddress command.params['userId'] = user_id unless user_id.nil? command.params['forwardingEmail'] = forwarding_email unless forwarding_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists the forwarding addresses for the specified account. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2039,37 +1903,35 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_user_setting_forwarding_addresses(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/settings/forwardingAddresses', options) + def list_user_setting_forwarding_addresses(user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/forwardingAddresses', options) command.response_representation = Google::Apis::GmailV1::ListForwardingAddressesResponse::Representation command.response_class = Google::Apis::GmailV1::ListForwardingAddressesResponse command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will - # attempt to connect to the SMTP service to validate the configuration before - # creating the alias. If ownership verification is required for the alias, a - # message will be sent to the email address and the resource's verification - # status will be set to pending; otherwise, the resource will be created with - # verification status set to accepted. If a signature is provided, Gmail will - # sanitize the HTML before saving it with the alias. + # Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail + # will attempt to connect to the SMTP service to validate the configuration + # before creating the alias. If ownership verification is required for the + # alias, a message will be sent to the email address and the resource's + # verification status will be set to pending; otherwise, the + # resource will be created with verification status set to + # accepted. If a signature is provided, Gmail will sanitize the + # HTML before saving it with the alias. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [Google::Apis::GmailV1::SendAs] send_as_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2082,8 +1944,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_user_setting_send_as(user_id, send_as_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/settings/sendAs', options) + def create_user_setting_send_as(user_id, send_as_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/sendAs', options) command.request_representation = Google::Apis::GmailV1::SendAs::Representation command.request_object = send_as_object command.response_representation = Google::Apis::GmailV1::SendAs::Representation @@ -2091,26 +1953,23 @@ module Google command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Deletes the specified send-as alias. Revokes any verification that may have - # been required for using it. + # Deletes the specified send-as alias. Revokes any verification that may + # have been required for using it. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] send_as_email # The send-as alias to be deleted. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2123,30 +1982,27 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{userId}/settings/sendAs/{sendAsEmail}', options) + def delete_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}', options) command.params['userId'] = user_id unless user_id.nil? command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Gets the specified send-as alias. Fails with an HTTP 404 error if the + # Gets the specified send-as alias. Fails with an HTTP 404 error if the # specified address is not a member of the collection. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] send_as_email # The send-as alias to be retrieved. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2159,31 +2015,28 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/settings/sendAs/{sendAsEmail}', options) + def get_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}', options) command.response_representation = Google::Apis::GmailV1::SendAs::Representation command.response_class = Google::Apis::GmailV1::SendAs command.params['userId'] = user_id unless user_id.nil? command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Lists the send-as aliases for the specified account. The result includes the - # primary send-as address associated with the account as well as any custom " - # from" aliases. + # Lists the send-as aliases for the specified account. The result includes + # the primary send-as address associated with the account as well as any + # custom "from" aliases. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2196,35 +2049,28 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_user_setting_send_as(user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/settings/sendAs', options) + def list_user_setting_send_as(user_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/sendAs', options) command.response_representation = Google::Apis::GmailV1::ListSendAsResponse::Representation command.response_class = Google::Apis::GmailV1::ListSendAsResponse command.params['userId'] = user_id unless user_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates a send-as alias. If a signature is provided, Gmail will sanitize the - # HTML before saving it with the alias. - # Addresses other than the primary address for the account can only be updated - # by service account clients that have been delegated domain-wide authority. - # This method supports patch semantics. + # Patch the specified send-as alias. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] send_as_email # The send-as alias to be updated. # @param [Google::Apis::GmailV1::SendAs] send_as_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2237,8 +2083,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, '{userId}/settings/sendAs/{sendAsEmail}', options) + def patch_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}', options) command.request_representation = Google::Apis::GmailV1::SendAs::Representation command.request_object = send_as_object command.response_representation = Google::Apis::GmailV1::SendAs::Representation @@ -2247,27 +2093,25 @@ module Google command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates a send-as alias. If a signature is provided, Gmail will sanitize the - # HTML before saving it with the alias. - # Addresses other than the primary address for the account can only be updated - # by service account clients that have been delegated domain-wide authority. + # Updates a send-as alias. If a signature is provided, Gmail will sanitize + # the HTML before saving it with the alias. + # Addresses other than the primary address for the account can only be + # updated by service account clients that have been delegated domain-wide + # authority. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] send_as_email # The send-as alias to be updated. # @param [Google::Apis::GmailV1::SendAs] send_as_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2280,8 +2124,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, '{userId}/settings/sendAs/{sendAsEmail}', options) + def update_user_setting_send_as(user_id, send_as_email, send_as_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}', options) command.request_representation = Google::Apis::GmailV1::SendAs::Representation command.request_object = send_as_object command.response_representation = Google::Apis::GmailV1::SendAs::Representation @@ -2290,26 +2134,23 @@ module Google command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Sends a verification email to the specified send-as alias address. The - # verification status must be pending. + # Sends a verification email to the specified send-as alias address. + # The verification status must be pending. # This method is only available to service account clients that have been # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" can be used to indicate the - # authenticated user. + # User's email address. The special value "me" + # can be used to indicate the authenticated user. # @param [String] send_as_email # The send-as alias to be verified. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2322,32 +2163,29 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def verify_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/settings/sendAs/{sendAsEmail}/verify', options) + def verify_user_setting_send_as(user_id, send_as_email, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify', options) command.params['userId'] = user_id unless user_id.nil? command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes the specified S/MIME config for the specified send-as alias. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using this - # alias. + # The email address that appears in the "From:" header for mail sent using + # this alias. # @param [String] id # The immutable ID for the SmimeInfo. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2360,33 +2198,30 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}', options) + def delete_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}', options) command.params['userId'] = user_id unless user_id.nil? command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the specified S/MIME config for the specified send-as alias. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using this - # alias. + # The email address that appears in the "From:" header for mail sent using + # this alias. # @param [String] id # The immutable ID for the SmimeInfo. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2399,8 +2234,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}', options) + def get_user_setting_send_a_smime_info(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}', options) command.response_representation = Google::Apis::GmailV1::SmimeInfo::Representation command.response_class = Google::Apis::GmailV1::SmimeInfo command.params['userId'] = user_id unless user_id.nil? @@ -2408,26 +2243,23 @@ module Google command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Insert (upload) the given S/MIME config for the specified send-as alias. Note - # that pkcs12 format is required for the key. + # Insert (upload) the given S/MIME config for the specified send-as alias. + # Note that pkcs12 format is required for the key. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using this - # alias. + # The email address that appears in the "From:" header for mail sent using + # this alias. # @param [Google::Apis::GmailV1::SmimeInfo] smime_info_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2440,8 +2272,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_user_setting_send_a_smime_info(user_id, send_as_email, smime_info_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo', options) + def insert_user_setting_send_a_smime_info(user_id, send_as_email, smime_info_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo', options) command.request_representation = Google::Apis::GmailV1::SmimeInfo::Representation command.request_object = smime_info_object command.response_representation = Google::Apis::GmailV1::SmimeInfo::Representation @@ -2450,24 +2282,21 @@ module Google command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists S/MIME configs for the specified send-as alias. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using this - # alias. + # The email address that appears in the "From:" header for mail sent using + # this alias. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2480,34 +2309,31 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_user_setting_send_a_smime_infos(user_id, send_as_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo', options) + def list_user_setting_send_a_smime_infos(user_id, send_as_email, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo', options) command.response_representation = Google::Apis::GmailV1::ListSmimeInfoResponse::Representation command.response_class = Google::Apis::GmailV1::ListSmimeInfoResponse command.params['userId'] = user_id unless user_id.nil? command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Sets the default S/MIME config for the specified send-as alias. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using this - # alias. + # The email address that appears in the "From:" header for mail sent using + # this alias. # @param [String] id # The immutable ID for the SmimeInfo. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2520,31 +2346,28 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def set_user_setting_send_a_smime_info_default(user_id, send_as_email, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault', options) + def set_user_setting_send_a_smime_info_default(user_id, send_as_email, id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault', options) command.params['userId'] = user_id unless user_id.nil? command.params['sendAsEmail'] = send_as_email unless send_as_email.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Immediately and permanently deletes the specified thread. This operation - # cannot be undone. Prefer threads.trash instead. + # cannot be undone. Prefer threads.trash instead. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] id # ID of the Thread to delete. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2557,20 +2380,19 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_user_thread(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{userId}/threads/{id}', options) + def delete_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'gmail/v1/users/{userId}/threads/{id}', options) command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Gets the specified thread. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] id # The ID of the thread to retrieve. # @param [String] format @@ -2580,10 +2402,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2596,8 +2416,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_user_thread(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/threads/{id}', options) + def get_user_thread(user_id, id, format: nil, metadata_headers: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/threads/{id}', options) command.response_representation = Google::Apis::GmailV1::Thread::Representation command.response_class = Google::Apis::GmailV1::Thread command.params['userId'] = user_id unless user_id.nil? @@ -2606,16 +2426,16 @@ module Google command.query['metadataHeaders'] = metadata_headers unless metadata_headers.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Lists the threads in the user's mailbox. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [Boolean] include_spam_trash - # Include threads from SPAM and TRASH in the results. + # Include threads from SPAM and TRASH + # in the results. # @param [Array, String] label_ids # Only return threads with labels that match all of the specified label IDs. # @param [Fixnum] max_results @@ -2623,17 +2443,16 @@ module Google # @param [String] page_token # Page token to retrieve a specific page of results in the list. # @param [String] q - # Only return threads matching the specified query. Supports the same query - # format as the Gmail search box. For example, "from:someuser@example.com - # rfc822msgid: is:unread". Parameter cannot be used when accessing the api using - # the gmail.metadata scope. + # Only return threads matching the specified query. Supports the same + # query format as the Gmail search box. For example, + # "from:someuser@example.com rfc822msgid: + # is:unread". Parameter cannot be used when accessing the api + # using the gmail.metadata scope. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2646,8 +2465,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_user_threads(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{userId}/threads', options) + def list_user_threads(user_id, include_spam_trash: nil, label_ids: nil, max_results: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'gmail/v1/users/{userId}/threads', options) command.response_representation = Google::Apis::GmailV1::ListThreadsResponse::Representation command.response_class = Google::Apis::GmailV1::ListThreadsResponse command.params['userId'] = user_id unless user_id.nil? @@ -2658,25 +2477,22 @@ module Google command.query['q'] = q unless q.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Modifies the labels applied to the thread. This applies to all messages in the - # thread. + # Modifies the labels applied to the thread. This applies to all messages + # in the thread. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] id # The ID of the thread to modify. # @param [Google::Apis::GmailV1::ModifyThreadRequest] modify_thread_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2689,8 +2505,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def modify_thread(user_id, id, modify_thread_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/threads/{id}/modify', options) + def modify_thread(user_id, id, modify_thread_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/threads/{id}/modify', options) command.request_representation = Google::Apis::GmailV1::ModifyThreadRequest::Representation command.request_object = modify_thread_request_object command.response_representation = Google::Apis::GmailV1::Thread::Representation @@ -2699,23 +2515,20 @@ module Google command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Moves the specified thread to the trash. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] id # The ID of the thread to Trash. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2728,31 +2541,28 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def trash_user_thread(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/threads/{id}/trash', options) + def trash_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/threads/{id}/trash', options) command.response_representation = Google::Apis::GmailV1::Thread::Representation command.response_class = Google::Apis::GmailV1::Thread command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Removes the specified thread from the trash. # @param [String] user_id - # The user's email address. The special value me can be used to indicate the - # authenticated user. + # The user's email address. The special value me + # can be used to indicate the authenticated user. # @param [String] id # The ID of the thread to remove from Trash. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2765,15 +2575,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def untrash_user_thread(user_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{userId}/threads/{id}/untrash', options) + def untrash_user_thread(user_id, id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'gmail/v1/users/{userId}/threads/{id}/untrash', options) command.response_representation = Google::Apis::GmailV1::Thread::Representation command.response_class = Google::Apis::GmailV1::Thread command.params['userId'] = user_id unless user_id.nil? command.params['id'] = id unless id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2782,7 +2591,6 @@ module Google def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? end end end diff --git a/generated/google/apis/mirror_v1.rb b/generated/google/apis/healthcare_v1.rb similarity index 55% rename from generated/google/apis/mirror_v1.rb rename to generated/google/apis/healthcare_v1.rb index 7376701a5..50468d45e 100644 --- a/generated/google/apis/mirror_v1.rb +++ b/generated/google/apis/healthcare_v1.rb @@ -12,26 +12,23 @@ # See the License for the specific language governing permissions and # limitations under the License. -require 'google/apis/mirror_v1/service.rb' -require 'google/apis/mirror_v1/classes.rb' -require 'google/apis/mirror_v1/representations.rb' +require 'google/apis/healthcare_v1/service.rb' +require 'google/apis/healthcare_v1/classes.rb' +require 'google/apis/healthcare_v1/representations.rb' module Google module Apis - # Google Mirror API + # Cloud Healthcare API # - # Interacts with Glass users via the timeline. + # Manage, store, and access healthcare data in Google Cloud Platform. # - # @see https://developers.google.com/glass - module MirrorV1 + # @see https://cloud.google.com/healthcare + module HealthcareV1 VERSION = 'V1' - REVISION = '20180611' + REVISION = '20200327' - # View your location - AUTH_GLASS_LOCATION = 'https://www.googleapis.com/auth/glass.location' - - # View and manage your Glass timeline - AUTH_GLASS_TIMELINE = 'https://www.googleapis.com/auth/glass.timeline' + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' end end end diff --git a/generated/google/apis/healthcare_v1/classes.rb b/generated/google/apis/healthcare_v1/classes.rb new file mode 100644 index 000000000..410e25e8f --- /dev/null +++ b/generated/google/apis/healthcare_v1/classes.rb @@ -0,0 +1,2639 @@ +# Copyright 2015 Google Inc. +# +# 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 HealthcareV1 + + # 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 AuditConfig + include Google::Apis::Core::Hashable + + # The configuration for logging of each type of permission. + # Corresponds to the JSON property `auditLogConfigs` + # @return [Array] + 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 AuditLogConfig + 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] + 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 + + # Associates `members` with a `role`. + class Binding + 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::HealthcareV1::Expr] + 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] + 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 CancelOperationRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Mask a string by replacing its characters with a fixed character. + class CharacterMaskConfig + include Google::Apis::Core::Hashable + + # Character to mask the sensitive values. If not supplied, defaults to "*". + # Corresponds to the JSON property `maskingCharacter` + # @return [String] + attr_accessor :masking_character + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @masking_character = args[:masking_character] if args.key?(:masking_character) + end + end + + # Creates a new message. + class CreateMessageRequest + include Google::Apis::Core::Hashable + + # A complete HL7v2 message. + # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details + # on the standard. + # Corresponds to the JSON property `message` + # @return [Google::Apis::HealthcareV1::Message] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @message = args[:message] if args.key?(:message) + end + end + + # Pseudonymization method that generates surrogates via cryptographic hashing. + # Uses SHA-256. + # Outputs a base64-encoded representation of the hashed output + # (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). + class CryptoHashConfig + include Google::Apis::Core::Hashable + + # An AES 128/192/256 bit key. Causes the hash to be computed based on this + # key. A default key is generated for each Deidentify operation and is used + # wherever crypto_key is not specified. + # Corresponds to the JSON property `cryptoKey` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :crypto_key + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @crypto_key = args[:crypto_key] if args.key?(:crypto_key) + end + end + + # A message representing a health dataset. + # A health dataset represents a collection of healthcare data pertaining to one + # or more patients. This may include multiple modalities of healthcare data, + # such as electronic medical records or medical imaging data. + class Dataset + include Google::Apis::Core::Hashable + + # Output only. Resource name of the dataset, of the form + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The default timezone used by this dataset. Must be a either a valid IANA + # time zone name such as "America/New_York" or empty, which defaults to UTC. + # This is used for parsing times in resources, such as HL7 messages, where no + # explicit timezone is specified. + # Corresponds to the JSON property `timeZone` + # @return [String] + attr_accessor :time_zone + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @time_zone = args[:time_zone] if args.key?(:time_zone) + end + end + + # Shift a date forward or backward in time by a random amount which is + # consistent for a given patient and crypto key combination. + class DateShiftConfig + include Google::Apis::Core::Hashable + + # An AES 128/192/256 bit key. Causes the shift to be computed based on this + # key and the patient ID. A default key is generated for each + # Deidentify operation and is used wherever crypto_key is not specified. + # Corresponds to the JSON property `cryptoKey` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :crypto_key + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @crypto_key = args[:crypto_key] if args.key?(:crypto_key) + end + end + + # Configures de-id options specific to different types of content. + # Each submessage customizes the handling of an + # https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are + # applied in a nested manner at runtime. + class DeidentifyConfig + include Google::Apis::Core::Hashable + + # Specifies the parameters needed for de-identification of DICOM stores. + # Corresponds to the JSON property `dicom` + # @return [Google::Apis::HealthcareV1::DicomConfig] + attr_accessor :dicom + + # Specifies how to handle de-identification of a FHIR store. + # Corresponds to the JSON property `fhir` + # @return [Google::Apis::HealthcareV1::FhirConfig] + attr_accessor :fhir + + # Specifies how to handle de-identification of image pixels. + # Corresponds to the JSON property `image` + # @return [Google::Apis::HealthcareV1::ImageConfig] + attr_accessor :image + + # Configures de-identification of text wherever it is found in the + # source_dataset. + # Corresponds to the JSON property `text` + # @return [Google::Apis::HealthcareV1::TextConfig] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dicom = args[:dicom] if args.key?(:dicom) + @fhir = args[:fhir] if args.key?(:fhir) + @image = args[:image] if args.key?(:image) + @text = args[:text] if args.key?(:text) + end + end + + # Redacts identifying information from the specified dataset. + class DeidentifyDatasetRequest + include Google::Apis::Core::Hashable + + # Configures de-id options specific to different types of content. + # Each submessage customizes the handling of an + # https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are + # applied in a nested manner at runtime. + # Corresponds to the JSON property `config` + # @return [Google::Apis::HealthcareV1::DeidentifyConfig] + attr_accessor :config + + # The name of the dataset resource to create and write the redacted data to. + # * The destination dataset must not exist. + # * The destination dataset must be in the same project and location as the + # source dataset. De-identifying data across multiple projects or locations + # is not supported. + # Corresponds to the JSON property `destinationDataset` + # @return [String] + attr_accessor :destination_dataset + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @config = args[:config] if args.key?(:config) + @destination_dataset = args[:destination_dataset] if args.key?(:destination_dataset) + end + end + + # Creates a new DICOM store with sensitive information de-identified. + class DeidentifyDicomStoreRequest + include Google::Apis::Core::Hashable + + # Configures de-id options specific to different types of content. + # Each submessage customizes the handling of an + # https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are + # applied in a nested manner at runtime. + # Corresponds to the JSON property `config` + # @return [Google::Apis::HealthcareV1::DeidentifyConfig] + attr_accessor :config + + # The name of the DICOM store to create and write the redacted data to. + # For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # * The destination dataset must exist. + # * The source dataset and destination dataset must both reside in the same + # project. De-identifying data across multiple projects is not supported. + # * The destination DICOM store must not exist. + # * The caller must have the necessary permissions to create the destination + # DICOM store. + # Corresponds to the JSON property `destinationStore` + # @return [String] + attr_accessor :destination_store + + # Specifies the filter configuration for DICOM resources. + # Corresponds to the JSON property `filterConfig` + # @return [Google::Apis::HealthcareV1::DicomFilterConfig] + attr_accessor :filter_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @config = args[:config] if args.key?(:config) + @destination_store = args[:destination_store] if args.key?(:destination_store) + @filter_config = args[:filter_config] if args.key?(:filter_config) + end + end + + # Creates a new FHIR store with sensitive information de-identified. + class DeidentifyFhirStoreRequest + include Google::Apis::Core::Hashable + + # Configures de-id options specific to different types of content. + # Each submessage customizes the handling of an + # https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are + # applied in a nested manner at runtime. + # Corresponds to the JSON property `config` + # @return [Google::Apis::HealthcareV1::DeidentifyConfig] + attr_accessor :config + + # The name of the FHIR store to create and write the redacted data to. + # For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # fhirStores/`fhir_store_id``. + # * The destination dataset must exist. + # * The source dataset and destination dataset must both reside in the same + # project. De-identifying data across multiple projects is not supported. + # * The destination FHIR store must exist. + # * The caller must have the healthcare.fhirResources.update permission to + # write to the destination FHIR store. + # Corresponds to the JSON property `destinationStore` + # @return [String] + attr_accessor :destination_store + + # Filter configuration. + # Corresponds to the JSON property `resourceFilter` + # @return [Google::Apis::HealthcareV1::FhirFilter] + attr_accessor :resource_filter + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @config = args[:config] if args.key?(:config) + @destination_store = args[:destination_store] if args.key?(:destination_store) + @resource_filter = args[:resource_filter] if args.key?(:resource_filter) + end + end + + # Contains a summary of the Deidentify operation. + class DeidentifySummary + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Specifies the parameters needed for de-identification of DICOM stores. + class DicomConfig + include Google::Apis::Core::Hashable + + # Tag filtering profile that determines which tags to keep/remove. + # Corresponds to the JSON property `filterProfile` + # @return [String] + attr_accessor :filter_profile + + # List of tags to be filtered. + # Corresponds to the JSON property `keepList` + # @return [Google::Apis::HealthcareV1::TagFilterList] + attr_accessor :keep_list + + # List of tags to be filtered. + # Corresponds to the JSON property `removeList` + # @return [Google::Apis::HealthcareV1::TagFilterList] + attr_accessor :remove_list + + # If true, skip replacing StudyInstanceUID, SeriesInstanceUID, + # SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. + # The Cloud Healthcare API regenerates these UIDs by default based on the + # DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly + # to an individual out of context, given access to the original images, or + # to a database of the original images containing the UIDs, it would be + # possible to recover the individual's identity." + # http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9. + # html + # Corresponds to the JSON property `skipIdRedaction` + # @return [Boolean] + attr_accessor :skip_id_redaction + alias_method :skip_id_redaction?, :skip_id_redaction + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @filter_profile = args[:filter_profile] if args.key?(:filter_profile) + @keep_list = args[:keep_list] if args.key?(:keep_list) + @remove_list = args[:remove_list] if args.key?(:remove_list) + @skip_id_redaction = args[:skip_id_redaction] if args.key?(:skip_id_redaction) + end + end + + # Specifies the filter configuration for DICOM resources. + class DicomFilterConfig + include Google::Apis::Core::Hashable + + # The Cloud Storage location of the filter configuration file. + # The `gcs_uri` must be in the format `gs://bucket/path/to/object`. + # The filter configuration file must contain a list of resource paths + # separated by newline characters (\n or \r\n). Each resource path + # must be in the format + # "/studies/`studyUID`[/series/`seriesUID`[/instances/`instanceUID`]]" + # The Cloud Healthcare API service account must have the + # `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage + # location. + # Corresponds to the JSON property `resourcePathsGcsUri` + # @return [String] + attr_accessor :resource_paths_gcs_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_paths_gcs_uri = args[:resource_paths_gcs_uri] if args.key?(:resource_paths_gcs_uri) + end + end + + # Represents a DICOM store. + class DicomStore + include Google::Apis::Core::Hashable + + # User-supplied key-value pairs used to organize DICOM stores. + # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding + # of maximum 128 bytes, and must conform to the + # following PCRE regular expression: + # \p`Ll`\p`Lo``0,62` + # Label values are optional, must be between 1 and 63 characters long, have + # a UTF-8 encoding of maximum 128 bytes, and must conform to the + # following PCRE regular expression: [\p`Ll`\p`Lo`\p`N`_-]`0,63` + # No more than 64 labels can be associated with a given store. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Output only. Resource name of the DICOM store, of the form + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Specifies where to send notifications upon changes to a data store. + # Corresponds to the JSON property `notificationConfig` + # @return [Google::Apis::HealthcareV1::NotificationConfig] + attr_accessor :notification_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @notification_config = args[:notification_config] if args.key?(:notification_config) + 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 + + # Exports data from the specified DICOM store. + # If a given resource, such as a DICOM object with the same SOPInstance UID, + # already exists in the output, it is overwritten with the version + # in the source dataset. + # Exported DICOM data persists when the DICOM store from which it was + # exported is deleted. + class ExportDicomDataRequest + include Google::Apis::Core::Hashable + + # The BigQuery table where the server writes the output. + # Corresponds to the JSON property `bigqueryDestination` + # @return [Google::Apis::HealthcareV1::GoogleCloudHealthcareV1DicomBigQueryDestination] + attr_accessor :bigquery_destination + + # The Cloud Storage location where the server writes the output and the export + # configuration. + # Corresponds to the JSON property `gcsDestination` + # @return [Google::Apis::HealthcareV1::GoogleCloudHealthcareV1DicomGcsDestination] + attr_accessor :gcs_destination + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bigquery_destination = args[:bigquery_destination] if args.key?(:bigquery_destination) + @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination) + end + end + + # Returns additional information in regards to a completed DICOM store export. + class ExportDicomDataResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Request to export resources. + class ExportResourcesRequest + include Google::Apis::Core::Hashable + + # The configuration for exporting to BigQuery. + # Corresponds to the JSON property `bigqueryDestination` + # @return [Google::Apis::HealthcareV1::GoogleCloudHealthcareV1FhirBigQueryDestination] + attr_accessor :bigquery_destination + + # The configuration for exporting to Cloud Storage. + # Corresponds to the JSON property `gcsDestination` + # @return [Google::Apis::HealthcareV1::GoogleCloudHealthcareV1FhirGcsDestination] + attr_accessor :gcs_destination + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bigquery_destination = args[:bigquery_destination] if args.key?(:bigquery_destination) + @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination) + end + end + + # Response when all resources export successfully. + # This structure will be included in the + # response to describe the detailed + # outcome. It will only be included when the operation finishes successfully. + class ExportResourcesResponse + 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 Expr + 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 + + # Specifies how to handle de-identification of a FHIR store. + class FhirConfig + include Google::Apis::Core::Hashable + + # Specifies FHIR paths to match and how to transform them. Any field that + # is not matched by a FieldMetadata is passed through to the output + # dataset unmodified. All extensions are removed in the output. + # Corresponds to the JSON property `fieldMetadataList` + # @return [Array] + attr_accessor :field_metadata_list + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @field_metadata_list = args[:field_metadata_list] if args.key?(:field_metadata_list) + end + end + + # Filter configuration. + class FhirFilter + include Google::Apis::Core::Hashable + + # A list of FHIR resources. + # Corresponds to the JSON property `resources` + # @return [Google::Apis::HealthcareV1::Resources] + attr_accessor :resources + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resources = args[:resources] if args.key?(:resources) + end + end + + # Represents a FHIR store. + class FhirStore + include Google::Apis::Core::Hashable + + # Whether to disable referential integrity in this FHIR store. This field is + # immutable after FHIR store creation. + # The default value is false, meaning that the API enforces referential + # integrity and fails the requests that result in inconsistent state in + # the FHIR store. + # When this field is set to true, the API skips referential integrity + # checks. Consequently, operations that rely on references, such as + # GetPatientEverything, do not return all the results if broken references + # exist. + # Corresponds to the JSON property `disableReferentialIntegrity` + # @return [Boolean] + attr_accessor :disable_referential_integrity + alias_method :disable_referential_integrity?, :disable_referential_integrity + + # Whether to disable resource versioning for this FHIR store. This field can + # not be changed after the creation of FHIR store. + # If set to false, which is the default behavior, all write operations + # cause historical versions to be recorded automatically. The historical + # versions can be fetched through the history APIs, but cannot be updated. + # If set to true, no historical versions are kept. The server sends + # errors for attempts to read the historical versions. + # Corresponds to the JSON property `disableResourceVersioning` + # @return [Boolean] + attr_accessor :disable_resource_versioning + alias_method :disable_resource_versioning?, :disable_resource_versioning + + # Whether this FHIR store has the [updateCreate + # capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html# + # CapabilityStatement.rest.resource.updateCreate). + # This determines if the client can use an Update operation to create a new + # resource with a client-specified ID. If false, all IDs are server-assigned + # through the Create operation and attempts to update a non-existent resource + # return errors. Please treat the audit logs with appropriate levels of + # care if client-specified resource IDs contain sensitive data such as + # patient identifiers, those IDs are part of the FHIR resource path + # recorded in Cloud audit logs and Cloud Pub/Sub notifications. + # Corresponds to the JSON property `enableUpdateCreate` + # @return [Boolean] + attr_accessor :enable_update_create + alias_method :enable_update_create?, :enable_update_create + + # User-supplied key-value pairs used to organize FHIR stores. + # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding + # of maximum 128 bytes, and must conform to the + # following PCRE regular expression: + # \p`Ll`\p`Lo``0,62` + # Label values are optional, must be between 1 and 63 characters long, have + # a UTF-8 encoding of maximum 128 bytes, and must conform to the + # following PCRE regular expression: [\p`Ll`\p`Lo`\p`N`_-]`0,63` + # No more than 64 labels can be associated with a given store. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Output only. Resource name of the FHIR store, of the form + # `projects/`project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Specifies where to send notifications upon changes to a data store. + # Corresponds to the JSON property `notificationConfig` + # @return [Google::Apis::HealthcareV1::NotificationConfig] + attr_accessor :notification_config + + # A list of streaming configs that configure the destinations of streaming + # export for every resource mutation in this FHIR store. Each store is + # allowed to have up to 10 streaming configs. + # After a new config is added, the next resource mutation is streamed to + # the new location in addition to the existing ones. + # When a location is removed from the list, the server stops + # streaming to that location. Before adding a new config, you must add the + # required + # [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control# + # bigquery.dataEditor) + # role to your project's **Cloud Healthcare Service Agent** + # [service account](https://cloud.google.com/iam/docs/service-accounts). + # Some lag (typically on the order of dozens of seconds) is expected before + # the results show up in the streaming destination. + # Corresponds to the JSON property `streamConfigs` + # @return [Array] + attr_accessor :stream_configs + + # The FHIR specification version that this FHIR store supports natively. This + # field is immutable after store creation. Requests are rejected if they + # contain FHIR resources of a different version. + # An empty value is treated as STU3. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @disable_referential_integrity = args[:disable_referential_integrity] if args.key?(:disable_referential_integrity) + @disable_resource_versioning = args[:disable_resource_versioning] if args.key?(:disable_resource_versioning) + @enable_update_create = args[:enable_update_create] if args.key?(:enable_update_create) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @notification_config = args[:notification_config] if args.key?(:notification_config) + @stream_configs = args[:stream_configs] if args.key?(:stream_configs) + @version = args[:version] if args.key?(:version) + end + end + + # Specifies FHIR paths to match, and how to handle de-identification of + # matching fields. + class FieldMetadata + include Google::Apis::Core::Hashable + + # Deidentify action for one field. + # Corresponds to the JSON property `action` + # @return [String] + attr_accessor :action + + # List of paths to FHIR fields to be redacted. Each path is a + # period-separated list where each component is either a field name or + # FHIR type name, for example: Patient, HumanName. + # For "choice" types (those defined in the FHIR spec with the form: + # field[x]) we use two separate components. For example, + # "deceasedAge.unit" is matched by "Deceased.Age.unit". + # Supported types are: AdministrativeGenderCode, Code, Date, DateTime, + # Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, + # Xhtml. + # Corresponds to the JSON property `paths` + # @return [Array] + attr_accessor :paths + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action = args[:action] if args.key?(:action) + @paths = args[:paths] if args.key?(:paths) + end + end + + # Contains a summary of the DeidentifyDicomStore operation. + class GoogleCloudHealthcareV1DeidentifyDeidentifyDicomStoreSummary + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Contains a summary of the DeidentifyFhirStore operation. + class GoogleCloudHealthcareV1DeidentifyDeidentifyFhirStoreSummary + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # The BigQuery table where the server writes the output. + class GoogleCloudHealthcareV1DicomBigQueryDestination + include Google::Apis::Core::Hashable + + # If the destination table already exists and this flag is `TRUE`, the table + # is overwritten by the contents of the DICOM store. If the flag is not + # set and the destination table already exists, the export call returns an + # error. + # Corresponds to the JSON property `force` + # @return [Boolean] + attr_accessor :force + alias_method :force?, :force + + # BigQuery URI to a table, up to 2000 characters long, in the format + # `bq://projectId.bqDatasetId.tableId` + # Corresponds to the JSON property `tableUri` + # @return [String] + attr_accessor :table_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @force = args[:force] if args.key?(:force) + @table_uri = args[:table_uri] if args.key?(:table_uri) + end + end + + # The Cloud Storage location where the server writes the output and the export + # configuration. + class GoogleCloudHealthcareV1DicomGcsDestination + include Google::Apis::Core::Hashable + + # MIME types supported by DICOM spec. + # Each file is written in the following format: + # `.../`study_id`/`series_id`/`instance_id`[/`frame_number`].`extension`` + # The frame_number component exists only for multi-frame instances. + # Supported MIME types are consistent with supported formats in DICOMweb: + # https://cloud.google.com/healthcare/docs/dicom#retrieve_transaction. + # Specifically, the following are supported: + # - application/dicom; transfer-syntax=1.2.840.10008.1.2.1 + # (uncompressed DICOM) + # - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.50 + # (DICOM with embedded JPEG Baseline) + # - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.90 + # (DICOM with embedded JPEG 2000 Lossless Only) + # - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.91 + # (DICOM with embedded JPEG 2000) + # - application/dicom; transfer-syntax=* + # (DICOM with no transcoding) + # - application/octet-stream; transfer-syntax=1.2.840.10008.1.2.1 + # (raw uncompressed PixelData) + # - application/octet-stream; transfer-syntax=* + # (raw PixelData in whatever format it was uploaded in) + # - image/jpeg; transfer-syntax=1.2.840.10008.1.2.4.50 + # (Consumer JPEG) + # - image/png + # The following extensions are used for output files: + # - application/dicom -> .dcm + # - image/jpeg -> .jpg + # - image/png -> .png + # - application/octet-stream -> no extension + # If unspecified, the instances are exported in the original + # DICOM format they were uploaded in. + # Corresponds to the JSON property `mimeType` + # @return [String] + attr_accessor :mime_type + + # The Cloud Storage destination to export to. + # URI for a Cloud Storage directory where the server writes the result files, + # in the format `gs://`bucket-id`/`path/to/destination/dir``). If there is no + # trailing slash, the service appends one when composing the object path. + # The user is responsible for creating the Cloud Storage bucket referenced in + # `uri_prefix`. + # Corresponds to the JSON property `uriPrefix` + # @return [String] + attr_accessor :uri_prefix + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @mime_type = args[:mime_type] if args.key?(:mime_type) + @uri_prefix = args[:uri_prefix] if args.key?(:uri_prefix) + end + end + + # Specifies the configuration for importing data from Cloud Storage. + class GoogleCloudHealthcareV1DicomGcsSource + include Google::Apis::Core::Hashable + + # Points to a Cloud Storage URI containing file(s) with + # content only. The URI must be in the following format: + # `gs://`bucket_id`/`object_id``. The URI can include wildcards in + # `object_id` and thus identify multiple files. Supported wildcards: + # '*' to match 0 or more non-separator characters + # '**' to match 0 or more characters (including separators). Must be used at + # the end of a path and with no other wildcards in the + # path. Can also be used with a file extension (such as .dcm), which + # imports all files with the extension in the specified directory and + # its sub-directories. For example, + # `gs://my-bucket/my-directory/**.dcm` imports all files with .dcm + # extensions in `my-directory/` and its sub-directories. + # '?' to match 1 character + # All other URI formats are invalid. + # Files matching the wildcard are expected to contain content only, no + # metadata. + # Corresponds to the JSON property `uri` + # @return [String] + attr_accessor :uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @uri = args[:uri] if args.key?(:uri) + end + end + + # The configuration for exporting to BigQuery. + class GoogleCloudHealthcareV1FhirBigQueryDestination + include Google::Apis::Core::Hashable + + # BigQuery URI to a dataset, up to 2000 characters long, in the format + # `bq://projectId.bqDatasetId` + # Corresponds to the JSON property `datasetUri` + # @return [String] + attr_accessor :dataset_uri + + # If this flag is `TRUE`, all tables will be deleted from the dataset before + # the new exported tables are written. If the flag is not set and the + # destination dataset contains tables, the export call returns an error. + # Corresponds to the JSON property `force` + # @return [Boolean] + attr_accessor :force + alias_method :force?, :force + + # Configuration for the FHIR BigQuery schema. Determines how the server + # generates the schema. + # Corresponds to the JSON property `schemaConfig` + # @return [Google::Apis::HealthcareV1::SchemaConfig] + attr_accessor :schema_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dataset_uri = args[:dataset_uri] if args.key?(:dataset_uri) + @force = args[:force] if args.key?(:force) + @schema_config = args[:schema_config] if args.key?(:schema_config) + end + end + + # The configuration for exporting to Cloud Storage. + class GoogleCloudHealthcareV1FhirGcsDestination + include Google::Apis::Core::Hashable + + # URI for a Cloud Storage directory where result files should be written (in + # the format `gs://`bucket-id`/`path/to/destination/dir``). If there is no + # trailing slash, the service will append one when composing the object path. + # The user is responsible for creating the Cloud Storage bucket referenced in + # `uri_prefix`. + # Corresponds to the JSON property `uriPrefix` + # @return [String] + attr_accessor :uri_prefix + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @uri_prefix = args[:uri_prefix] if args.key?(:uri_prefix) + end + end + + # Specifies the configuration for importing data from Cloud Storage. + class GoogleCloudHealthcareV1FhirGcsSource + include Google::Apis::Core::Hashable + + # Points to a Cloud Storage URI containing file(s) to import. + # The URI must be in the following format: `gs://`bucket_id`/`object_id``. + # The URI can include wildcards in `object_id` and thus identify multiple + # files. Supported wildcards: + # * `*` to match 0 or more non-separator characters + # * `**` to match 0 or more characters (including separators). Must be used + # at the end of a path and with no other wildcards in the + # path. Can also be used with a file extension (such as .ndjson), which + # imports all files with the extension in the specified directory and + # its sub-directories. For example, `gs://my-bucket/my-directory/**.ndjson` + # imports all files with `.ndjson` extensions in `my-directory/` and its + # sub-directories. + # * `?` to match 1 character + # Files matching the wildcard are expected to contain content only, no + # metadata. + # Corresponds to the JSON property `uri` + # @return [String] + attr_accessor :uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @uri = args[:uri] if args.key?(:uri) + end + end + + # Specifies where and whether to send notifications upon changes to a + # data store. + class Hl7V2NotificationConfig + include Google::Apis::Core::Hashable + + # Restricts notifications sent for messages matching a filter. If this is + # empty, all messages are matched. Syntax: + # https://cloud.google.com/appengine/docs/standard/python/search/query_strings + # Fields/functions available for filtering are: + # * `message_type`, from the MSH-9.1 field. For example, + # `NOT message_type = "ADT"`. + # * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in + # the dataset's time_zone, from the MSH-7 segment. For example, + # `send_date < "2017-01-02"`. + # * `send_time`, the timestamp when the message was sent, using the + # RFC3339 time format for comparisons, from the MSH-7 segment. For example, + # `send_time < "2017-01-02T00:00:00-05:00"`. + # * `send_facility`, the care center that the message came from, from the + # MSH-4 segment. For example, `send_facility = "ABC"`. + # * `PatientId(value, type)`, which matches if the message lists a patient + # having an ID of the given value and type in the PID-2, PID-3, or PID-4 + # segments. For example, `PatientId("123456", "MRN")`. + # * `labels.x`, a string value of the label with key `x` as set using the + # Message.labels + # map. For example, `labels."priority"="high"`. The operator `:*` can be + # used to assert the existence of a label. For example, + # `labels."priority":*`. + # Corresponds to the JSON property `filter` + # @return [String] + attr_accessor :filter + + # The [Cloud Pubsub](https://cloud.google.com/pubsub/docs/) topic that + # notifications of changes are published on. Supplied by the client. The + # notification is a `PubsubMessage` with the following fields: + # * `PubsubMessage.Data` contains the resource name. + # * `PubsubMessage.MessageId` is the ID of this notification. It is + # guaranteed to be unique within the topic. + # * `PubsubMessage.PublishTime` is the time at which the message was + # published. + # Note that notifications are only sent if the topic is non-empty. [Topic + # names](https://cloud.google.com/pubsub/docs/overview#names) must be + # scoped to a project. cloud-healthcare@system.gserviceaccount.com must + # have publisher permissions on the given Pubsub topic. Not having adequate + # permissions causes the calls that send notifications to fail. + # If a notification cannot be published to Cloud Pub/Sub, errors will be + # logged to Stackdriver (see [Viewing logs](/healthcare/docs/how- + # tos/stackdriver-logging)). + # Corresponds to the JSON property `pubsubTopic` + # @return [String] + attr_accessor :pubsub_topic + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @filter = args[:filter] if args.key?(:filter) + @pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic) + end + end + + # Represents an HL7v2 store. + class Hl7V2Store + include Google::Apis::Core::Hashable + + # User-supplied key-value pairs used to organize HL7v2 stores. + # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding + # of maximum 128 bytes, and must conform to the + # following PCRE regular expression: + # \p`Ll`\p`Lo``0,62` + # Label values are optional, must be between 1 and 63 characters long, have + # a UTF-8 encoding of maximum 128 bytes, and must conform to the + # following PCRE regular expression: [\p`Ll`\p`Lo`\p`N`_-]`0,63` + # No more than 64 labels can be associated with a given store. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Output only. Resource name of the HL7v2 store, of the form + # `projects/`project_id`/datasets/`dataset_id`/hl7V2Stores/`hl7v2_store_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # A list of notification configs. Each configuration uses a filter to + # determine whether to publish a message (both Ingest & Create) on + # the corresponding notification destination. Only the message name is sent + # as part of the notification. Supplied by the client. + # Corresponds to the JSON property `notificationConfigs` + # @return [Array] + attr_accessor :notification_configs + + # The configuration for the parser. It determines how the server parses the + # messages. + # Corresponds to the JSON property `parserConfig` + # @return [Google::Apis::HealthcareV1::ParserConfig] + attr_accessor :parser_config + + # Determines whether duplicate messages should be rejected. A duplicate + # message is a message with the same raw bytes as a message that has already + # been ingested/created in this HL7v2 store. + # The default value is false, meaning that the store accepts the duplicate + # messages and it also returns the same ACK message in the + # IngestMessageResponse as has been returned previously. Note that only + # one resource is created in the store. + # When this field is set to true, + # CreateMessage/IngestMessage + # requests with a duplicate message will be rejected by the store, and + # IngestMessageErrorDetail returns a NACK message upon rejection. + # Corresponds to the JSON property `rejectDuplicateMessage` + # @return [Boolean] + attr_accessor :reject_duplicate_message + alias_method :reject_duplicate_message?, :reject_duplicate_message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @notification_configs = args[:notification_configs] if args.key?(:notification_configs) + @parser_config = args[:parser_config] if args.key?(:parser_config) + @reject_duplicate_message = args[:reject_duplicate_message] if args.key?(:reject_duplicate_message) + end + end + + # Message that represents an arbitrary HTTP body. It should only be used for + # payload formats that can't be represented as JSON, such as raw binary or + # an HTML page. + # This message can be used both in streaming and non-streaming API methods in + # the request as well as the response. + # It can be used as a top-level request field, which is convenient if one + # wants to extract parameters from either the URL or HTTP template into the + # request fields and also want access to the raw HTTP body. + # Example: + # message GetResourceRequest ` + # // A unique request id. + # string request_id = 1; + # // The raw HTTP body is bound to this field. + # google.api.HttpBody http_body = 2; + # ` + # service ResourceService ` + # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); + # rpc UpdateResource(google.api.HttpBody) returns + # (google.protobuf.Empty); + # ` + # Example with streaming methods: + # service CaldavService ` + # rpc GetCalendar(stream google.api.HttpBody) + # returns (stream google.api.HttpBody); + # rpc UpdateCalendar(stream google.api.HttpBody) + # returns (stream google.api.HttpBody); + # ` + # Use of this type only changes how the request and response bodies are + # handled, all other features will continue to work unchanged. + class HttpBody + include Google::Apis::Core::Hashable + + # The HTTP Content-Type header value specifying the content type of the body. + # Corresponds to the JSON property `contentType` + # @return [String] + attr_accessor :content_type + + # The HTTP request/response body as raw binary. + # Corresponds to the JSON property `data` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :data + + # Application specific response metadata. Must be set in the first response + # for streaming APIs. + # Corresponds to the JSON property `extensions` + # @return [Array>] + attr_accessor :extensions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content_type = args[:content_type] if args.key?(:content_type) + @data = args[:data] if args.key?(:data) + @extensions = args[:extensions] if args.key?(:extensions) + end + end + + # Specifies how to handle de-identification of image pixels. + class ImageConfig + include Google::Apis::Core::Hashable + + # Determines how to redact text from image. + # Corresponds to the JSON property `textRedactionMode` + # @return [String] + attr_accessor :text_redaction_mode + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @text_redaction_mode = args[:text_redaction_mode] if args.key?(:text_redaction_mode) + end + end + + # Imports data into the specified DICOM store. + # Returns an error if any of the files to import are not DICOM files. This + # API accepts duplicate DICOM instances by ignoring the newly-pushed instance. + # It does not overwrite. + class ImportDicomDataRequest + include Google::Apis::Core::Hashable + + # Specifies the configuration for importing data from Cloud Storage. + # Corresponds to the JSON property `gcsSource` + # @return [Google::Apis::HealthcareV1::GoogleCloudHealthcareV1DicomGcsSource] + attr_accessor :gcs_source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @gcs_source = args[:gcs_source] if args.key?(:gcs_source) + end + end + + # Returns additional information in regards to a completed DICOM store import. + class ImportDicomDataResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Request to import resources. + class ImportResourcesRequest + include Google::Apis::Core::Hashable + + # The content structure in the source location. If not specified, the server + # treats the input source files as BUNDLE. + # Corresponds to the JSON property `contentStructure` + # @return [String] + attr_accessor :content_structure + + # Specifies the configuration for importing data from Cloud Storage. + # Corresponds to the JSON property `gcsSource` + # @return [Google::Apis::HealthcareV1::GoogleCloudHealthcareV1FhirGcsSource] + attr_accessor :gcs_source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content_structure = args[:content_structure] if args.key?(:content_structure) + @gcs_source = args[:gcs_source] if args.key?(:gcs_source) + end + end + + # Final response of importing resources. + # This structure will be included in the + # response to describe the detailed + # outcome. It will only be included when the operation finishes successfully. + class ImportResourcesResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # A transformation to apply to text that is identified as a specific + # info_type. + class InfoTypeTransformation + include Google::Apis::Core::Hashable + + # Mask a string by replacing its characters with a fixed character. + # Corresponds to the JSON property `characterMaskConfig` + # @return [Google::Apis::HealthcareV1::CharacterMaskConfig] + attr_accessor :character_mask_config + + # Pseudonymization method that generates surrogates via cryptographic hashing. + # Uses SHA-256. + # Outputs a base64-encoded representation of the hashed output + # (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). + # Corresponds to the JSON property `cryptoHashConfig` + # @return [Google::Apis::HealthcareV1::CryptoHashConfig] + attr_accessor :crypto_hash_config + + # Shift a date forward or backward in time by a random amount which is + # consistent for a given patient and crypto key combination. + # Corresponds to the JSON property `dateShiftConfig` + # @return [Google::Apis::HealthcareV1::DateShiftConfig] + attr_accessor :date_shift_config + + # InfoTypes to apply this transformation to. If this is not specified, the + # transformation applies to any info_type. + # Corresponds to the JSON property `infoTypes` + # @return [Array] + attr_accessor :info_types + + # Define how to redact sensitive values. Default behaviour is erase. + # For example, "My name is Jane." becomes "My name is ." + # Corresponds to the JSON property `redactConfig` + # @return [Google::Apis::HealthcareV1::RedactConfig] + attr_accessor :redact_config + + # When using the + # INSPECT_AND_TRANSFORM + # action, each match is replaced with the name of the info_type. For example, + # "My name is Jane" becomes "My name is [PERSON_NAME]." The + # TRANSFORM + # action is equivalent to redacting. + # Corresponds to the JSON property `replaceWithInfoTypeConfig` + # @return [Google::Apis::HealthcareV1::ReplaceWithInfoTypeConfig] + attr_accessor :replace_with_info_type_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @character_mask_config = args[:character_mask_config] if args.key?(:character_mask_config) + @crypto_hash_config = args[:crypto_hash_config] if args.key?(:crypto_hash_config) + @date_shift_config = args[:date_shift_config] if args.key?(:date_shift_config) + @info_types = args[:info_types] if args.key?(:info_types) + @redact_config = args[:redact_config] if args.key?(:redact_config) + @replace_with_info_type_config = args[:replace_with_info_type_config] if args.key?(:replace_with_info_type_config) + end + end + + # Ingests a message into the specified HL7v2 store. + class IngestMessageRequest + include Google::Apis::Core::Hashable + + # A complete HL7v2 message. + # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details + # on the standard. + # Corresponds to the JSON property `message` + # @return [Google::Apis::HealthcareV1::Message] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @message = args[:message] if args.key?(:message) + end + end + + # Acknowledges that a message has been ingested into the specified + # HL7v2 store. + class IngestMessageResponse + include Google::Apis::Core::Hashable + + # HL7v2 ACK message. + # Corresponds to the JSON property `hl7Ack` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :hl7_ack + + # A complete HL7v2 message. + # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details + # on the standard. + # Corresponds to the JSON property `message` + # @return [Google::Apis::HealthcareV1::Message] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @hl7_ack = args[:hl7_ack] if args.key?(:hl7_ack) + @message = args[:message] if args.key?(:message) + end + end + + # Lists the available datasets. + class ListDatasetsResponse + include Google::Apis::Core::Hashable + + # The first page of datasets. + # Corresponds to the JSON property `datasets` + # @return [Array] + attr_accessor :datasets + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # 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) + @datasets = args[:datasets] if args.key?(:datasets) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Lists the DICOM stores in the given dataset. + class ListDicomStoresResponse + include Google::Apis::Core::Hashable + + # The returned DICOM stores. Won't be more DICOM stores than the value of + # page_size in the request. + # Corresponds to the JSON property `dicomStores` + # @return [Array] + attr_accessor :dicom_stores + + # Token to retrieve the next page of results or empty if there are no more + # results in the list. + # 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) + @dicom_stores = args[:dicom_stores] if args.key?(:dicom_stores) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Lists the FHIR stores in the given dataset. + class ListFhirStoresResponse + include Google::Apis::Core::Hashable + + # The returned FHIR stores. Won't be more FHIR stores than the value of + # page_size in the request. + # Corresponds to the JSON property `fhirStores` + # @return [Array] + attr_accessor :fhir_stores + + # Token to retrieve the next page of results or empty if there are no more + # results in the list. + # 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) + @fhir_stores = args[:fhir_stores] if args.key?(:fhir_stores) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Lists the HL7v2 stores in the given dataset. + class ListHl7V2StoresResponse + include Google::Apis::Core::Hashable + + # The returned HL7v2 stores. Won't be more HL7v2 stores than the value of + # page_size in the request. + # Corresponds to the JSON property `hl7V2Stores` + # @return [Array] + attr_accessor :hl7_v2_stores + + # Token to retrieve the next page of results or empty if there are no more + # results in the list. + # 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) + @hl7_v2_stores = args[:hl7_v2_stores] if args.key?(:hl7_v2_stores) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Lists the messages in the specified HL7v2 store. + class ListMessagesResponse + include Google::Apis::Core::Hashable + + # The returned Messages. Won't be more Messages than the value of + # page_size in the request. See + # view for + # populated fields. + # Corresponds to the JSON property `hl7V2Messages` + # @return [Array] + attr_accessor :hl7_v2_messages + + # Token to retrieve the next page of results or empty if there are no more + # results in the list. + # 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) + @hl7_v2_messages = args[:hl7_v2_messages] if args.key?(:hl7_v2_messages) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # The response message for Operations.ListOperations. + class ListOperationsResponse + 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] + 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 complete HL7v2 message. + # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details + # on the standard. + class Message + include Google::Apis::Core::Hashable + + # Output only. The datetime when the message was created. Set by the server. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Raw message bytes. + # Corresponds to the JSON property `data` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :data + + # User-supplied key-value pairs used to organize HL7v2 stores. + # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding + # of maximum 128 bytes, and must conform to the + # following PCRE regular expression: + # \p`Ll`\p`Lo``0,62` + # Label values are optional, must be between 1 and 63 characters long, have + # a UTF-8 encoding of maximum 128 bytes, and must conform to the + # following PCRE regular expression: [\p`Ll`\p`Lo`\p`N`_-]`0,63` + # No more than 64 labels can be associated with a given store. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # The message type for this message. MSH-9.1. + # Corresponds to the JSON property `messageType` + # @return [String] + attr_accessor :message_type + + # Resource name of the Message, of the form + # `projects/`project_id`/datasets/`dataset_id`/hl7V2Stores/`hl7_v2_store_id`/ + # messages/`message_id``. + # Assigned by the server. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The content of a HL7v2 message in a structured format. + # Corresponds to the JSON property `parsedData` + # @return [Google::Apis::HealthcareV1::ParsedData] + attr_accessor :parsed_data + + # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this + # message. + # Corresponds to the JSON property `patientIds` + # @return [Array] + attr_accessor :patient_ids + + # The hospital that this message came from. MSH-4. + # Corresponds to the JSON property `sendFacility` + # @return [String] + attr_accessor :send_facility + + # The datetime the sending application sent this message. MSH-7. + # Corresponds to the JSON property `sendTime` + # @return [String] + attr_accessor :send_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) + @data = args[:data] if args.key?(:data) + @labels = args[:labels] if args.key?(:labels) + @message_type = args[:message_type] if args.key?(:message_type) + @name = args[:name] if args.key?(:name) + @parsed_data = args[:parsed_data] if args.key?(:parsed_data) + @patient_ids = args[:patient_ids] if args.key?(:patient_ids) + @send_facility = args[:send_facility] if args.key?(:send_facility) + @send_time = args[:send_time] if args.key?(:send_time) + end + end + + # Specifies where to send notifications upon changes to a data store. + class NotificationConfig + include Google::Apis::Core::Hashable + + # The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that + # notifications of changes are published on. Supplied by the client. + # PubsubMessage.Data contains the resource name. + # PubsubMessage.MessageId is the ID of this message. It is guaranteed to be + # unique within the topic. + # PubsubMessage.PublishTime is the time at which the message was published. + # Notifications are only sent if the topic is + # non-empty. [Topic + # names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped + # to a project. cloud-healthcare@system.gserviceaccount.com must have + # publisher permissions on the given Cloud Pub/Sub topic. Not having adequate + # permissions causes the calls that send notifications to fail. + # If a notification can't be published to Cloud Pub/Sub, errors are logged to + # Stackdriver (see [Viewing + # logs](/healthcare/docs/how-tos/stackdriver-logging)). If the number of + # errors exceeds a certain rate, some aren't submitted. + # Corresponds to the JSON property `pubsubTopic` + # @return [String] + attr_accessor :pubsub_topic + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + class Operation + 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::HealthcareV1::Status] + 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] + 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] + 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 + + # OperationMetadata provides information about the operation execution. + # Returned in the long-running operation's metadata field. + class OperationMetadata + include Google::Apis::Core::Hashable + + # The name of the API method that initiated the operation. + # Corresponds to the JSON property `apiMethodName` + # @return [String] + attr_accessor :api_method_name + + # Specifies if cancellation was requested for the operation. + # Corresponds to the JSON property `cancelRequested` + # @return [Boolean] + attr_accessor :cancel_requested + alias_method :cancel_requested?, :cancel_requested + + # ProgressCounter provides counters to describe an operation's progress. + # Corresponds to the JSON property `counter` + # @return [Google::Apis::HealthcareV1::ProgressCounter] + attr_accessor :counter + + # The time at which the operation was created by the API. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # The time at which execution was completed. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # A link to audit and error logs in the log viewer. Error logs are generated + # only by some operations, listed at + # https://cloud.google.com/healthcare/docs/how-tos/stackdriver-logging. + # Corresponds to the JSON property `logsUrl` + # @return [String] + attr_accessor :logs_url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_method_name = args[:api_method_name] if args.key?(:api_method_name) + @cancel_requested = args[:cancel_requested] if args.key?(:cancel_requested) + @counter = args[:counter] if args.key?(:counter) + @create_time = args[:create_time] if args.key?(:create_time) + @end_time = args[:end_time] if args.key?(:end_time) + @logs_url = args[:logs_url] if args.key?(:logs_url) + end + end + + # The content of a HL7v2 message in a structured format. + class ParsedData + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `segments` + # @return [Array] + attr_accessor :segments + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @segments = args[:segments] if args.key?(:segments) + end + end + + # The configuration for the parser. It determines how the server parses the + # messages. + class ParserConfig + include Google::Apis::Core::Hashable + + # Determines whether messages with no header are allowed. + # Corresponds to the JSON property `allowNullHeader` + # @return [Boolean] + attr_accessor :allow_null_header + alias_method :allow_null_header?, :allow_null_header + + # Byte(s) to use as the segment terminator. If this is unset, '\r' is + # used as segment terminator. + # Corresponds to the JSON property `segmentTerminator` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :segment_terminator + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allow_null_header = args[:allow_null_header] if args.key?(:allow_null_header) + @segment_terminator = args[:segment_terminator] if args.key?(:segment_terminator) + end + end + + # A patient identifier and associated type. + class PatientId + include Google::Apis::Core::Hashable + + # ID type. For example, MRN or NHS. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # The patient's unique identifier. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @type = args[:type] if args.key?(:type) + @value = args[:value] if args.key?(:value) + 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. + # Optionally, a `binding` can 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. + # **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 Policy + include Google::Apis::Core::Hashable + + # Specifies cloud audit logging configuration for this policy. + # Corresponds to the JSON property `auditConfigs` + # @return [Array] + 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] + 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. + # 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 + + # ProgressCounter provides counters to describe an operation's progress. + class ProgressCounter + include Google::Apis::Core::Hashable + + # The number of units that failed in the operation. + # Corresponds to the JSON property `failure` + # @return [Fixnum] + attr_accessor :failure + + # The number of units that are pending in the operation. + # Corresponds to the JSON property `pending` + # @return [Fixnum] + attr_accessor :pending + + # The number of units that succeeded in the operation. + # Corresponds to the JSON property `success` + # @return [Fixnum] + attr_accessor :success + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @failure = args[:failure] if args.key?(:failure) + @pending = args[:pending] if args.key?(:pending) + @success = args[:success] if args.key?(:success) + end + end + + # Define how to redact sensitive values. Default behaviour is erase. + # For example, "My name is Jane." becomes "My name is ." + class RedactConfig + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # When using the + # INSPECT_AND_TRANSFORM + # action, each match is replaced with the name of the info_type. For example, + # "My name is Jane" becomes "My name is [PERSON_NAME]." The + # TRANSFORM + # action is equivalent to redacting. + class ReplaceWithInfoTypeConfig + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # A list of FHIR resources. + class Resources + include Google::Apis::Core::Hashable + + # List of resources IDs. For example, "Patient/1234". + # Corresponds to the JSON property `resources` + # @return [Array] + attr_accessor :resources + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resources = args[:resources] if args.key?(:resources) + end + end + + # Configuration for the FHIR BigQuery schema. Determines how the server + # generates the schema. + class SchemaConfig + include Google::Apis::Core::Hashable + + # The depth for all recursive structures in the output analytics + # schema. For example, `concept` in the CodeSystem resource is a recursive + # structure; when the depth is 2, the CodeSystem table will have a column + # called `concept.concept` but not `concept.concept.concept`. If not + # specified or set to 0, the server will use the default value 2. The + # maximum depth allowed is 5. + # Corresponds to the JSON property `recursiveStructureDepth` + # @return [Fixnum] + attr_accessor :recursive_structure_depth + + # Specifies the output schema type. + # Corresponds to the JSON property `schemaType` + # @return [String] + attr_accessor :schema_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @recursive_structure_depth = args[:recursive_structure_depth] if args.key?(:recursive_structure_depth) + @schema_type = args[:schema_type] if args.key?(:schema_type) + end + end + + # Request to search the resources in the specified FHIR store. + class SearchResourcesRequest + include Google::Apis::Core::Hashable + + # The FHIR resource type to search, such as Patient or Observation. For a + # complete list, see the FHIR Resource Index + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), + # [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + # Corresponds to the JSON property `resourceType` + # @return [String] + attr_accessor :resource_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_type = args[:resource_type] if args.key?(:resource_type) + end + end + + # A segment in a structured format. + class Segment + include Google::Apis::Core::Hashable + + # A mapping from the positional location to the value. + # The key string uses zero-based indexes separated by dots to identify + # Fields, components and sub-components. A bracket notation is also used to + # identify different instances of a repeated field. + # Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)? + # Examples of (key, value) pairs: + # * (0.1, "hemoglobin") denotes that the first component of Field 0 has the + # value "hemoglobin". + # * (1.1.2, "CBC") denotes that the second sub-component of the first + # component of Field 1 has the value "CBC". + # * (1[0].1, "HbA1c") denotes that the first component of the + # first Instance of Field 1, which is repeated, has the value "HbA1c". + # Corresponds to the JSON property `fields` + # @return [Hash] + attr_accessor :fields + + # A string that indicates the type of segment. For example, EVN or PID. + # Corresponds to the JSON property `segmentId` + # @return [String] + attr_accessor :segment_id + + # Set ID for segments that can be in a set. This can be empty if it's + # missing or isn't applicable. + # Corresponds to the JSON property `setId` + # @return [String] + attr_accessor :set_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fields = args[:fields] if args.key?(:fields) + @segment_id = args[:segment_id] if args.key?(:segment_id) + @set_id = args[:set_id] if args.key?(:set_id) + end + end + + # Request message for `SetIamPolicy` method. + class SetIamPolicyRequest + 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. + # Optionally, a `binding` can 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. + # **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::HealthcareV1::Policy] + 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" + # This field is only used by Cloud IAM. + # 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 Status + 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>] + 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 + + # This structure contains configuration for streaming FHIR export. + class StreamConfig + include Google::Apis::Core::Hashable + + # The configuration for exporting to BigQuery. + # Corresponds to the JSON property `bigqueryDestination` + # @return [Google::Apis::HealthcareV1::GoogleCloudHealthcareV1FhirBigQueryDestination] + attr_accessor :bigquery_destination + + # Supply a FHIR resource type (such as "Patient" or "Observation"). + # See https://www.hl7.org/fhir/valueset-resource-types.html for a list of + # all FHIR resource types. + # The server treats an empty list as an intent to stream all the + # supported resource types in this FHIR store. + # Corresponds to the JSON property `resourceTypes` + # @return [Array] + attr_accessor :resource_types + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bigquery_destination = args[:bigquery_destination] if args.key?(:bigquery_destination) + @resource_types = args[:resource_types] if args.key?(:resource_types) + end + end + + # List of tags to be filtered. + class TagFilterList + include Google::Apis::Core::Hashable + + # Tags to be filtered. Tags must be DICOM Data Elements, File Meta + # Elements, or Directory Structuring Elements, as defined at: + # http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. + # They may be provided by "Keyword" or "Tag". For example "PatientID", + # "00100010". + # Corresponds to the JSON property `tags` + # @return [Array] + attr_accessor :tags + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @tags = args[:tags] if args.key?(:tags) + end + end + + # Request message for `TestIamPermissions` method. + class TestIamPermissionsRequest + 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] + 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 TestIamPermissionsResponse + include Google::Apis::Core::Hashable + + # A subset of `TestPermissionsRequest.permissions` that the caller is + # allowed. + # Corresponds to the JSON property `permissions` + # @return [Array] + 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 + + # + class TextConfig + include Google::Apis::Core::Hashable + + # The transformations to apply to the detected data. + # Corresponds to the JSON property `transformations` + # @return [Array] + attr_accessor :transformations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @transformations = args[:transformations] if args.key?(:transformations) + end + end + end + end +end diff --git a/generated/google/apis/healthcare_v1/representations.rb b/generated/google/apis/healthcare_v1/representations.rb new file mode 100644 index 000000000..920766374 --- /dev/null +++ b/generated/google/apis/healthcare_v1/representations.rb @@ -0,0 +1,1114 @@ +# Copyright 2015 Google Inc. +# +# 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 HealthcareV1 + + class AuditConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuditLogConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Binding + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CancelOperationRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CharacterMaskConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreateMessageRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CryptoHashConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Dataset + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DateShiftConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeidentifyConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeidentifyDatasetRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeidentifyDicomStoreRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeidentifyFhirStoreRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeidentifySummary + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DicomConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DicomFilterConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DicomStore + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExportDicomDataRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExportDicomDataResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExportResourcesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExportResourcesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Expr + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FhirConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FhirFilter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FhirStore + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FieldMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1DeidentifyDeidentifyDicomStoreSummary + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1DeidentifyDeidentifyFhirStoreSummary + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1DicomBigQueryDestination + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1DicomGcsDestination + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1DicomGcsSource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1FhirBigQueryDestination + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1FhirGcsDestination + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudHealthcareV1FhirGcsSource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Hl7V2NotificationConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Hl7V2Store + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class HttpBody + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ImageConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ImportDicomDataRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ImportDicomDataResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ImportResourcesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ImportResourcesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InfoTypeTransformation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IngestMessageRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IngestMessageResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListDatasetsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListDicomStoresResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListFhirStoresResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListHl7V2StoresResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListMessagesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListOperationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Message + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NotificationConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Operation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ParsedData + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ParserConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PatientId + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Policy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ProgressCounter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RedactConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ReplaceWithInfoTypeConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Resources + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SchemaConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SearchResourcesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Segment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SetIamPolicyRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Status + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class StreamConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TagFilterList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TestIamPermissionsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TestIamPermissionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TextConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuditConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::HealthcareV1::AuditLogConfig, decorator: Google::Apis::HealthcareV1::AuditLogConfig::Representation + + property :service, as: 'service' + end + end + + class AuditLogConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :exempted_members, as: 'exemptedMembers' + property :log_type, as: 'logType' + end + end + + class Binding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :condition, as: 'condition', class: Google::Apis::HealthcareV1::Expr, decorator: Google::Apis::HealthcareV1::Expr::Representation + + collection :members, as: 'members' + property :role, as: 'role' + end + end + + class CancelOperationRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class CharacterMaskConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :masking_character, as: 'maskingCharacter' + end + end + + class CreateMessageRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :message, as: 'message', class: Google::Apis::HealthcareV1::Message, decorator: Google::Apis::HealthcareV1::Message::Representation + + end + end + + class CryptoHashConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :crypto_key, :base64 => true, as: 'cryptoKey' + end + end + + class Dataset + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :time_zone, as: 'timeZone' + end + end + + class DateShiftConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :crypto_key, :base64 => true, as: 'cryptoKey' + end + end + + class DeidentifyConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dicom, as: 'dicom', class: Google::Apis::HealthcareV1::DicomConfig, decorator: Google::Apis::HealthcareV1::DicomConfig::Representation + + property :fhir, as: 'fhir', class: Google::Apis::HealthcareV1::FhirConfig, decorator: Google::Apis::HealthcareV1::FhirConfig::Representation + + property :image, as: 'image', class: Google::Apis::HealthcareV1::ImageConfig, decorator: Google::Apis::HealthcareV1::ImageConfig::Representation + + property :text, as: 'text', class: Google::Apis::HealthcareV1::TextConfig, decorator: Google::Apis::HealthcareV1::TextConfig::Representation + + end + end + + class DeidentifyDatasetRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :config, as: 'config', class: Google::Apis::HealthcareV1::DeidentifyConfig, decorator: Google::Apis::HealthcareV1::DeidentifyConfig::Representation + + property :destination_dataset, as: 'destinationDataset' + end + end + + class DeidentifyDicomStoreRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :config, as: 'config', class: Google::Apis::HealthcareV1::DeidentifyConfig, decorator: Google::Apis::HealthcareV1::DeidentifyConfig::Representation + + property :destination_store, as: 'destinationStore' + property :filter_config, as: 'filterConfig', class: Google::Apis::HealthcareV1::DicomFilterConfig, decorator: Google::Apis::HealthcareV1::DicomFilterConfig::Representation + + end + end + + class DeidentifyFhirStoreRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :config, as: 'config', class: Google::Apis::HealthcareV1::DeidentifyConfig, decorator: Google::Apis::HealthcareV1::DeidentifyConfig::Representation + + property :destination_store, as: 'destinationStore' + property :resource_filter, as: 'resourceFilter', class: Google::Apis::HealthcareV1::FhirFilter, decorator: Google::Apis::HealthcareV1::FhirFilter::Representation + + end + end + + class DeidentifySummary + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class DicomConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :filter_profile, as: 'filterProfile' + property :keep_list, as: 'keepList', class: Google::Apis::HealthcareV1::TagFilterList, decorator: Google::Apis::HealthcareV1::TagFilterList::Representation + + property :remove_list, as: 'removeList', class: Google::Apis::HealthcareV1::TagFilterList, decorator: Google::Apis::HealthcareV1::TagFilterList::Representation + + property :skip_id_redaction, as: 'skipIdRedaction' + end + end + + class DicomFilterConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :resource_paths_gcs_uri, as: 'resourcePathsGcsUri' + end + end + + class DicomStore + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :labels, as: 'labels' + property :name, as: 'name' + property :notification_config, as: 'notificationConfig', class: Google::Apis::HealthcareV1::NotificationConfig, decorator: Google::Apis::HealthcareV1::NotificationConfig::Representation + + end + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class ExportDicomDataRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bigquery_destination, as: 'bigqueryDestination', class: Google::Apis::HealthcareV1::GoogleCloudHealthcareV1DicomBigQueryDestination, decorator: Google::Apis::HealthcareV1::GoogleCloudHealthcareV1DicomBigQueryDestination::Representation + + property :gcs_destination, as: 'gcsDestination', class: Google::Apis::HealthcareV1::GoogleCloudHealthcareV1DicomGcsDestination, decorator: Google::Apis::HealthcareV1::GoogleCloudHealthcareV1DicomGcsDestination::Representation + + end + end + + class ExportDicomDataResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class ExportResourcesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bigquery_destination, as: 'bigqueryDestination', class: Google::Apis::HealthcareV1::GoogleCloudHealthcareV1FhirBigQueryDestination, decorator: Google::Apis::HealthcareV1::GoogleCloudHealthcareV1FhirBigQueryDestination::Representation + + property :gcs_destination, as: 'gcsDestination', class: Google::Apis::HealthcareV1::GoogleCloudHealthcareV1FhirGcsDestination, decorator: Google::Apis::HealthcareV1::GoogleCloudHealthcareV1FhirGcsDestination::Representation + + end + end + + class ExportResourcesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class Expr + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :expression, as: 'expression' + property :location, as: 'location' + property :title, as: 'title' + end + end + + class FhirConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :field_metadata_list, as: 'fieldMetadataList', class: Google::Apis::HealthcareV1::FieldMetadata, decorator: Google::Apis::HealthcareV1::FieldMetadata::Representation + + end + end + + class FhirFilter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :resources, as: 'resources', class: Google::Apis::HealthcareV1::Resources, decorator: Google::Apis::HealthcareV1::Resources::Representation + + end + end + + class FhirStore + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :disable_referential_integrity, as: 'disableReferentialIntegrity' + property :disable_resource_versioning, as: 'disableResourceVersioning' + property :enable_update_create, as: 'enableUpdateCreate' + hash :labels, as: 'labels' + property :name, as: 'name' + property :notification_config, as: 'notificationConfig', class: Google::Apis::HealthcareV1::NotificationConfig, decorator: Google::Apis::HealthcareV1::NotificationConfig::Representation + + collection :stream_configs, as: 'streamConfigs', class: Google::Apis::HealthcareV1::StreamConfig, decorator: Google::Apis::HealthcareV1::StreamConfig::Representation + + property :version, as: 'version' + end + end + + class FieldMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action, as: 'action' + collection :paths, as: 'paths' + end + end + + class GoogleCloudHealthcareV1DeidentifyDeidentifyDicomStoreSummary + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class GoogleCloudHealthcareV1DeidentifyDeidentifyFhirStoreSummary + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class GoogleCloudHealthcareV1DicomBigQueryDestination + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :force, as: 'force' + property :table_uri, as: 'tableUri' + end + end + + class GoogleCloudHealthcareV1DicomGcsDestination + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :mime_type, as: 'mimeType' + property :uri_prefix, as: 'uriPrefix' + end + end + + class GoogleCloudHealthcareV1DicomGcsSource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :uri, as: 'uri' + end + end + + class GoogleCloudHealthcareV1FhirBigQueryDestination + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dataset_uri, as: 'datasetUri' + property :force, as: 'force' + property :schema_config, as: 'schemaConfig', class: Google::Apis::HealthcareV1::SchemaConfig, decorator: Google::Apis::HealthcareV1::SchemaConfig::Representation + + end + end + + class GoogleCloudHealthcareV1FhirGcsDestination + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :uri_prefix, as: 'uriPrefix' + end + end + + class GoogleCloudHealthcareV1FhirGcsSource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :uri, as: 'uri' + end + end + + class Hl7V2NotificationConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :filter, as: 'filter' + property :pubsub_topic, as: 'pubsubTopic' + end + end + + class Hl7V2Store + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :labels, as: 'labels' + property :name, as: 'name' + collection :notification_configs, as: 'notificationConfigs', class: Google::Apis::HealthcareV1::Hl7V2NotificationConfig, decorator: Google::Apis::HealthcareV1::Hl7V2NotificationConfig::Representation + + property :parser_config, as: 'parserConfig', class: Google::Apis::HealthcareV1::ParserConfig, decorator: Google::Apis::HealthcareV1::ParserConfig::Representation + + property :reject_duplicate_message, as: 'rejectDuplicateMessage' + end + end + + class HttpBody + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content_type, as: 'contentType' + property :data, :base64 => true, as: 'data' + collection :extensions, as: 'extensions' + end + end + + class ImageConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :text_redaction_mode, as: 'textRedactionMode' + end + end + + class ImportDicomDataRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :gcs_source, as: 'gcsSource', class: Google::Apis::HealthcareV1::GoogleCloudHealthcareV1DicomGcsSource, decorator: Google::Apis::HealthcareV1::GoogleCloudHealthcareV1DicomGcsSource::Representation + + end + end + + class ImportDicomDataResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class ImportResourcesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content_structure, as: 'contentStructure' + property :gcs_source, as: 'gcsSource', class: Google::Apis::HealthcareV1::GoogleCloudHealthcareV1FhirGcsSource, decorator: Google::Apis::HealthcareV1::GoogleCloudHealthcareV1FhirGcsSource::Representation + + end + end + + class ImportResourcesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class InfoTypeTransformation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :character_mask_config, as: 'characterMaskConfig', class: Google::Apis::HealthcareV1::CharacterMaskConfig, decorator: Google::Apis::HealthcareV1::CharacterMaskConfig::Representation + + property :crypto_hash_config, as: 'cryptoHashConfig', class: Google::Apis::HealthcareV1::CryptoHashConfig, decorator: Google::Apis::HealthcareV1::CryptoHashConfig::Representation + + property :date_shift_config, as: 'dateShiftConfig', class: Google::Apis::HealthcareV1::DateShiftConfig, decorator: Google::Apis::HealthcareV1::DateShiftConfig::Representation + + collection :info_types, as: 'infoTypes' + property :redact_config, as: 'redactConfig', class: Google::Apis::HealthcareV1::RedactConfig, decorator: Google::Apis::HealthcareV1::RedactConfig::Representation + + property :replace_with_info_type_config, as: 'replaceWithInfoTypeConfig', class: Google::Apis::HealthcareV1::ReplaceWithInfoTypeConfig, decorator: Google::Apis::HealthcareV1::ReplaceWithInfoTypeConfig::Representation + + end + end + + class IngestMessageRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :message, as: 'message', class: Google::Apis::HealthcareV1::Message, decorator: Google::Apis::HealthcareV1::Message::Representation + + end + end + + class IngestMessageResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :hl7_ack, :base64 => true, as: 'hl7Ack' + property :message, as: 'message', class: Google::Apis::HealthcareV1::Message, decorator: Google::Apis::HealthcareV1::Message::Representation + + end + end + + class ListDatasetsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :datasets, as: 'datasets', class: Google::Apis::HealthcareV1::Dataset, decorator: Google::Apis::HealthcareV1::Dataset::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListDicomStoresResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dicom_stores, as: 'dicomStores', class: Google::Apis::HealthcareV1::DicomStore, decorator: Google::Apis::HealthcareV1::DicomStore::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListFhirStoresResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :fhir_stores, as: 'fhirStores', class: Google::Apis::HealthcareV1::FhirStore, decorator: Google::Apis::HealthcareV1::FhirStore::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListHl7V2StoresResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :hl7_v2_stores, as: 'hl7V2Stores', class: Google::Apis::HealthcareV1::Hl7V2Store, decorator: Google::Apis::HealthcareV1::Hl7V2Store::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListMessagesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :hl7_v2_messages, as: 'hl7V2Messages', class: Google::Apis::HealthcareV1::Message, decorator: Google::Apis::HealthcareV1::Message::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListOperationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :operations, as: 'operations', class: Google::Apis::HealthcareV1::Operation, decorator: Google::Apis::HealthcareV1::Operation::Representation + + end + end + + class Message + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :data, :base64 => true, as: 'data' + hash :labels, as: 'labels' + property :message_type, as: 'messageType' + property :name, as: 'name' + property :parsed_data, as: 'parsedData', class: Google::Apis::HealthcareV1::ParsedData, decorator: Google::Apis::HealthcareV1::ParsedData::Representation + + collection :patient_ids, as: 'patientIds', class: Google::Apis::HealthcareV1::PatientId, decorator: Google::Apis::HealthcareV1::PatientId::Representation + + property :send_facility, as: 'sendFacility' + property :send_time, as: 'sendTime' + end + end + + class NotificationConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :pubsub_topic, as: 'pubsubTopic' + end + end + + class Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::HealthcareV1::Status, decorator: Google::Apis::HealthcareV1::Status::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class OperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :api_method_name, as: 'apiMethodName' + property :cancel_requested, as: 'cancelRequested' + property :counter, as: 'counter', class: Google::Apis::HealthcareV1::ProgressCounter, decorator: Google::Apis::HealthcareV1::ProgressCounter::Representation + + property :create_time, as: 'createTime' + property :end_time, as: 'endTime' + property :logs_url, as: 'logsUrl' + end + end + + class ParsedData + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :segments, as: 'segments', class: Google::Apis::HealthcareV1::Segment, decorator: Google::Apis::HealthcareV1::Segment::Representation + + end + end + + class ParserConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :allow_null_header, as: 'allowNullHeader' + property :segment_terminator, :base64 => true, as: 'segmentTerminator' + end + end + + class PatientId + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :type, as: 'type' + property :value, as: 'value' + end + end + + class Policy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_configs, as: 'auditConfigs', class: Google::Apis::HealthcareV1::AuditConfig, decorator: Google::Apis::HealthcareV1::AuditConfig::Representation + + collection :bindings, as: 'bindings', class: Google::Apis::HealthcareV1::Binding, decorator: Google::Apis::HealthcareV1::Binding::Representation + + property :etag, :base64 => true, as: 'etag' + property :version, as: 'version' + end + end + + class ProgressCounter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :failure, :numeric_string => true, as: 'failure' + property :pending, :numeric_string => true, as: 'pending' + property :success, :numeric_string => true, as: 'success' + end + end + + class RedactConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class ReplaceWithInfoTypeConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class Resources + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :resources, as: 'resources' + end + end + + class SchemaConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :recursive_structure_depth, :numeric_string => true, as: 'recursiveStructureDepth' + property :schema_type, as: 'schemaType' + end + end + + class SearchResourcesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :resource_type, as: 'resourceType' + end + end + + class Segment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :fields, as: 'fields' + property :segment_id, as: 'segmentId' + property :set_id, as: 'setId' + end + end + + class SetIamPolicyRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :policy, as: 'policy', class: Google::Apis::HealthcareV1::Policy, decorator: Google::Apis::HealthcareV1::Policy::Representation + + property :update_mask, as: 'updateMask' + end + end + + class Status + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + + class StreamConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bigquery_destination, as: 'bigqueryDestination', class: Google::Apis::HealthcareV1::GoogleCloudHealthcareV1FhirBigQueryDestination, decorator: Google::Apis::HealthcareV1::GoogleCloudHealthcareV1FhirBigQueryDestination::Representation + + collection :resource_types, as: 'resourceTypes' + end + end + + class TagFilterList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :tags, as: 'tags' + end + end + + class TestIamPermissionsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class TestIamPermissionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class TextConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :transformations, as: 'transformations', class: Google::Apis::HealthcareV1::InfoTypeTransformation, decorator: Google::Apis::HealthcareV1::InfoTypeTransformation::Representation + + end + end + end + end +end diff --git a/generated/google/apis/healthcare_v1/service.rb b/generated/google/apis/healthcare_v1/service.rb new file mode 100644 index 000000000..c9e53034b --- /dev/null +++ b/generated/google/apis/healthcare_v1/service.rb @@ -0,0 +1,3470 @@ +# Copyright 2015 Google Inc. +# +# 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 '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 HealthcareV1 + # Cloud Healthcare API + # + # Manage, store, and access healthcare data in Google Cloud Platform. + # + # @example + # require 'google/apis/healthcare_v1' + # + # Healthcare = Google::Apis::HealthcareV1 # Alias the module + # service = Healthcare::CloudHealthcareService.new + # + # @see https://cloud.google.com/healthcare + class CloudHealthcareService < Google::Apis::Core::BaseService + # @return [String] + # API key. Your API key identifies your project and provides you with API access, + # quota, and reports. Required unless you provide an OAuth 2.0 token. + attr_accessor :key + + # @return [String] + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + attr_accessor :quota_user + + def initialize + super('https://healthcare.googleapis.com/', '') + @batch_path = 'batch' + end + + # Creates a new health dataset. Results are returned through the + # Operation interface which returns either an + # `Operation.response` which contains a Dataset or + # `Operation.error`. The metadata + # field type is OperationMetadata. + # A Google Cloud Platform project can contain up to 500 datasets across all + # regions. + # @param [String] parent + # The name of the project where the server creates the dataset. For + # example, `projects/`project_id`/locations/`location_id``. + # @param [Google::Apis::HealthcareV1::Dataset] dataset_object + # @param [String] dataset_id + # The ID of the dataset that is being created. + # The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_dataset(parent, dataset_object = nil, dataset_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/datasets', options) + command.request_representation = Google::Apis::HealthcareV1::Dataset::Representation + command.request_object = dataset_object + command.response_representation = Google::Apis::HealthcareV1::Operation::Representation + command.response_class = Google::Apis::HealthcareV1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['datasetId'] = dataset_id unless dataset_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new dataset containing de-identified data from the source + # dataset. The metadata field type + # is OperationMetadata. + # If the request is successful, the + # response field type is + # DeidentifySummary. + # If errors occur, error is set. + # The LRO result may still be successful if de-identification fails for some + # DICOM instances. The new de-identified dataset will not contain these + # failed resources. Failed resource totals are tracked in + # Operation.metadata. + # Error details are also logged to Stackdriver Logging. For more information, + # see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). + # @param [String] source_dataset + # Source dataset resource name. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. + # @param [Google::Apis::HealthcareV1::DeidentifyDatasetRequest] deidentify_dataset_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def deidentify_dataset(source_dataset, deidentify_dataset_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+sourceDataset}:deidentify', options) + command.request_representation = Google::Apis::HealthcareV1::DeidentifyDatasetRequest::Representation + command.request_object = deidentify_dataset_request_object + command.response_representation = Google::Apis::HealthcareV1::Operation::Representation + command.response_class = Google::Apis::HealthcareV1::Operation + command.params['sourceDataset'] = source_dataset unless source_dataset.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified health dataset and all data contained in the dataset. + # Deleting a dataset does not affect the sources from which the dataset was + # imported (if any). + # @param [String] name + # The name of the dataset to delete. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1::Empty::Representation + command.response_class = Google::Apis::HealthcareV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets any metadata associated with a dataset. + # @param [String] name + # The name of the dataset to read. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Dataset] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Dataset] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1::Dataset::Representation + command.response_class = Google::Apis::HealthcareV1::Dataset + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. + # Returns an empty policy if the resource exists and does not have a policy + # set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Fixnum] options_requested_policy_version + # Optional. The policy format version to be returned. + # Valid values are 0, 1, and 3. Requests specifying an invalid value will be + # rejected. + # Requests for policies with any conditional bindings must specify version 3. + # Policies without any conditional bindings may specify any valid value or + # leave the field unset. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::HealthcareV1::Policy::Representation + command.response_class = Google::Apis::HealthcareV1::Policy + command.params['resource'] = resource unless resource.nil? + command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the health datasets in the current project. + # @param [String] parent + # The name of the project whose datasets should be listed. + # For example, `projects/`project_id`/locations/`location_id``. + # @param [Fixnum] page_size + # The maximum number of items to return. Capped to 100 if not specified. + # May not be larger than 1000. + # @param [String] page_token + # The next_page_token value returned from a previous List request, if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::ListDatasetsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::ListDatasetsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_datasets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/datasets', options) + command.response_representation = Google::Apis::HealthcareV1::ListDatasetsResponse::Representation + command.response_class = Google::Apis::HealthcareV1::ListDatasetsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates dataset metadata. + # @param [String] name + # Output only. Resource name of the dataset, of the form + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. + # @param [Google::Apis::HealthcareV1::Dataset] dataset_object + # @param [String] update_mask + # The update mask applies to the resource. For the `FieldMask` definition, + # see + # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Dataset] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Dataset] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_dataset(name, dataset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+name}', options) + command.request_representation = Google::Apis::HealthcareV1::Dataset::Representation + command.request_object = dataset_object + command.response_representation = Google::Apis::HealthcareV1::Dataset::Representation + command.response_class = Google::Apis::HealthcareV1::Dataset + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. + # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_dataset_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::HealthcareV1::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::HealthcareV1::Policy::Representation + command.response_class = Google::Apis::HealthcareV1::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns permissions that a caller has on the specified resource. + # If the resource does not exist, this will return an empty set of + # permissions, not a NOT_FOUND error. + # Note: This operation is designed to be used for building permission-aware + # UIs and command-line tools, not for authorization checking. This operation + # may "fail open" without warning. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1::TestIamPermissionsRequest] test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_dataset_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::HealthcareV1::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::HealthcareV1::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new DICOM store within the parent dataset. + # @param [String] parent + # The name of the dataset this DICOM store belongs to. + # @param [Google::Apis::HealthcareV1::DicomStore] dicom_store_object + # @param [String] dicom_store_id + # The ID of the DICOM store that is being created. + # Any string value up to 256 characters in length. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::DicomStore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::DicomStore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_dataset_dicom_store(parent, dicom_store_object = nil, dicom_store_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/dicomStores', options) + command.request_representation = Google::Apis::HealthcareV1::DicomStore::Representation + command.request_object = dicom_store_object + command.response_representation = Google::Apis::HealthcareV1::DicomStore::Representation + command.response_class = Google::Apis::HealthcareV1::DicomStore + command.params['parent'] = parent unless parent.nil? + command.query['dicomStoreId'] = dicom_store_id unless dicom_store_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # De-identifies data from the source store and writes it to the destination + # store. The metadata field type + # is OperationMetadata. + # If the request is successful, the + # response field type is + # DeidentifyDicomStoreSummary. If errors occur, + # error is set. + # The LRO result may still be successful if de-identification fails for some + # DICOM instances. The output DICOM store will not contain + # these failed resources. Failed resource totals are tracked in + # Operation.metadata. + # Error details are also logged to Stackdriver + # (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). + # @param [String] source_store + # Source DICOM store resource name. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [Google::Apis::HealthcareV1::DeidentifyDicomStoreRequest] deidentify_dicom_store_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def deidentify_dicom_store(source_store, deidentify_dicom_store_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+sourceStore}:deidentify', options) + command.request_representation = Google::Apis::HealthcareV1::DeidentifyDicomStoreRequest::Representation + command.request_object = deidentify_dicom_store_request_object + command.response_representation = Google::Apis::HealthcareV1::Operation::Representation + command.response_class = Google::Apis::HealthcareV1::Operation + command.params['sourceStore'] = source_store unless source_store.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified DICOM store and removes all images that are contained + # within it. + # @param [String] name + # The resource name of the DICOM store to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_dicom_store(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1::Empty::Representation + command.response_class = Google::Apis::HealthcareV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Exports data to the specified destination by copying it from the DICOM + # store. + # Errors are also logged to Stackdriver Logging. For more information, + # see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). + # The metadata field type is + # OperationMetadata. + # @param [String] name + # The DICOM store resource name from which to export the data. For + # example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [Google::Apis::HealthcareV1::ExportDicomDataRequest] export_dicom_data_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def export_dicom_store_dicom_data(name, export_dicom_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:export', options) + command.request_representation = Google::Apis::HealthcareV1::ExportDicomDataRequest::Representation + command.request_object = export_dicom_data_request_object + command.response_representation = Google::Apis::HealthcareV1::Operation::Representation + command.response_class = Google::Apis::HealthcareV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the specified DICOM store. + # @param [String] name + # The resource name of the DICOM store to get. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::DicomStore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::DicomStore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_dicom_store(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1::DicomStore::Representation + command.response_class = Google::Apis::HealthcareV1::DicomStore + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. + # Returns an empty policy if the resource exists and does not have a policy + # set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Fixnum] options_requested_policy_version + # Optional. The policy format version to be returned. + # Valid values are 0, 1, and 3. Requests specifying an invalid value will be + # rejected. + # Requests for policies with any conditional bindings must specify version 3. + # Policies without any conditional bindings may specify any valid value or + # leave the field unset. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_dicom_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::HealthcareV1::Policy::Representation + command.response_class = Google::Apis::HealthcareV1::Policy + command.params['resource'] = resource unless resource.nil? + command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Imports data into the DICOM store by copying it from the specified source. + # Errors are logged to Stackdriver Logging. For more information, see + # [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). The + # metadata field type is + # OperationMetadata. + # @param [String] name + # The name of the DICOM store resource into which the data is imported. + # For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [Google::Apis::HealthcareV1::ImportDicomDataRequest] import_dicom_data_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def import_dicom_store_dicom_data(name, import_dicom_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:import', options) + command.request_representation = Google::Apis::HealthcareV1::ImportDicomDataRequest::Representation + command.request_object = import_dicom_data_request_object + command.response_representation = Google::Apis::HealthcareV1::Operation::Representation + command.response_class = Google::Apis::HealthcareV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the DICOM stores in the given dataset. + # @param [String] parent + # Name of the dataset. + # @param [String] filter + # Restricts stores returned to those matching a filter. Syntax: + # https://cloud.google.com/appengine/docs/standard/python/search/query_strings + # Only filtering on labels is supported. For example, `labels.key=value`. + # @param [Fixnum] page_size + # Limit on the number of DICOM stores to return in a single response. + # If zero the default page size of 100 is used. + # @param [String] page_token + # The next_page_token value returned from the previous List request, if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::ListDicomStoresResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::ListDicomStoresResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_dataset_dicom_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/dicomStores', options) + command.response_representation = Google::Apis::HealthcareV1::ListDicomStoresResponse::Representation + command.response_class = Google::Apis::HealthcareV1::ListDicomStoresResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the specified DICOM store. + # @param [String] name + # Output only. Resource name of the DICOM store, of the form + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [Google::Apis::HealthcareV1::DicomStore] dicom_store_object + # @param [String] update_mask + # The update mask applies to the resource. For the `FieldMask` definition, + # see + # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::DicomStore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::DicomStore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_dataset_dicom_store(name, dicom_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+name}', options) + command.request_representation = Google::Apis::HealthcareV1::DicomStore::Representation + command.request_object = dicom_store_object + command.response_representation = Google::Apis::HealthcareV1::DicomStore::Representation + command.response_class = Google::Apis::HealthcareV1::DicomStore + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # SearchForInstances returns a list of matching instances. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the SearchForInstancesRequest DICOMweb request. For example, + # `instances`, `series/`series_uid`/instances`, or + # `studies/`study_uid`/instances`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_location_dataset_dicom_store_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # SearchForSeries returns a list of matching series. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the SearchForSeries DICOMweb request. For example, `series` or + # `studies/`study_uid`/series`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_location_dataset_dicom_store_for_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # SearchForStudies returns a list of matching studies. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the SearchForStudies DICOMweb request. For example, `studies`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_location_dataset_dicom_store_for_studies(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. + # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_dicom_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::HealthcareV1::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::HealthcareV1::Policy::Representation + command.response_class = Google::Apis::HealthcareV1::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # StoreInstances stores DICOM instances associated with study instance unique + # identifiers (SUID). See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the StoreInstances DICOMweb request. For example, + # `studies/[`study_uid`]`. Note that the `study_uid` is optional. + # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def store_project_location_dataset_dicom_store_instances(parent, dicom_web_path, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.request_object = http_body_object + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns permissions that a caller has on the specified resource. + # If the resource does not exist, this will return an empty set of + # permissions, not a NOT_FOUND error. + # Note: This operation is designed to be used for building permission-aware + # UIs and command-line tools, not for authorization checking. This operation + # may "fail open" without warning. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1::TestIamPermissionsRequest] test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_dicom_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::HealthcareV1::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::HealthcareV1::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # DeleteStudy deletes all instances within the given study. Delete requests + # are equivalent to the GET requests specified in the Retrieve transaction. + # The method returns an Operation which + # will be marked successful when the deletion is complete. + # @param [String] parent + # @param [String] dicom_web_path + # The path of the DeleteStudy request. For example, `studies/`study_uid``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_dicom_store_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::Operation::Representation + command.response_class = Google::Apis::HealthcareV1::Operation + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveStudyMetadata returns instance associated with the given study + # presented as metadata with the bulk data removed. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the RetrieveStudyMetadata DICOMweb request. For example, + # `studies/`study_uid`/metadata`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def retrieve_project_location_dataset_dicom_store_study_metadata(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveStudy returns all instances within the given study. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the RetrieveStudy DICOMweb request. For example, + # `studies/`study_uid``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def retrieve_project_location_dataset_dicom_store_study_study(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # SearchForInstances returns a list of matching instances. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the SearchForInstancesRequest DICOMweb request. For example, + # `instances`, `series/`series_uid`/instances`, or + # `studies/`study_uid`/instances`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_location_dataset_dicom_store_study_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # SearchForSeries returns a list of matching series. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the SearchForSeries DICOMweb request. For example, `series` or + # `studies/`study_uid`/series`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_location_dataset_dicom_store_study_for_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # StoreInstances stores DICOM instances associated with study instance unique + # identifiers (SUID). See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the StoreInstances DICOMweb request. For example, + # `studies/[`study_uid`]`. Note that the `study_uid` is optional. + # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def store_project_location_dataset_dicom_store_study_instances(parent, dicom_web_path, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.request_object = http_body_object + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # DeleteSeries deletes all instances within the given study and series. + # Delete requests are equivalent to the GET requests specified in the + # Retrieve transaction. + # The method returns an Operation which + # will be marked successful when the deletion is complete. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the DeleteSeries request. For example, + # `studies/`study_uid`/series/`series_uid``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_dicom_store_study_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::Operation::Representation + command.response_class = Google::Apis::HealthcareV1::Operation + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveSeriesMetadata returns instance associated with the given study and + # series, presented as metadata with the bulk data removed. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the RetrieveSeriesMetadata DICOMweb request. For example, + # `studies/`study_uid`/series/`series_uid`/metadata`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def retrieve_project_location_dataset_dicom_store_study_series_metadata(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveSeries returns all instances within the given study and series. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the RetrieveSeries DICOMweb request. For example, + # `studies/`study_uid`/series/`series_uid``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def retrieve_project_location_dataset_dicom_store_study_series_series(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # SearchForInstances returns a list of matching instances. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the SearchForInstancesRequest DICOMweb request. For example, + # `instances`, `series/`series_uid`/instances`, or + # `studies/`study_uid`/instances`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_location_dataset_dicom_store_study_series_for_instances(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # DeleteInstance deletes an instance associated with the given study, series, + # and SOP Instance UID. Delete requests are equivalent to the GET requests + # specified in the Retrieve transaction. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the DeleteInstance request. For example, + # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_dicom_store_study_series_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::Empty::Representation + command.response_class = Google::Apis::HealthcareV1::Empty + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveInstance returns instance associated with the given study, series, + # and SOP Instance UID. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the RetrieveInstance DICOMweb request. For example, + # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def retrieve_project_location_dataset_dicom_store_study_series_instance_instance(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveInstanceMetadata returns instance associated with the given study, + # series, and SOP Instance UID presented as metadata with the bulk data + # removed. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the RetrieveInstanceMetadata DICOMweb request. For example, + # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/metadata`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def retrieve_project_location_dataset_dicom_store_study_series_instance_metadata(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveRenderedInstance returns instance associated with the given study, + # series, and SOP Instance UID in an acceptable Rendered Media Type. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the RetrieveRenderedInstance DICOMweb request. For example, + # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/rendered`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def retrieve_project_location_dataset_dicom_store_study_series_instance_rendered(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveFrames returns instances associated with the given study, series, + # SOP Instance UID and frame numbers. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the RetrieveFrames DICOMweb request. For example, + # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/frames/` + # frame_list``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def retrieve_project_location_dataset_dicom_store_study_series_instance_frame_frames(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # RetrieveRenderedFrames returns instances associated with the given study, + # series, SOP Instance UID and frame numbers in an acceptable Rendered Media + # Type. See + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4. + # @param [String] parent + # The name of the DICOM store that is being accessed. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # dicomStores/`dicom_store_id``. + # @param [String] dicom_web_path + # The path of the RetrieveRenderedFrames DICOMweb request. For example, + # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/frames/` + # frame_list`/rendered`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def retrieve_project_location_dataset_dicom_store_study_series_instance_frame_rendered(parent, dicom_web_path, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/dicomWeb/{+dicomWebPath}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['dicomWebPath'] = dicom_web_path unless dicom_web_path.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new FHIR store within the parent dataset. + # @param [String] parent + # The name of the dataset this FHIR store belongs to. + # @param [Google::Apis::HealthcareV1::FhirStore] fhir_store_object + # @param [String] fhir_store_id + # The ID of the FHIR store that is being created. + # The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::FhirStore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::FhirStore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_dataset_fhir_store(parent, fhir_store_object = nil, fhir_store_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/fhirStores', options) + command.request_representation = Google::Apis::HealthcareV1::FhirStore::Representation + command.request_object = fhir_store_object + command.response_representation = Google::Apis::HealthcareV1::FhirStore::Representation + command.response_class = Google::Apis::HealthcareV1::FhirStore + command.params['parent'] = parent unless parent.nil? + command.query['fhirStoreId'] = fhir_store_id unless fhir_store_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # De-identifies data from the source store and writes it to the destination + # store. The metadata field type + # is OperationMetadata. + # If the request is successful, the + # response field type is + # DeidentifyFhirStoreSummary. If errors occur, + # error is set. + # Error details are also logged to Stackdriver + # (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). + # @param [String] source_store + # Source FHIR store resource name. For example, + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # fhirStores/`fhir_store_id``. + # @param [Google::Apis::HealthcareV1::DeidentifyFhirStoreRequest] deidentify_fhir_store_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def deidentify_fhir_store(source_store, deidentify_fhir_store_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+sourceStore}:deidentify', options) + command.request_representation = Google::Apis::HealthcareV1::DeidentifyFhirStoreRequest::Representation + command.request_object = deidentify_fhir_store_request_object + command.response_representation = Google::Apis::HealthcareV1::Operation::Representation + command.response_class = Google::Apis::HealthcareV1::Operation + command.params['sourceStore'] = source_store unless source_store.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified FHIR store and removes all resources within it. + # @param [String] name + # The resource name of the FHIR store to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1::Empty::Representation + command.response_class = Google::Apis::HealthcareV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Export resources from the FHIR store to the specified destination. + # This method returns an Operation that can + # be used to track the status of the export by calling + # GetOperation. + # Immediate fatal errors appear in the + # error field, errors are also logged + # to Stackdriver (see [Viewing + # logs](/healthcare/docs/how-tos/stackdriver-logging)). + # Otherwise, when the operation finishes, a detailed response of type + # ExportResourcesResponse is returned in the + # response field. + # The metadata field type for this + # operation is OperationMetadata. + # @param [String] name + # The name of the FHIR store to export resource from. The name should be in + # the format of + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # fhirStores/`fhir_store_id``. + # @param [Google::Apis::HealthcareV1::ExportResourcesRequest] export_resources_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def export_fhir_store_resources(name, export_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:export', options) + command.request_representation = Google::Apis::HealthcareV1::ExportResourcesRequest::Representation + command.request_object = export_resources_request_object + command.response_representation = Google::Apis::HealthcareV1::Operation::Representation + command.response_class = Google::Apis::HealthcareV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the configuration of the specified FHIR store. + # @param [String] name + # The resource name of the FHIR store to get. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::FhirStore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::FhirStore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_fhir_store(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1::FhirStore::Representation + command.response_class = Google::Apis::HealthcareV1::FhirStore + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. + # Returns an empty policy if the resource exists and does not have a policy + # set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Fixnum] options_requested_policy_version + # Optional. The policy format version to be returned. + # Valid values are 0, 1, and 3. Requests specifying an invalid value will be + # rejected. + # Requests for policies with any conditional bindings must specify version 3. + # Policies without any conditional bindings may specify any valid value or + # leave the field unset. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_fhir_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::HealthcareV1::Policy::Representation + command.response_class = Google::Apis::HealthcareV1::Policy + command.params['resource'] = resource unless resource.nil? + command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Import resources to the FHIR store by loading data from the specified + # sources. This method is optimized to load large quantities of data using + # import semantics that ignore some FHIR store configuration options and are + # not suitable for all use cases. It is primarily intended to load data into + # an empty FHIR store that is not being used by other clients. In cases + # where this method is not appropriate, consider using ExecuteBundle to + # load data. + # Every resource in the input must contain a client-supplied ID, and will be + # stored using that ID regardless of the + # enable_update_create setting on the FHIR + # store. + # The import process does not enforce referential integrity, regardless of + # the + # disable_referential_integrity + # setting on the FHIR store. This allows the import of resources with + # arbitrary interdependencies without considering grouping or ordering, but + # if the input data contains invalid references or if some resources fail to + # be imported, the FHIR store might be left in a state that violates + # referential integrity. + # The import process does not trigger PubSub notification or BigQuery + # streaming update, regardless of how those are configured on the FHIR store. + # If a resource with the specified ID already exists, the most recent + # version of the resource is overwritten without creating a new historical + # version, regardless of the + # disable_resource_versioning + # setting on the FHIR store. If transient failures occur during the import, + # it is possible that successfully imported resources will be overwritten + # more than once. + # The import operation is idempotent unless the input data contains multiple + # valid resources with the same ID but different contents. In that case, + # after the import completes, the store will contain exactly one resource + # with that ID but there is no ordering guarantee on which version of the + # contents it will have. The operation result counters do not count + # duplicate IDs as an error and will count one success for each resource in + # the input, which might result in a success count larger than the number + # of resources in the FHIR store. This often occurs when importing data + # organized in bundles produced by Patient-everything + # where each bundle contains its own copy of a resource such as Practitioner + # that might be referred to by many patients. + # If some resources fail to import, for example due to parsing errors, + # successfully imported resources are not rolled back. + # The location and format of the input data is specified by the parameters + # below. Note that if no format is specified, this method assumes the + # `BUNDLE` format. When using the `BUNDLE` format this method ignores the + # `Bundle.type` field, except that `history` bundles are rejected, and does + # not apply any of the bundle processing semantics for batch or transaction + # bundles. Unlike in ExecuteBundle, transaction bundles are not executed + # as a single transaction and bundle-internal references are not rewritten. + # The bundle is treated as a collection of resources to be written as + # provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As + # an example, this allows the import of `searchset` bundles produced by a + # FHIR search or + # Patient-everything operation. + # This method returns an Operation that can + # be used to track the status of the import by calling + # GetOperation. + # Immediate fatal errors appear in the + # error field, errors are also logged + # to Stackdriver (see [Viewing + # logs](/healthcare/docs/how-tos/stackdriver-logging)). Otherwise, when the + # operation finishes, a detailed response of type ImportResourcesResponse + # is returned in the response field. + # The metadata field type for this + # operation is OperationMetadata. + # @param [String] name + # The name of the FHIR store to import FHIR resources to. The name should be + # in the format of + # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # fhirStores/`fhir_store_id``. + # @param [Google::Apis::HealthcareV1::ImportResourcesRequest] import_resources_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def import_fhir_store_resources(name, import_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:import', options) + command.request_representation = Google::Apis::HealthcareV1::ImportResourcesRequest::Representation + command.request_object = import_resources_request_object + command.response_representation = Google::Apis::HealthcareV1::Operation::Representation + command.response_class = Google::Apis::HealthcareV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the FHIR stores in the given dataset. + # @param [String] parent + # Name of the dataset. + # @param [String] filter + # Restricts stores returned to those matching a filter. Syntax: + # https://cloud.google.com/appengine/docs/standard/python/search/query_strings + # Only filtering on labels is supported, for example `labels.key=value`. + # @param [Fixnum] page_size + # Limit on the number of FHIR stores to return in a single response. If zero + # the default page size of 100 is used. + # @param [String] page_token + # The next_page_token value returned from the previous List request, if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::ListFhirStoresResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::ListFhirStoresResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_dataset_fhir_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/fhirStores', options) + command.response_representation = Google::Apis::HealthcareV1::ListFhirStoresResponse::Representation + command.response_class = Google::Apis::HealthcareV1::ListFhirStoresResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the configuration of the specified FHIR store. + # @param [String] name + # Output only. Resource name of the FHIR store, of the form + # `projects/`project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``. + # @param [Google::Apis::HealthcareV1::FhirStore] fhir_store_object + # @param [String] update_mask + # The update mask applies to the resource. For the `FieldMask` definition, + # see + # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::FhirStore] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::FhirStore] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_dataset_fhir_store(name, fhir_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+name}', options) + command.request_representation = Google::Apis::HealthcareV1::FhirStore::Representation + command.request_object = fhir_store_object + command.response_representation = Google::Apis::HealthcareV1::FhirStore::Representation + command.response_class = Google::Apis::HealthcareV1::FhirStore + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Searches for resources in the given FHIR store according to criteria + # specified as query parameters. + # Implements the FHIR standard search interaction + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), + # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) + # using the search semantics described in the FHIR Search specification + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), + # [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). + # Supports three methods of search defined by the specification: + # * `GET [base]?[parameters]` to search across all resources. + # * `GET [base]/[type]?[parameters]` to search resources of a specified + # type. + # * `POST [base]/[type]/_search?[parameters]` as an alternate form having + # the same semantics as the `GET` method. + # The `GET` methods do not support compartment searches. The `POST` method + # does not support `application/x-www-form-urlencoded` search parameters. + # On success, the response body will contain a JSON-encoded representation + # of a `Bundle` resource of type `searchset`, containing the results of the + # search. + # Errors generated by the FHIR store will contain a JSON-encoded + # `OperationOutcome` resource describing the reason for the error. If the + # request cannot be mapped to a valid API method on a FHIR store, a generic + # GCP error might be returned instead. + # The server's capability statement, retrieved through + # capabilities, indicates what search parameters + # are supported on each FHIR resource. A list of all search parameters + # defined by the specification can be found in the FHIR Search Parameter + # Registry + # ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry. + # html), + # [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)) + # . + # FHIR search parameters for DSTU2 can be found on each resource's definition + # page. + # Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, + # `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. + # Supported search result parameters: `_sort`, `_count`, `_include`, + # `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. + # The maximum number of search results returned defaults to 100, which can + # be overridden by the `_count` parameter up to a maximum limit of 1000. If + # there are additional results, the returned `Bundle` will contain + # pagination links. + # Resources with a total size larger than 5MB or a field count larger than + # 50,000 might not be fully searchable as the server might trim its generated + # search index in those cases. + # Note: FHIR resources are indexed asynchronously, so there might be a slight + # delay between the time a resource is created or changes and when the change + # is reflected in search results. + # @param [String] parent + # Name of the FHIR store to retrieve resources from. + # @param [String] resource_type + # The FHIR resource type to search, such as Patient or Observation. For a + # complete list, see the FHIR Resource Index + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), + # [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_location_dataset_fhir_stores(parent, resource_type: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/fhir', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.query['resourceType'] = resource_type unless resource_type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. + # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_fhir_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::HealthcareV1::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::HealthcareV1::Policy::Representation + command.response_class = Google::Apis::HealthcareV1::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns permissions that a caller has on the specified resource. + # If the resource does not exist, this will return an empty set of + # permissions, not a NOT_FOUND error. + # Note: This operation is designed to be used for building permission-aware + # UIs and command-line tools, not for authorization checking. This operation + # may "fail open" without warning. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1::TestIamPermissionsRequest] test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_fhir_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::HealthcareV1::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::HealthcareV1::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # On success, the response body will contain a JSON-encoded representation + # of a `Bundle` resource of type `searchset`, containing the results of the + # operation. + # Errors generated by the FHIR store will contain a JSON-encoded + # `OperationOutcome` resource describing the reason for the error. If the + # request cannot be mapped to a valid API method on a FHIR store, a generic + # GCP error might be returned instead. + # @param [String] name + # Name of the `Patient` resource for which the information is required. + # @param [Fixnum] _count + # Maximum number of resources in a page. Defaults to 100. + # @param [String] _page_token + # Used to retrieve the next or previous page of results + # when using pagination. Value should be set to the value of page_token set + # in next or previous page links' urls. Next and previous page are returned + # in the response bundle's links field, where `link.relation` is "previous" + # or "next". + # Omit `page_token` if no previous request has been made. + # @param [String] end_ + # The response includes records prior to the end date. If no end date is + # provided, all records subsequent to the start date are in scope. + # @param [String] start + # The response includes records subsequent to the start date. If no start + # date is provided, all records prior to the end date are in scope. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patient_project_location_dataset_fhir_store_fhir_everything(name, _count: nil, _page_token: nil, end_: nil, start: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}/$everything', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['name'] = name unless name.nil? + command.query['_count'] = _count unless _count.nil? + command.query['_page_token'] = _page_token unless _page_token.nil? + command.query['end'] = end_ unless end_.nil? + command.query['start'] = start unless start.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes all the historical versions of a resource (excluding the current + # version) from the FHIR store. To remove all versions of a resource, first + # delete the current version and then call this method. + # This is not a FHIR standard operation. + # @param [String] name + # The name of the resource to purge. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def resource_project_location_dataset_fhir_store_fhir_purge(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}/$purge', options) + command.response_representation = Google::Apis::HealthcareV1::Empty::Representation + command.response_class = Google::Apis::HealthcareV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the FHIR capability statement + # ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), + # [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), + # or the [conformance + # statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) + # in the DSTU2 case for the store, which contains a description of + # functionality supported by the server. + # Implements the FHIR standard capabilities interaction + # ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), + # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), + # or the [conformance + # interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html# + # conformance) + # in the DSTU2 case. + # On success, the response body will contain a JSON-encoded representation + # of a `CapabilityStatement` resource. + # @param [String] name + # Name of the FHIR store to retrieve the capabilities for. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def capabilities_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}/fhir/metadata', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a FHIR resource. + # Implements the FHIR standard create interaction + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#create), + # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#create)), + # which creates a new resource with a server-assigned resource ID. + # Also supports the FHIR standard conditional create interaction + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), + # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#ccreate)), + # specified by supplying an `If-None-Exist` header containing a FHIR search + # query. If no resources match this search query, the server processes the + # create operation as normal. + # The request body must contain a JSON-encoded FHIR resource, and the request + # headers must contain `Content-Type: application/fhir+json`. + # On success, the response body will contain a JSON-encoded representation + # of the resource as it was created on the server, including the + # server-assigned resource ID and version ID. + # Errors generated by the FHIR store will contain a JSON-encoded + # `OperationOutcome` resource describing the reason for the error. If the + # request cannot be mapped to a valid API method on a FHIR store, a generic + # GCP error might be returned instead. + # @param [String] parent + # The name of the FHIR store this resource belongs to. + # @param [String] type + # The FHIR resource type to create, such as Patient or Observation. For a + # complete list, see the FHIR Resource Index + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), + # [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + # Must match the resource type in the provided content. + # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_dataset_fhir_store_fhir(parent, type, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/fhir/{+type}', options) + command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.request_object = http_body_object + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.params['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a FHIR resource. + # Implements the FHIR standard delete interaction + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#delete), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#delete), + # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#delete)). + # Note: Unless resource versioning is disabled by setting the + # disable_resource_versioning flag + # on the FHIR store, the deleted resources will be moved to a history + # repository that can still be retrieved through vread + # and related methods, unless they are removed by the + # purge method. + # @param [String] name + # The name of the resource to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Executes all the requests in the given Bundle. + # Implements the FHIR standard batch/transaction interaction + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#transaction), + # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#transaction)). + # Supports all interactions within a bundle, except search. This method + # accepts Bundles of type `batch` and `transaction`, processing them + # according to the batch processing rules + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), + # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#brules)) + # and transaction processing rules + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), + # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#trules)). + # The request body must contain a JSON-encoded FHIR `Bundle` resource, and + # the request headers must contain `Content-Type: application/fhir+json`. + # For a batch bundle or a successful transaction the response body will + # contain a JSON-encoded representation of a `Bundle` resource of type + # `batch-response` or `transaction-response` containing one entry for each + # entry in the request, with the outcome of processing the entry. In the + # case of an error for a transaction bundle, the response body will contain + # a JSON-encoded `OperationOutcome` resource describing the reason for the + # error. If the request cannot be mapped to a valid API method on a FHIR + # store, a generic GCP error might be returned instead. + # @param [String] parent + # Name of the FHIR store in which this bundle will be executed. + # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def execute_project_location_dataset_fhir_store_fhir_bundle(parent, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/fhir', options) + command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.request_object = http_body_object + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all the versions of a resource (including the current version and + # deleted versions) from the FHIR store. + # Implements the per-resource form of the FHIR standard history interaction + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#history), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#history), + # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#history)). + # On success, the response body will contain a JSON-encoded representation + # of a `Bundle` resource of type `history`, containing the version history + # sorted from most recent to oldest versions. + # Errors generated by the FHIR store will contain a JSON-encoded + # `OperationOutcome` resource describing the reason for the error. If the + # request cannot be mapped to a valid API method on a FHIR store, a generic + # GCP error might be returned instead. + # @param [String] name + # The name of the resource to retrieve. + # @param [String] _at + # Only include resource versions that were current at some point during the + # time period specified in the date time value. The date parameter format is + # yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] + # Clients may specify any of the following: + # * An entire year: `_at=2019` + # * An entire month: `_at=2019-01` + # * A specific day: `_at=2019-01-20` + # * A specific second: `_at=2018-12-31T23:59:58Z` + # @param [Fixnum] _count + # The maximum number of search results on a page. Defaults to 1000. + # @param [String] _page_token + # Used to retrieve the first, previous, next, or last page of resource + # versions when using pagination. Value should be set to the value of + # `_page_token` set in next or previous page links' URLs. Next and previous + # page are returned in the response bundle's links field, where + # `link.relation` is "previous" or "next". + # Omit `_page_token` if no previous request has been made. + # @param [String] _since + # Only include resource versions that were created at or after the given + # instant in time. The instant in time uses the format + # YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or + # 2017-01-01T00:00:00Z). The time must be specified to the second and + # include a time zone. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def history_project_location_dataset_fhir_store_fhir(name, _at: nil, _count: nil, _page_token: nil, _since: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}/_history', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['name'] = name unless name.nil? + command.query['_at'] = _at unless _at.nil? + command.query['_count'] = _count unless _count.nil? + command.query['_page_token'] = _page_token unless _page_token.nil? + command.query['_since'] = _since unless _since.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates part of an existing resource by applying the operations specified + # in a [JSON Patch](http://jsonpatch.com/) document. + # Implements the FHIR standard patch interaction + # ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#patch), + # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#patch)). + # DSTU2 doesn't define a patch method, but the server supports it in the same + # way it supports STU3. + # The request body must contain a JSON Patch document, and the request + # headers must contain `Content-Type: application/json-patch+json`. + # On success, the response body will contain a JSON-encoded representation + # of the updated resource, including the server-assigned version ID. + # Errors generated by the FHIR store will contain a JSON-encoded + # `OperationOutcome` resource describing the reason for the error. If the + # request cannot be mapped to a valid API method on a FHIR store, a generic + # GCP error might be returned instead. + # @param [String] name + # The name of the resource to update. + # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_dataset_fhir_store_fhir(name, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+name}', options) + command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.request_object = http_body_object + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the contents of a FHIR resource. + # Implements the FHIR standard read interaction + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#read), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#read), + # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#read)). + # Also supports the FHIR standard conditional read interaction + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#cread), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#cread), + # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#cread)) + # specified by supplying an `If-Modified-Since` header with a date/time value + # or an `If-None-Match` header with an ETag value. + # On success, the response body will contain a JSON-encoded representation + # of the resource. + # Errors generated by the FHIR store will contain a JSON-encoded + # `OperationOutcome` resource describing the reason for the error. If the + # request cannot be mapped to a valid API method on a FHIR store, a generic + # GCP error might be returned instead. + # @param [String] name + # The name of the resource to retrieve. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def read_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Searches for resources in the given FHIR store according to criteria + # specified as query parameters. + # Implements the FHIR standard search interaction + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), + # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) + # using the search semantics described in the FHIR Search specification + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), + # [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). + # Supports three methods of search defined by the specification: + # * `GET [base]?[parameters]` to search across all resources. + # * `GET [base]/[type]?[parameters]` to search resources of a specified + # type. + # * `POST [base]/[type]/_search?[parameters]` as an alternate form having + # the same semantics as the `GET` method. + # The `GET` methods do not support compartment searches. The `POST` method + # does not support `application/x-www-form-urlencoded` search parameters. + # On success, the response body will contain a JSON-encoded representation + # of a `Bundle` resource of type `searchset`, containing the results of the + # search. + # Errors generated by the FHIR store will contain a JSON-encoded + # `OperationOutcome` resource describing the reason for the error. If the + # request cannot be mapped to a valid API method on a FHIR store, a generic + # GCP error might be returned instead. + # The server's capability statement, retrieved through + # capabilities, indicates what search parameters + # are supported on each FHIR resource. A list of all search parameters + # defined by the specification can be found in the FHIR Search Parameter + # Registry + # ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry. + # html), + # [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)) + # . + # FHIR search parameters for DSTU2 can be found on each resource's definition + # page. + # Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, + # `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. + # Supported search result parameters: `_sort`, `_count`, `_include`, + # `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. + # The maximum number of search results returned defaults to 100, which can + # be overridden by the `_count` parameter up to a maximum limit of 1000. If + # there are additional results, the returned `Bundle` will contain + # pagination links. + # Resources with a total size larger than 5MB or a field count larger than + # 50,000 might not be fully searchable as the server might trim its generated + # search index in those cases. + # Note: FHIR resources are indexed asynchronously, so there might be a slight + # delay between the time a resource is created or changes and when the change + # is reflected in search results. + # @param [String] parent + # Name of the FHIR store to retrieve resources from. + # @param [Google::Apis::HealthcareV1::SearchResourcesRequest] search_resources_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_fhir_resources(parent, search_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/fhir/_search', options) + command.request_representation = Google::Apis::HealthcareV1::SearchResourcesRequest::Representation + command.request_object = search_resources_request_object + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the entire contents of a resource. + # Implements the FHIR standard update interaction + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#update), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update), + # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#update)). + # If the specified resource does + # not exist and the FHIR store has + # enable_update_create set, creates the + # resource with the client-specified ID. + # The request body must contain a JSON-encoded FHIR resource, and the request + # headers must contain `Content-Type: application/fhir+json`. The resource + # must contain an `id` element having an identical value to the ID in the + # REST path of the request. + # On success, the response body will contain a JSON-encoded representation + # of the updated resource, including the server-assigned version ID. + # Errors generated by the FHIR store will contain a JSON-encoded + # `OperationOutcome` resource describing the reason for the error. If the + # request cannot be mapped to a valid API method on a FHIR store, a generic + # GCP error might be returned instead. + # @param [String] name + # The name of the resource to update. + # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_project_location_dataset_fhir_store_fhir(name, http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/{+name}', options) + command.request_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.request_object = http_body_object + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the contents of a version (current or historical) of a FHIR resource + # by version ID. + # Implements the FHIR standard vread interaction + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#vread), + # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#vread)). + # On success, the response body will contain a JSON-encoded representation + # of the resource. + # Errors generated by the FHIR store will contain a JSON-encoded + # `OperationOutcome` resource describing the reason for the error. If the + # request cannot be mapped to a valid API method on a FHIR store, a generic + # GCP error might be returned instead. + # @param [String] name + # The name of the resource version to retrieve. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def vread_project_location_dataset_fhir_store_fhir(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1::HttpBody + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new HL7v2 store within the parent dataset. + # @param [String] parent + # The name of the dataset this HL7v2 store belongs to. + # @param [Google::Apis::HealthcareV1::Hl7V2Store] hl7_v2_store_object + # @param [String] hl7_v2_store_id + # The ID of the HL7v2 store that is being created. + # The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Hl7V2Store] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Hl7V2Store] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_dataset_hl7_v2_store(parent, hl7_v2_store_object = nil, hl7_v2_store_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/hl7V2Stores', options) + command.request_representation = Google::Apis::HealthcareV1::Hl7V2Store::Representation + command.request_object = hl7_v2_store_object + command.response_representation = Google::Apis::HealthcareV1::Hl7V2Store::Representation + command.response_class = Google::Apis::HealthcareV1::Hl7V2Store + command.params['parent'] = parent unless parent.nil? + command.query['hl7V2StoreId'] = hl7_v2_store_id unless hl7_v2_store_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified HL7v2 store and removes all messages that are + # contained within it. + # @param [String] name + # The resource name of the HL7v2 store to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_hl7_v2_store(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1::Empty::Representation + command.response_class = Google::Apis::HealthcareV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the specified HL7v2 store. + # @param [String] name + # The resource name of the HL7v2 store to get. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Hl7V2Store] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Hl7V2Store] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_hl7_v2_store(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1::Hl7V2Store::Representation + command.response_class = Google::Apis::HealthcareV1::Hl7V2Store + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. + # Returns an empty policy if the resource exists and does not have a policy + # set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Fixnum] options_requested_policy_version + # Optional. The policy format version to be returned. + # Valid values are 0, 1, and 3. Requests specifying an invalid value will be + # rejected. + # Requests for policies with any conditional bindings must specify version 3. + # Policies without any conditional bindings may specify any valid value or + # leave the field unset. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_hl7_v2_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::HealthcareV1::Policy::Representation + command.response_class = Google::Apis::HealthcareV1::Policy + command.params['resource'] = resource unless resource.nil? + command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the HL7v2 stores in the given dataset. + # @param [String] parent + # Name of the dataset. + # @param [String] filter + # Restricts stores returned to those matching a filter. Syntax: + # https://cloud.google.com/appengine/docs/standard/python/search/query_strings + # Only filtering on labels is supported. For example, `labels.key=value`. + # @param [Fixnum] page_size + # Limit on the number of HL7v2 stores to return in a single response. + # If zero the default page size of 100 is used. + # @param [String] page_token + # The next_page_token value returned from the previous List request, if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::ListHl7V2StoresResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::ListHl7V2StoresResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_dataset_hl7_v2_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/hl7V2Stores', options) + command.response_representation = Google::Apis::HealthcareV1::ListHl7V2StoresResponse::Representation + command.response_class = Google::Apis::HealthcareV1::ListHl7V2StoresResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the HL7v2 store. + # @param [String] name + # Output only. Resource name of the HL7v2 store, of the form + # `projects/`project_id`/datasets/`dataset_id`/hl7V2Stores/`hl7v2_store_id``. + # @param [Google::Apis::HealthcareV1::Hl7V2Store] hl7_v2_store_object + # @param [String] update_mask + # The update mask applies to the resource. For the `FieldMask` definition, + # see + # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Hl7V2Store] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Hl7V2Store] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_dataset_hl7_v2_store(name, hl7_v2_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+name}', options) + command.request_representation = Google::Apis::HealthcareV1::Hl7V2Store::Representation + command.request_object = hl7_v2_store_object + command.response_representation = Google::Apis::HealthcareV1::Hl7V2Store::Representation + command.response_class = Google::Apis::HealthcareV1::Hl7V2Store + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. + # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_hl7_v2_store_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::HealthcareV1::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::HealthcareV1::Policy::Representation + command.response_class = Google::Apis::HealthcareV1::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns permissions that a caller has on the specified resource. + # If the resource does not exist, this will return an empty set of + # permissions, not a NOT_FOUND error. + # Note: This operation is designed to be used for building permission-aware + # UIs and command-line tools, not for authorization checking. This operation + # may "fail open" without warning. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::HealthcareV1::TestIamPermissionsRequest] test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_hl7_v2_store_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::HealthcareV1::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::HealthcareV1::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::HealthcareV1::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a message and sends a notification to the Cloud Pub/Sub topic. If + # configured, the MLLP adapter listens to messages created by this method and + # sends those back to the hospital. A successful response indicates the + # message has been persisted to storage and a Cloud Pub/Sub notification has + # been sent. Sending to the hospital by the MLLP adapter happens + # asynchronously. + # @param [String] parent + # The name of the dataset this message belongs to. + # @param [Google::Apis::HealthcareV1::CreateMessageRequest] create_message_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Message] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Message] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_message(parent, create_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/messages', options) + command.request_representation = Google::Apis::HealthcareV1::CreateMessageRequest::Representation + command.request_object = create_message_request_object + command.response_representation = Google::Apis::HealthcareV1::Message::Representation + command.response_class = Google::Apis::HealthcareV1::Message + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an HL7v2 message. + # @param [String] name + # The resource name of the HL7v2 message to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_dataset_hl7_v2_store_message(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1::Empty::Representation + command.response_class = Google::Apis::HealthcareV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets an HL7v2 message. + # @param [String] name + # The resource name of the HL7v2 message to retrieve. + # @param [String] view + # Specifies which parts of the Message resource to return in the response. + # When unspecified, equivalent to FULL. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Message] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Message] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_hl7_v2_store_message(name, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1::Message::Representation + command.response_class = Google::Apis::HealthcareV1::Message + command.params['name'] = name unless name.nil? + command.query['view'] = view unless view.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Ingests a new HL7v2 message from the hospital and sends a notification to + # the Cloud Pub/Sub topic. Return is an HL7v2 ACK message if the message was + # successfully stored. Otherwise an error is returned. + # @param [String] parent + # The name of the HL7v2 store this message belongs to. + # @param [Google::Apis::HealthcareV1::IngestMessageRequest] ingest_message_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::IngestMessageResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::IngestMessageResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def ingest_message(parent, ingest_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/messages:ingest', options) + command.request_representation = Google::Apis::HealthcareV1::IngestMessageRequest::Representation + command.request_object = ingest_message_request_object + command.response_representation = Google::Apis::HealthcareV1::IngestMessageResponse::Representation + command.response_class = Google::Apis::HealthcareV1::IngestMessageResponse + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all the messages in the given HL7v2 store with support for filtering. + # Note: HL7v2 messages are indexed asynchronously, so there might be a slight + # delay between the time a message is created and when it can be found + # through a filter. + # @param [String] parent + # Name of the HL7v2 store to retrieve messages from. + # @param [String] filter + # Restricts messages returned to those matching a filter. Syntax: + # https://cloud.google.com/appengine/docs/standard/python/search/query_strings + # Fields/functions available for filtering are: + # * `message_type`, from the MSH-9.1 field. For example, + # `NOT message_type = "ADT"`. + # * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in + # the dataset's time_zone, from the MSH-7 segment. For example, + # `send_date < "2017-01-02"`. + # * `send_time`, the timestamp when the message was sent, using the + # RFC3339 time format for comparisons, from the MSH-7 segment. For example, + # `send_time < "2017-01-02T00:00:00-05:00"`. + # * `send_facility`, the care center that the message came from, from the + # MSH-4 segment. For example, `send_facility = "ABC"`. + # * `PatientId(value, type)`, which matches if the message lists a patient + # having an ID of the given value and type in the PID-2, PID-3, or PID-4 + # segments. For example, `PatientId("123456", "MRN")`. + # * `labels.x`, a string value of the label with key `x` as set using the + # Message.labels + # map. For example, `labels."priority"="high"`. The operator `:*` can be used + # to assert the existence of a label. For example, `labels."priority":*`. + # @param [String] order_by + # Orders messages returned by the specified order_by clause. + # Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order + # Fields available for ordering are: + # * `send_time` + # @param [Fixnum] page_size + # Limit on the number of messages to return in a single response. + # If zero the default page size of 100 is used. + # @param [String] page_token + # The next_page_token value returned from the previous List request, if any. + # @param [String] view + # Specifies the parts of the Message to return in the response. + # When unspecified, equivalent to BASIC. Setting this to anything other than + # BASIC with a `page_size` larger than the default can generate a large + # response, which impacts the performance of this method. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::ListMessagesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::ListMessagesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_dataset_hl7_v2_store_messages(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/messages', options) + command.response_representation = Google::Apis::HealthcareV1::ListMessagesResponse::Representation + command.response_class = Google::Apis::HealthcareV1::ListMessagesResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['view'] = view unless view.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Update the message. + # The contents of the message in Message.data and data extracted from + # the contents such as Message.create_time cannot be altered. Only the + # Message.labels field is allowed to be updated. The labels in the + # request are merged with the existing set of labels. Existing labels with + # the same keys are updated. + # @param [String] name + # Resource name of the Message, of the form + # `projects/`project_id`/datasets/`dataset_id`/hl7V2Stores/`hl7_v2_store_id`/ + # messages/`message_id``. + # Assigned by the server. + # @param [Google::Apis::HealthcareV1::Message] message_object + # @param [String] update_mask + # The update mask applies to the resource. For the `FieldMask` definition, + # see + # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# + # fieldmask + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Message] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Message] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_dataset_hl7_v2_store_message(name, message_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+name}', options) + command.request_representation = Google::Apis::HealthcareV1::Message::Representation + command.request_object = message_object + command.response_representation = Google::Apis::HealthcareV1::Message::Representation + command.response_class = Google::Apis::HealthcareV1::Message + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Starts asynchronous cancellation on a long-running operation. The server + # makes a best effort to cancel the operation, but success is not + # guaranteed. If the server doesn't support this method, it returns + # `google.rpc.Code.UNIMPLEMENTED`. Clients can use + # Operations.GetOperation or + # other methods to check whether the cancellation succeeded or whether the + # operation completed despite cancellation. On successful cancellation, + # the operation is not deleted; instead, it becomes an operation with + # an Operation.error value with a google.rpc.Status.code of 1, + # corresponding to `Code.CANCELLED`. + # @param [String] name + # The name of the operation resource to be cancelled. + # @param [Google::Apis::HealthcareV1::CancelOperationRequest] cancel_operation_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:cancel', options) + command.request_representation = Google::Apis::HealthcareV1::CancelOperationRequest::Representation + command.request_object = cancel_operation_request_object + command.response_representation = Google::Apis::HealthcareV1::Empty::Representation + command.response_class = Google::Apis::HealthcareV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of a long-running operation. Clients can use this + # method to poll the operation result at intervals as recommended by the API + # service. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::HealthcareV1::Operation::Representation + command.response_class = Google::Apis::HealthcareV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists operations that match the specified filter in the request. If the + # server doesn't support this method, it returns `UNIMPLEMENTED`. + # NOTE: the `name` binding allows API services to override the binding + # to use different resource name schemes, such as `users/*/operations`. To + # override the binding, API services can add a binding such as + # `"/v1/`name=users/*`/operations"` to their service configuration. + # For backwards compatibility, the default name includes the operations + # collection id, however overriding users must ensure the name binding + # is the parent resource, without the operations collection id. + # @param [String] name + # The name of the operation's parent resource. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1::ListOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1::ListOperationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_dataset_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}/operations', options) + command.response_representation = Google::Apis::HealthcareV1::ListOperationsResponse::Representation + command.response_class = Google::Apis::HealthcareV1::ListOperationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/healthcare_v1beta1.rb b/generated/google/apis/healthcare_v1beta1.rb index 61d0b88df..6999eaa8b 100644 --- a/generated/google/apis/healthcare_v1beta1.rb +++ b/generated/google/apis/healthcare_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/healthcare module HealthcareV1beta1 VERSION = 'V1beta1' - REVISION = '20200229' + REVISION = '20200327' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/healthcare_v1beta1/classes.rb b/generated/google/apis/healthcare_v1beta1/classes.rb index cd7df2b69..1e1e8bdb7 100644 --- a/generated/google/apis/healthcare_v1beta1/classes.rb +++ b/generated/google/apis/healthcare_v1beta1/classes.rb @@ -221,6 +221,19 @@ module Google end end + # The request message for Operations.CancelOperation. + class CancelOperationRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # Mask a string by replacing its characters with a fixed character. class CharacterMaskConfig include Google::Apis::Core::Hashable @@ -767,6 +780,19 @@ module Google end end + # Returns additional information in regards to a completed DICOM store export. + class ExportDicomDataResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # Request to export resources. class ExportResourcesRequest include Google::Apis::Core::Hashable @@ -901,6 +927,18 @@ module Google class FhirStore include Google::Apis::Core::Hashable + # If true, overrides the default search behavior for this FHIR store to + # `handling=strict` which returns an error for unrecognized search + # parameters. If false, uses the FHIR specification default + # `handling=lenient` which ignores unrecognized search parameters. + # The handling can always be changed from the default on an individual API + # call by setting the HTTP header `Prefer: handling=strict` or + # `Prefer: handling=lenient`. + # Corresponds to the JSON property `defaultSearchHandlingStrict` + # @return [Boolean] + attr_accessor :default_search_handling_strict + alias_method :default_search_handling_strict?, :default_search_handling_strict + # Whether to disable referential integrity in this FHIR store. This field is # immutable after FHIR store creation. # The default value is false, meaning that the API enforces referential @@ -966,6 +1004,24 @@ module Google # @return [Google::Apis::HealthcareV1beta1::NotificationConfig] attr_accessor :notification_config + # A list of streaming configs that configure the destinations of streaming + # export for every resource mutation in this FHIR store. Each store is + # allowed to have up to 10 streaming configs. + # After a new config is added, the next resource mutation is streamed to + # the new location in addition to the existing ones. + # When a location is removed from the list, the server stops + # streaming to that location. Before adding a new config, you must add the + # required + # [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control# + # bigquery.dataEditor) + # role to your project's **Cloud Healthcare Service Agent** + # [service account](https://cloud.google.com/iam/docs/service-accounts). + # Some lag (typically on the order of dozens of seconds) is expected before + # the results show up in the streaming destination. + # Corresponds to the JSON property `streamConfigs` + # @return [Array] + attr_accessor :stream_configs + # The FHIR specification version that this FHIR store supports natively. This # field is immutable after store creation. Requests are rejected if they # contain FHIR resources of a different version. @@ -980,16 +1036,64 @@ module Google # Update properties of this object def update!(**args) + @default_search_handling_strict = args[:default_search_handling_strict] if args.key?(:default_search_handling_strict) @disable_referential_integrity = args[:disable_referential_integrity] if args.key?(:disable_referential_integrity) @disable_resource_versioning = args[:disable_resource_versioning] if args.key?(:disable_resource_versioning) @enable_update_create = args[:enable_update_create] if args.key?(:enable_update_create) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @notification_config = args[:notification_config] if args.key?(:notification_config) + @stream_configs = args[:stream_configs] if args.key?(:stream_configs) @version = args[:version] if args.key?(:version) end end + # A (sub) field of a type. + class Field + include Google::Apis::Core::Hashable + + # The maximum number of times this field can be repeated. 0 or -1 means + # unbounded. + # Corresponds to the JSON property `maxOccurs` + # @return [Fixnum] + attr_accessor :max_occurs + + # The minimum number of times this field must be present/repeated. + # Corresponds to the JSON property `minOccurs` + # @return [Fixnum] + attr_accessor :min_occurs + + # The name of the field. For example, "PID-1" or just "1". + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The HL7v2 table this field refers to. For example, PID-15 (Patient's + # Primary Language) usually refers to table "0296". + # Corresponds to the JSON property `table` + # @return [String] + attr_accessor :table + + # The type of this field. A Type with this name must be defined in an + # Hl7TypesConfig. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @max_occurs = args[:max_occurs] if args.key?(:max_occurs) + @min_occurs = args[:min_occurs] if args.key?(:min_occurs) + @name = args[:name] if args.key?(:name) + @table = args[:table] if args.key?(:table) + @type = args[:type] if args.key?(:type) + end + end + # Specifies FHIR paths to match, and how to handle de-identification of # matching fields. class FieldMetadata @@ -1113,14 +1217,33 @@ module Google # Each file is written in the following format: # `.../`study_id`/`series_id`/`instance_id`[/`frame_number`].`extension`` # The frame_number component exists only for multi-frame instances. - # Refer to the DICOM conformance statement for permissible MIME types: - # https://cloud.google.com/healthcare/docs/dicom#retrieve_transaction + # Supported MIME types are consistent with supported formats in DICOMweb: + # https://cloud.google.com/healthcare/docs/dicom#retrieve_transaction. + # Specifically, the following are supported: + # - application/dicom; transfer-syntax=1.2.840.10008.1.2.1 + # (uncompressed DICOM) + # - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.50 + # (DICOM with embedded JPEG Baseline) + # - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.90 + # (DICOM with embedded JPEG 2000 Lossless Only) + # - application/dicom; transfer-syntax=1.2.840.10008.1.2.4.91 + # (DICOM with embedded JPEG 2000)h + # - application/dicom; transfer-syntax=* + # (DICOM with no transcoding) + # - application/octet-stream; transfer-syntax=1.2.840.10008.1.2.1 + # (raw uncompressed PixelData) + # - application/octet-stream; transfer-syntax=* + # (raw PixelData in whatever format it was uploaded in) + # - image/jpeg; transfer-syntax=1.2.840.10008.1.2.4.50 + # (Consumer JPEG) + # - image/png # The following extensions are used for output files: - # application/dicom -> .dcm - # image/jpeg -> .jpg - # image/png -> .png - # If unspecified, the instances are exported in their original - # DICOM format. + # - application/dicom -> .dcm + # - image/jpeg -> .jpg + # - image/png -> .png + # - application/octet-stream -> no extension + # If unspecified, the instances are exported in the original + # DICOM format they were uploaded in. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -1424,6 +1547,148 @@ module Google end end + # Construct representing a logical group or a segment. + class GroupOrSegment + include Google::Apis::Core::Hashable + + # An HL7v2 logical group construct. + # Corresponds to the JSON property `group` + # @return [Google::Apis::HealthcareV1beta1::SchemaGroup] + attr_accessor :group + + # An HL7v2 Segment. + # Corresponds to the JSON property `segment` + # @return [Google::Apis::HealthcareV1beta1::SchemaSegment] + attr_accessor :segment + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @group = args[:group] if args.key?(:group) + @segment = args[:segment] if args.key?(:segment) + end + end + + # Root config message for HL7v2 schema. This contains a schema structure of + # groups and segments, and filters that determine which messages to apply the + # schema structure to. + class Hl7SchemaConfig + include Google::Apis::Core::Hashable + + # Map from each HL7v2 message type and trigger event pair, such as ADT_A04, + # to its schema configuration root group. + # Corresponds to the JSON property `messageSchemaConfigs` + # @return [Hash] + attr_accessor :message_schema_configs + + # Each VersionSource is tested and only if they all match is the schema used + # for the message. + # Corresponds to the JSON property `version` + # @return [Array] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @message_schema_configs = args[:message_schema_configs] if args.key?(:message_schema_configs) + @version = args[:version] if args.key?(:version) + end + end + + # Root config for HL7v2 datatype definitions for a specific HL7v2 version. + class Hl7TypesConfig + include Google::Apis::Core::Hashable + + # The HL7v2 type definitions. + # Corresponds to the JSON property `type` + # @return [Array] + attr_accessor :type + + # The version selectors that this config applies to. A message must match + # ALL version sources to apply. + # Corresponds to the JSON property `version` + # @return [Array] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @type = args[:type] if args.key?(:type) + @version = args[:version] if args.key?(:version) + end + end + + # Specifies where and whether to send notifications upon changes to a + # data store. + class Hl7V2NotificationConfig + include Google::Apis::Core::Hashable + + # Restricts notifications sent for messages matching a filter. If this is + # empty, all messages are matched. Syntax: + # https://cloud.google.com/appengine/docs/standard/python/search/query_strings + # Fields/functions available for filtering are: + # * `message_type`, from the MSH-9.1 field. For example, + # `NOT message_type = "ADT"`. + # * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in + # the dataset's time_zone, from the MSH-7 segment. For example, + # `send_date < "2017-01-02"`. + # * `send_time`, the timestamp when the message was sent, using the + # RFC3339 time format for comparisons, from the MSH-7 segment. For example, + # `send_time < "2017-01-02T00:00:00-05:00"`. + # * `send_facility`, the care center that the message came from, from the + # MSH-4 segment. For example, `send_facility = "ABC"`. + # * `PatientId(value, type)`, which matches if the message lists a patient + # having an ID of the given value and type in the PID-2, PID-3, or PID-4 + # segments. For example, `PatientId("123456", "MRN")`. + # * `labels.x`, a string value of the label with key `x` as set using the + # Message.labels + # map. For example, `labels."priority"="high"`. The operator `:*` can be + # used to assert the existence of a label. For example, + # `labels."priority":*`. + # Corresponds to the JSON property `filter` + # @return [String] + attr_accessor :filter + + # The [Cloud Pubsub](https://cloud.google.com/pubsub/docs/) topic that + # notifications of changes are published on. Supplied by the client. The + # notification is a `PubsubMessage` with the following fields: + # * `PubsubMessage.Data` contains the resource name. + # * `PubsubMessage.MessageId` is the ID of this notification. It is + # guaranteed to be unique within the topic. + # * `PubsubMessage.PublishTime` is the time at which the message was + # published. + # Note that notifications are only sent if the topic is non-empty. [Topic + # names](https://cloud.google.com/pubsub/docs/overview#names) must be + # scoped to a project. cloud-healthcare@system.gserviceaccount.com must + # have publisher permissions on the given Pubsub topic. Not having adequate + # permissions causes the calls that send notifications to fail. + # If a notification cannot be published to Cloud Pub/Sub, errors will be + # logged to Stackdriver (see [Viewing logs](/healthcare/docs/how- + # tos/stackdriver-logging)). + # Corresponds to the JSON property `pubsubTopic` + # @return [String] + attr_accessor :pubsub_topic + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @filter = args[:filter] if args.key?(:filter) + @pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic) + end + end + # Represents an HL7v2 store. class Hl7V2Store include Google::Apis::Core::Hashable @@ -1452,6 +1717,14 @@ module Google # @return [Google::Apis::HealthcareV1beta1::NotificationConfig] attr_accessor :notification_config + # A list of notification configs. Each configuration uses a filter to + # determine whether to publish a message (both Ingest & Create) on + # the corresponding notification destination. Only the message name is sent + # as part of the notification. Supplied by the client. + # Corresponds to the JSON property `notificationConfigs` + # @return [Array] + attr_accessor :notification_configs + # The configuration for the parser. It determines how the server parses the # messages. # Corresponds to the JSON property `parserConfig` @@ -1483,6 +1756,7 @@ module Google @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @notification_config = args[:notification_config] if args.key?(:notification_config) + @notification_configs = args[:notification_configs] if args.key?(:notification_configs) @parser_config = args[:parser_config] if args.key?(:parser_config) @reject_duplicate_message = args[:reject_duplicate_message] if args.key?(:reject_duplicate_message) end @@ -1611,6 +1885,19 @@ module Google end end + # Returns additional information in regards to a completed DICOM store import. + class ImportDicomDataResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # Request to import resources. class ImportResourcesRequest include Google::Apis::Core::Hashable @@ -1669,7 +1956,7 @@ module Google attr_accessor :info_types # Define how to redact sensitive values. Default behaviour is erase. - # For example, "My name is Jake." becomes "My name is ." + # For example, "My name is Jane." becomes "My name is ." # Corresponds to the JSON property `redactConfig` # @return [Google::Apis::HealthcareV1beta1::RedactConfig] attr_accessor :redact_config @@ -1677,7 +1964,7 @@ module Google # When using the # INSPECT_AND_TRANSFORM # action, each match is replaced with the name of the info_type. For example, - # "My name is Jake" becomes "My name is [PERSON_NAME]." The + # "My name is Jane" becomes "My name is [PERSON_NAME]." The # TRANSFORM # action is equivalent to redacting. # Corresponds to the JSON property `replaceWithInfoTypeConfig` @@ -1893,13 +2180,6 @@ module Google # @return [Array] attr_accessor :hl7_v2_messages - # Deprecated. Use `hl7_v2_messages` instead. - # The returned message names. Won't be more values than the value of - # page_size in the request. - # Corresponds to the JSON property `messages` - # @return [Array] - attr_accessor :messages - # Token to retrieve the next page of results or empty if there are no more # results in the list. # Corresponds to the JSON property `nextPageToken` @@ -1913,7 +2193,6 @@ module Google # Update properties of this object def update!(**args) @hl7_v2_messages = args[:hl7_v2_messages] if args.key?(:hl7_v2_messages) - @messages = args[:messages] if args.key?(:messages) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end @@ -2020,7 +2299,7 @@ module Google # @return [Hash] attr_accessor :labels - # The message type and trigger event for this message. MSH-9. + # The message type for this message. MSH-9.1. # Corresponds to the JSON property `messageType` # @return [String] attr_accessor :message_type @@ -2033,7 +2312,7 @@ module Google # @return [String] attr_accessor :name - # The content of a HL7v2 message in a structured format. + # The content of an HL7v2 message in a structured format. # Corresponds to the JSON property `parsedData` # @return [Google::Apis::HealthcareV1beta1::ParsedData] attr_accessor :parsed_data @@ -2044,6 +2323,12 @@ module Google # @return [Array] attr_accessor :patient_ids + # The content of an HL7v2 message in a structured format as specified by a + # schema. + # Corresponds to the JSON property `schematizedData` + # @return [Google::Apis::HealthcareV1beta1::SchematizedData] + attr_accessor :schematized_data + # The hospital that this message came from. MSH-4. # Corresponds to the JSON property `sendFacility` # @return [String] @@ -2067,6 +2352,7 @@ module Google @name = args[:name] if args.key?(:name) @parsed_data = args[:parsed_data] if args.key?(:parsed_data) @patient_ids = args[:patient_ids] if args.key?(:patient_ids) + @schematized_data = args[:schematized_data] if args.key?(:schematized_data) @send_facility = args[:send_facility] if args.key?(:send_facility) @send_time = args[:send_time] if args.key?(:send_time) end @@ -2180,6 +2466,12 @@ module Google # @return [String] attr_accessor :api_method_name + # Specifies if cancellation was requested for the operation. + # Corresponds to the JSON property `cancelRequested` + # @return [Boolean] + attr_accessor :cancel_requested + alias_method :cancel_requested?, :cancel_requested + # ProgressCounter provides counters to describe an operation's progress. # Corresponds to the JSON property `counter` # @return [Google::Apis::HealthcareV1beta1::ProgressCounter] @@ -2195,6 +2487,13 @@ module Google # @return [String] attr_accessor :end_time + # A link to audit and error logs in the log viewer. Error logs are generated + # only by some operations, listed at + # https://cloud.google.com/healthcare/docs/how-tos/stackdriver-logging. + # Corresponds to the JSON property `logsUrl` + # @return [String] + attr_accessor :logs_url + def initialize(**args) update!(**args) end @@ -2202,13 +2501,15 @@ module Google # Update properties of this object def update!(**args) @api_method_name = args[:api_method_name] if args.key?(:api_method_name) + @cancel_requested = args[:cancel_requested] if args.key?(:cancel_requested) @counter = args[:counter] if args.key?(:counter) @create_time = args[:create_time] if args.key?(:create_time) @end_time = args[:end_time] if args.key?(:end_time) + @logs_url = args[:logs_url] if args.key?(:logs_url) end end - # The content of a HL7v2 message in a structured format. + # The content of an HL7v2 message in a structured format. class ParsedData include Google::Apis::Core::Hashable @@ -2238,8 +2539,14 @@ module Google attr_accessor :allow_null_header alias_method :allow_null_header?, :allow_null_header + # A schema package contains a set of schemas and type definitions. + # Corresponds to the JSON property `schema` + # @return [Google::Apis::HealthcareV1beta1::SchemaPackage] + attr_accessor :schema + # Byte(s) to use as the segment terminator. If this is unset, '\r' is - # used as segment terminator. + # used as segment terminator, matching the HL7 version 2 + # specification. # Corresponds to the JSON property `segmentTerminator` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -2252,6 +2559,7 @@ module Google # Update properties of this object def update!(**args) @allow_null_header = args[:allow_null_header] if args.key?(:allow_null_header) + @schema = args[:schema] if args.key?(:schema) @segment_terminator = args[:segment_terminator] if args.key?(:segment_terminator) end end @@ -2433,7 +2741,7 @@ module Google end # Define how to redact sensitive values. Default behaviour is erase. - # For example, "My name is Jake." becomes "My name is ." + # For example, "My name is Jane." becomes "My name is ." class RedactConfig include Google::Apis::Core::Hashable @@ -2449,7 +2757,7 @@ module Google # When using the # INSPECT_AND_TRANSFORM # action, each match is replaced with the name of the info_type. For example, - # "My name is Jake" becomes "My name is [PERSON_NAME]." The + # "My name is Jane" becomes "My name is [PERSON_NAME]." The # TRANSFORM # action is equivalent to redacting. class ReplaceWithInfoTypeConfig @@ -2515,6 +2823,156 @@ module Google end end + # An HL7v2 logical group construct. + class SchemaGroup + include Google::Apis::Core::Hashable + + # True indicates that this is a choice group, meaning that only one of its + # segments can exist in a given message. + # Corresponds to the JSON property `choice` + # @return [Boolean] + attr_accessor :choice + alias_method :choice?, :choice + + # The maximum number of times this group can be repeated. 0 or -1 means + # unbounded. + # Corresponds to the JSON property `maxOccurs` + # @return [Fixnum] + attr_accessor :max_occurs + + # Nested groups and/or segments. + # Corresponds to the JSON property `members` + # @return [Array] + attr_accessor :members + + # The minimum number of times this group must be present/repeated. + # Corresponds to the JSON property `minOccurs` + # @return [Fixnum] + attr_accessor :min_occurs + + # The name of this group. For example, "ORDER_DETAIL". + # 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) + @choice = args[:choice] if args.key?(:choice) + @max_occurs = args[:max_occurs] if args.key?(:max_occurs) + @members = args[:members] if args.key?(:members) + @min_occurs = args[:min_occurs] if args.key?(:min_occurs) + @name = args[:name] if args.key?(:name) + end + end + + # A schema package contains a set of schemas and type definitions. + class SchemaPackage + include Google::Apis::Core::Hashable + + # Flag to ignore all min_occurs restrictions in the schema. This means that + # incoming messages can omit any group, segment, field, component, or + # subcomponent. + # Corresponds to the JSON property `ignoreMinOccurs` + # @return [Boolean] + attr_accessor :ignore_min_occurs + alias_method :ignore_min_occurs?, :ignore_min_occurs + + # Schema configs that are layered based on their VersionSources that + # match the incoming message. Schema configs present in higher indices + # override those in lower indices with the same message type and trigger + # event if their VersionSources all match an incoming message. + # Corresponds to the JSON property `schemas` + # @return [Array] + attr_accessor :schemas + + # Determines how messages that don't parse successfully are handled. + # Corresponds to the JSON property `schematizedParsingType` + # @return [String] + attr_accessor :schematized_parsing_type + + # Schema type definitions that are layered based on their VersionSources + # that match the incoming message. Type definitions present in higher indices + # override those in lower indices with the same type name if their + # VersionSources all match an incoming message. + # Corresponds to the JSON property `types` + # @return [Array] + attr_accessor :types + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ignore_min_occurs = args[:ignore_min_occurs] if args.key?(:ignore_min_occurs) + @schemas = args[:schemas] if args.key?(:schemas) + @schematized_parsing_type = args[:schematized_parsing_type] if args.key?(:schematized_parsing_type) + @types = args[:types] if args.key?(:types) + end + end + + # An HL7v2 Segment. + class SchemaSegment + include Google::Apis::Core::Hashable + + # The maximum number of times this segment can be present in this group. + # 0 or -1 means unbounded. + # Corresponds to the JSON property `maxOccurs` + # @return [Fixnum] + attr_accessor :max_occurs + + # The minimum number of times this segment can be present in this group. + # Corresponds to the JSON property `minOccurs` + # @return [Fixnum] + attr_accessor :min_occurs + + # The Segment type. For example, "PID". + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @max_occurs = args[:max_occurs] if args.key?(:max_occurs) + @min_occurs = args[:min_occurs] if args.key?(:min_occurs) + @type = args[:type] if args.key?(:type) + end + end + + # The content of an HL7v2 message in a structured format as specified by a + # schema. + class SchematizedData + include Google::Apis::Core::Hashable + + # JSON output of the parser. + # Corresponds to the JSON property `data` + # @return [String] + attr_accessor :data + + # The error output of the parser. + # Corresponds to the JSON property `error` + # @return [String] + attr_accessor :error + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @data = args[:data] if args.key?(:data) + @error = args[:error] if args.key?(:error) + end + end + # Request to search the resources in the specified FHIR store. class SearchResourcesRequest include Google::Apis::Core::Hashable @@ -2704,6 +3162,35 @@ module Google end end + # This structure contains configuration for streaming FHIR export. + class StreamConfig + include Google::Apis::Core::Hashable + + # The configuration for exporting to BigQuery. + # Corresponds to the JSON property `bigqueryDestination` + # @return [Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1FhirBigQueryDestination] + attr_accessor :bigquery_destination + + # Supply a FHIR resource type (such as "Patient" or "Observation"). + # See https://www.hl7.org/fhir/valueset-resource-types.html for a list of + # all FHIR resource types. + # The server treats an empty list as an intent to stream all the + # supported resource types in this FHIR store. + # Corresponds to the JSON property `resourceTypes` + # @return [Array] + attr_accessor :resource_types + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bigquery_destination = args[:bigquery_destination] if args.key?(:bigquery_destination) + @resource_types = args[:resource_types] if args.key?(:resource_types) + end + end + # List of tags to be filtered. class TagFilterList include Google::Apis::Core::Hashable @@ -2787,6 +3274,65 @@ module Google @transformations = args[:transformations] if args.key?(:transformations) end end + + # A type definition for some HL7v2 type (incl. Segments and Datatypes). + class Type + include Google::Apis::Core::Hashable + + # The (sub) fields this type has (if not primitive). + # Corresponds to the JSON property `fields` + # @return [Array] + attr_accessor :fields + + # The name of this type. This would be the segment or datatype name. + # For example, "PID" or "XPN". + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # If this is a primitive type then this field is the type of the primitive + # For example, STRING. Leave unspecified for composite types. + # Corresponds to the JSON property `primitive` + # @return [String] + attr_accessor :primitive + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fields = args[:fields] if args.key?(:fields) + @name = args[:name] if args.key?(:name) + @primitive = args[:primitive] if args.key?(:primitive) + end + end + + # Describes a selector for extracting and matching an MSH field to a value. + class VersionSource + include Google::Apis::Core::Hashable + + # The field to extract from the MSH segment. For example, "3.1" or "18[1].1". + # Corresponds to the JSON property `mshField` + # @return [String] + attr_accessor :msh_field + + # The value to match with the field. For example, "My Application Name" or + # "2.3". + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @msh_field = args[:msh_field] if args.key?(:msh_field) + @value = args[:value] if args.key?(:value) + end + end end end end diff --git a/generated/google/apis/healthcare_v1beta1/representations.rb b/generated/google/apis/healthcare_v1beta1/representations.rb index dc27021f8..abcc8e723 100644 --- a/generated/google/apis/healthcare_v1beta1/representations.rb +++ b/generated/google/apis/healthcare_v1beta1/representations.rb @@ -40,6 +40,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class CancelOperationRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CharacterMaskConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -142,6 +148,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ExportDicomDataResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ExportResourcesRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -172,6 +184,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Field + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class FieldMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -250,6 +268,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GroupOrSegment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Hl7SchemaConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Hl7TypesConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Hl7V2NotificationConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Hl7V2Store class Representation < Google::Apis::Core::JsonRepresentation; end @@ -280,6 +322,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ImportDicomDataResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ImportResourcesRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -430,6 +478,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class SchemaGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SchemaPackage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SchemaSegment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SchematizedData + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SearchResourcesRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -454,6 +526,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class StreamConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class TagFilterList class Representation < Google::Apis::Core::JsonRepresentation; end @@ -478,6 +556,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Type + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class VersionSource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class AuditConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -505,6 +595,12 @@ module Google end end + class CancelOperationRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class CharacterMaskConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -660,6 +756,12 @@ module Google end end + class ExportDicomDataResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class ExportResourcesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -699,6 +801,7 @@ module Google class FhirStore # @private class Representation < Google::Apis::Core::JsonRepresentation + property :default_search_handling_strict, as: 'defaultSearchHandlingStrict' property :disable_referential_integrity, as: 'disableReferentialIntegrity' property :disable_resource_versioning, as: 'disableResourceVersioning' property :enable_update_create, as: 'enableUpdateCreate' @@ -706,10 +809,23 @@ module Google property :name, as: 'name' property :notification_config, as: 'notificationConfig', class: Google::Apis::HealthcareV1beta1::NotificationConfig, decorator: Google::Apis::HealthcareV1beta1::NotificationConfig::Representation + collection :stream_configs, as: 'streamConfigs', class: Google::Apis::HealthcareV1beta1::StreamConfig, decorator: Google::Apis::HealthcareV1beta1::StreamConfig::Representation + property :version, as: 'version' end end + class Field + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :max_occurs, as: 'maxOccurs' + property :min_occurs, as: 'minOccurs' + property :name, as: 'name' + property :table, as: 'table' + property :type, as: 'type' + end + end + class FieldMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -816,6 +932,44 @@ module Google end end + class GroupOrSegment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :group, as: 'group', class: Google::Apis::HealthcareV1beta1::SchemaGroup, decorator: Google::Apis::HealthcareV1beta1::SchemaGroup::Representation + + property :segment, as: 'segment', class: Google::Apis::HealthcareV1beta1::SchemaSegment, decorator: Google::Apis::HealthcareV1beta1::SchemaSegment::Representation + + end + end + + class Hl7SchemaConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :message_schema_configs, as: 'messageSchemaConfigs', class: Google::Apis::HealthcareV1beta1::SchemaGroup, decorator: Google::Apis::HealthcareV1beta1::SchemaGroup::Representation + + collection :version, as: 'version', class: Google::Apis::HealthcareV1beta1::VersionSource, decorator: Google::Apis::HealthcareV1beta1::VersionSource::Representation + + end + end + + class Hl7TypesConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :type, as: 'type', class: Google::Apis::HealthcareV1beta1::Type, decorator: Google::Apis::HealthcareV1beta1::Type::Representation + + collection :version, as: 'version', class: Google::Apis::HealthcareV1beta1::VersionSource, decorator: Google::Apis::HealthcareV1beta1::VersionSource::Representation + + end + end + + class Hl7V2NotificationConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :filter, as: 'filter' + property :pubsub_topic, as: 'pubsubTopic' + end + end + class Hl7V2Store # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -823,6 +977,8 @@ module Google property :name, as: 'name' property :notification_config, as: 'notificationConfig', class: Google::Apis::HealthcareV1beta1::NotificationConfig, decorator: Google::Apis::HealthcareV1beta1::NotificationConfig::Representation + collection :notification_configs, as: 'notificationConfigs', class: Google::Apis::HealthcareV1beta1::Hl7V2NotificationConfig, decorator: Google::Apis::HealthcareV1beta1::Hl7V2NotificationConfig::Representation + property :parser_config, as: 'parserConfig', class: Google::Apis::HealthcareV1beta1::ParserConfig, decorator: Google::Apis::HealthcareV1beta1::ParserConfig::Representation property :reject_duplicate_message, as: 'rejectDuplicateMessage' @@ -861,6 +1017,12 @@ module Google end end + class ImportDicomDataResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class ImportResourcesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -954,7 +1116,6 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :hl7_v2_messages, as: 'hl7V2Messages', class: Google::Apis::HealthcareV1beta1::Message, decorator: Google::Apis::HealthcareV1beta1::Message::Representation - collection :messages, as: 'messages' property :next_page_token, as: 'nextPageToken' end end @@ -991,6 +1152,8 @@ module Google collection :patient_ids, as: 'patientIds', class: Google::Apis::HealthcareV1beta1::PatientId, decorator: Google::Apis::HealthcareV1beta1::PatientId::Representation + property :schematized_data, as: 'schematizedData', class: Google::Apis::HealthcareV1beta1::SchematizedData, decorator: Google::Apis::HealthcareV1beta1::SchematizedData::Representation + property :send_facility, as: 'sendFacility' property :send_time, as: 'sendTime' end @@ -1019,10 +1182,12 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :api_method_name, as: 'apiMethodName' + property :cancel_requested, as: 'cancelRequested' property :counter, as: 'counter', class: Google::Apis::HealthcareV1beta1::ProgressCounter, decorator: Google::Apis::HealthcareV1beta1::ProgressCounter::Representation property :create_time, as: 'createTime' property :end_time, as: 'endTime' + property :logs_url, as: 'logsUrl' end end @@ -1038,6 +1203,8 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :allow_null_header, as: 'allowNullHeader' + property :schema, as: 'schema', class: Google::Apis::HealthcareV1beta1::SchemaPackage, decorator: Google::Apis::HealthcareV1beta1::SchemaPackage::Representation + property :segment_terminator, :base64 => true, as: 'segmentTerminator' end end @@ -1098,6 +1265,47 @@ module Google end end + class SchemaGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :choice, as: 'choice' + property :max_occurs, as: 'maxOccurs' + collection :members, as: 'members', class: Google::Apis::HealthcareV1beta1::GroupOrSegment, decorator: Google::Apis::HealthcareV1beta1::GroupOrSegment::Representation + + property :min_occurs, as: 'minOccurs' + property :name, as: 'name' + end + end + + class SchemaPackage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ignore_min_occurs, as: 'ignoreMinOccurs' + collection :schemas, as: 'schemas', class: Google::Apis::HealthcareV1beta1::Hl7SchemaConfig, decorator: Google::Apis::HealthcareV1beta1::Hl7SchemaConfig::Representation + + property :schematized_parsing_type, as: 'schematizedParsingType' + collection :types, as: 'types', class: Google::Apis::HealthcareV1beta1::Hl7TypesConfig, decorator: Google::Apis::HealthcareV1beta1::Hl7TypesConfig::Representation + + end + end + + class SchemaSegment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :max_occurs, as: 'maxOccurs' + property :min_occurs, as: 'minOccurs' + property :type, as: 'type' + end + end + + class SchematizedData + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :data, as: 'data' + property :error, as: 'error' + end + end + class SearchResourcesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1132,6 +1340,15 @@ module Google end end + class StreamConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bigquery_destination, as: 'bigqueryDestination', class: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1FhirBigQueryDestination, decorator: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1FhirBigQueryDestination::Representation + + collection :resource_types, as: 'resourceTypes' + end + end + class TagFilterList # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1160,6 +1377,24 @@ module Google end end + + class Type + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :fields, as: 'fields', class: Google::Apis::HealthcareV1beta1::Field, decorator: Google::Apis::HealthcareV1beta1::Field::Representation + + property :name, as: 'name' + property :primitive, as: 'primitive' + end + end + + class VersionSource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :msh_field, as: 'mshField' + property :value, as: 'value' + end + end end end end diff --git a/generated/google/apis/healthcare_v1beta1/service.rb b/generated/google/apis/healthcare_v1beta1/service.rb index 2371fb796..08a189713 100644 --- a/generated/google/apis/healthcare_v1beta1/service.rb +++ b/generated/google/apis/healthcare_v1beta1/service.rb @@ -170,7 +170,11 @@ module Google # error # details field type is # DeidentifyErrorDetails. - # Errors are also logged to Stackdriver Logging. For more information, + # The LRO result may still be successful if de-identification fails for some + # DICOM instances. The new de-identified dataset will not contain these + # failed resources. Failed resource totals are tracked in + # DeidentifySummary.failure_resource_count. + # Error details are also logged to Stackdriver Logging. For more information, # see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). # @param [String] source_dataset # Source dataset resource name. For example, @@ -625,7 +629,11 @@ module Google # error # details field type is # DeidentifyErrorDetails. - # Errors are also logged to Stackdriver + # The LRO result may still be successful if de-identification fails for some + # DICOM instances. The output DICOM store will not contain + # these failed resources. Failed resource totals are tracked in + # DeidentifySummary.failure_resource_count. + # Error details are also logged to Stackdriver # (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). # @param [String] source_store # Source DICOM store resource name. For example, @@ -694,6 +702,8 @@ module Google # Exports data to the specified destination by copying it from the DICOM # store. + # Errors are also logged to Stackdriver Logging. For more information, + # see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging). # The metadata field type is # OperationMetadata. # @param [String] name @@ -2012,6 +2022,8 @@ module Google # if the input data contains invalid references or if some resources fail to # be imported, the FHIR store might be left in a state that violates # referential integrity. + # The import process does not trigger PubSub notification or BigQuery + # streaming update, regardless of how those are configured on the FHIR store. # If a resource with the specified ID already exists, the most recent # version of the resource is overwritten without creating a new historical # version, regardless of the @@ -2172,6 +2184,92 @@ module Google execute_or_queue_command(command, &block) end + # Searches for resources in the given FHIR store according to criteria + # specified as query parameters. + # Implements the FHIR standard search interaction + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), + # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) + # using the search semantics described in the FHIR Search specification + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), + # [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). + # Supports three methods of search defined by the specification: + # * `GET [base]?[parameters]` to search across all resources. + # * `GET [base]/[type]?[parameters]` to search resources of a specified + # type. + # * `POST [base]/[type]/_search?[parameters]` as an alternate form having + # the same semantics as the `GET` method. + # The `GET` methods do not support compartment searches. The `POST` method + # does not support `application/x-www-form-urlencoded` search parameters. + # On success, the response body will contain a JSON-encoded representation + # of a `Bundle` resource of type `searchset`, containing the results of the + # search. + # Errors generated by the FHIR store will contain a JSON-encoded + # `OperationOutcome` resource describing the reason for the error. If the + # request cannot be mapped to a valid API method on a FHIR store, a generic + # GCP error might be returned instead. + # The server's capability statement, retrieved through + # capabilities, indicates what search parameters + # are supported on each FHIR resource. A list of all search parameters + # defined by the specification can be found in the FHIR Search Parameter + # Registry + # ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry. + # html), + # [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)) + # . + # FHIR search parameters for DSTU2 can be found on each resource's definition + # page. + # Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, + # `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. + # Supported search result parameters: `_sort`, `_count`, `_include`, + # `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. + # The maximum number of search results returned defaults to 100, which can + # be overridden by the `_count` parameter up to a maximum limit of 1000. If + # there are additional results, the returned `Bundle` will contain + # pagination links. + # Resources with a total size larger than 5MB or a field count larger than + # 50,000 might not be fully searchable as the server might trim its generated + # search index in those cases. + # Note: FHIR resources are indexed asynchronously, so there might be a slight + # delay between the time a resource is created or changes and when the change + # is reflected in search results. + # @param [String] parent + # Name of the FHIR store to retrieve resources from. + # @param [String] resource_type + # The FHIR resource type to search, such as Patient or Observation. For a + # complete list, see the FHIR Resource Index + # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), + # [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), + # [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1beta1::HttpBody] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1beta1::HttpBody] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_location_dataset_fhir_stores(parent, resource_type: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/fhir', options) + command.response_representation = Google::Apis::HealthcareV1beta1::HttpBody::Representation + command.response_class = Google::Apis::HealthcareV1beta1::HttpBody + command.params['parent'] = parent unless parent.nil? + command.query['resourceType'] = resource_type unless resource_type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Sets the access control policy on the specified resource. Replaces any # existing policy. # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED @@ -2847,7 +2945,7 @@ module Google # in a [JSON Patch](http://jsonpatch.com/) document. # Implements the FHIR standard patch interaction # ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#patch), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#patch)]). + # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#patch)). # DSTU2 doesn't define a patch method, but the server supports it in the same # way it supports STU3. # The request body must contain a JSON Patch document, and the request @@ -3553,7 +3651,7 @@ module Google # Restricts messages returned to those matching a filter. Syntax: # https://cloud.google.com/appengine/docs/standard/python/search/query_strings # Fields/functions available for filtering are: - # * `message_type`, from the MSH-9 segment. For example, + # * `message_type`, from the MSH-9.1 field. For example, # `NOT message_type = "ADT"`. # * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in # the dataset's time_zone, from the MSH-7 segment. For example, @@ -3570,19 +3668,6 @@ module Google # Message.labels # map. For example, `labels."priority"="high"`. The operator `:*` can be used # to assert the existence of a label. For example, `labels."priority":*`. - # Limitations on conjunctions: - # * Negation on the patient ID function or the labels field is not - # supported. For example, these queries are invalid: - # `NOT PatientId("123456", "MRN")`, `NOT labels."tag1":*`, - # `NOT labels."tag2"="val2"`. - # * Conjunction of multiple patient ID functions is not supported, for - # example this query is invalid: - # `PatientId("123456", "MRN") AND PatientId("456789", "MRN")`. - # * Conjunction of multiple labels fields is also not supported, for - # example this query is invalid: `labels."tag1":* AND labels."tag2"="val2"`. - # * Conjunction of one patient ID function, one labels field and conditions - # on other fields is supported. For example, this query is valid: - # `PatientId("123456", "MRN") AND labels."tag1":* AND message_type = "ADT"`. # @param [String] order_by # Orders messages returned by the specified order_by clause. # Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order @@ -3595,7 +3680,9 @@ module Google # The next_page_token value returned from the previous List request, if any. # @param [String] view # Specifies the parts of the Message to return in the response. - # When unspecified, equivalent to BASIC. + # When unspecified, equivalent to BASIC. Setting this to anything other than + # BASIC with a `page_size` larger than the default can generate a large + # response, which impacts the performance of this method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3675,6 +3762,48 @@ module Google execute_or_queue_command(command, &block) end + # Starts asynchronous cancellation on a long-running operation. The server + # makes a best effort to cancel the operation, but success is not + # guaranteed. If the server doesn't support this method, it returns + # `google.rpc.Code.UNIMPLEMENTED`. Clients can use + # Operations.GetOperation or + # other methods to check whether the cancellation succeeded or whether the + # operation completed despite cancellation. On successful cancellation, + # the operation is not deleted; instead, it becomes an operation with + # an Operation.error value with a google.rpc.Status.code of 1, + # corresponding to `Code.CANCELLED`. + # @param [String] name + # The name of the operation resource to be cancelled. + # @param [Google::Apis::HealthcareV1beta1::CancelOperationRequest] cancel_operation_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::HealthcareV1beta1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::HealthcareV1beta1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options) + command.request_representation = Google::Apis::HealthcareV1beta1::CancelOperationRequest::Representation + command.request_object = cancel_operation_request_object + command.response_representation = Google::Apis::HealthcareV1beta1::Empty::Representation + command.response_class = Google::Apis::HealthcareV1beta1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Gets the latest state of a long-running operation. Clients can use this # method to poll the operation result at intervals as recommended by the API # service. diff --git a/generated/google/apis/homegraph_v1.rb b/generated/google/apis/homegraph_v1.rb index b765419d9..fb1501ec7 100644 --- a/generated/google/apis/homegraph_v1.rb +++ b/generated/google/apis/homegraph_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/actions/smarthome/create-app#request-sync module HomegraphV1 VERSION = 'V1' - REVISION = '20200219' + REVISION = '20200407' end end end diff --git a/generated/google/apis/homegraph_v1/classes.rb b/generated/google/apis/homegraph_v1/classes.rb index 5880ca08d..83aef3f57 100644 --- a/generated/google/apis/homegraph_v1/classes.rb +++ b/generated/google/apis/homegraph_v1/classes.rb @@ -22,11 +22,11 @@ module Google module Apis module HomegraphV1 - # Third-party partner's device ID for one device. + # Third-party device ID for one device. class AgentDeviceId include Google::Apis::Core::Hashable - # Third-party partner's device ID. + # Third-party device ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -41,16 +41,16 @@ module Google end end - # Identifies a device in the third party or first party system. + # Alternate third-party device ID. class AgentOtherDeviceId include Google::Apis::Core::Hashable - # The agent's ID. Generally it is the agent's AoG project id. + # Project ID for your smart home Action. # Corresponds to the JSON property `agentId` # @return [String] attr_accessor :agent_id - # Device ID defined by the agent. The device_id must be unique. + # Unique third-party device ID. # Corresponds to the JSON property `deviceId` # @return [String] attr_accessor :device_id @@ -66,7 +66,7 @@ module Google end end - # Third-party partner's device definition. + # Third-party device definition. class Device include Google::Apis::Core::Hashable @@ -75,8 +75,14 @@ module Google # @return [Hash] attr_accessor :attributes - # Custom JSON data provided by the manufacturer and attached to QUERY and - # EXECUTE requests in AoG. + # Custom device attributes stored in Home Graph and provided to your + # smart home Action in each + # [QUERY](https://developers.google.com/assistant/smarthome/reference/intent/ + # query) + # and + # [EXECUTE](https://developers.google.com/assistant/smarthome/reference/intent/ + # execute) + # intent. # Corresponds to the JSON property `customData` # @return [Hash] attr_accessor :custom_data @@ -86,62 +92,61 @@ module Google # @return [Google::Apis::HomegraphV1::DeviceInfo] attr_accessor :device_info - # Third-party partner's device ID. + # Third-party device ID. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Different names for the device. + # Identifiers used to describe the device. # Corresponds to the JSON property `name` # @return [Google::Apis::HomegraphV1::DeviceNames] attr_accessor :name - # Indicates whether the device is capable of sending notifications. This - # field will be set by the agent (partner) on an incoming SYNC. If a device - # is not capable of generating notifications, the partner should set this - # flag to false. If a partner is not capable of calling - # ReportStateAndNotification to send notifications to Google, the partner - # should set this flag to false. If there is a user setting in the partner - # app to enable notifications and it is turned off, the partner should set - # this flag to false. + # Indicates whether your smart home Action will report notifications + # to Google for this device via ReportStateAndNotification. + # If your smart home Action enables users to control device notifications, + # you should update this field and call RequestSyncDevices. # Corresponds to the JSON property `notificationSupportedByAgent` # @return [Boolean] attr_accessor :notification_supported_by_agent alias_method :notification_supported_by_agent?, :notification_supported_by_agent - # IDs of other devices associated with this device. This is used to - # represent a device group (e.g. bonded zone) or "facets" synced - # through different flows (e.g. Google Nest Hub Max with a Nest Camera). - # This may also be used to pass in alternate IDs used to identify a cloud - # synced device for local execution (i.e. local verification). If used for - # local verification, this field is synced from the cloud. + # Alternate IDs associated with this device. + # This is used to identify cloud synced devices enabled for + # [local + # execution](https://developers.google.com/assistant/smarthome/concepts/local). # Corresponds to the JSON property `otherDeviceIds` # @return [Array] attr_accessor :other_device_ids - # If the third-party partner's cloud configuration includes placing devices - # in rooms, the name of the room can be provided here. + # Suggested name for the room where this device is installed. + # Google attempts to use this value during user setup. # Corresponds to the JSON property `roomHint` # @return [String] attr_accessor :room_hint - # As in roomHint, for structures that users set up in the partner's system. + # Suggested name for the structure where this device is installed. + # Google attempts to use this value during user setup. # Corresponds to the JSON property `structureHint` # @return [String] attr_accessor :structure_hint # Traits supported by the device. + # See [device + # traits](https://developers.google.com/assistant/smarthome/traits). # Corresponds to the JSON property `traits` # @return [Array] attr_accessor :traits - # Hardware type of the device (e.g. light, outlet, etc). + # Hardware type of the device. + # See [device + # types](https://developers.google.com/assistant/smarthome/guides). # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # Indicates whether the state of this device is being reported to Google - # through ReportStateAndNotification call. + # Indicates whether your smart home Action will report state of this device + # to Google via ReportStateAndNotification. # Corresponds to the JSON property `willReportState` # @return [Boolean] attr_accessor :will_report_state @@ -205,12 +210,12 @@ module Google end end - # Different names for the device. + # Identifiers used to describe the device. class DeviceNames include Google::Apis::Core::Hashable - # List of names provided by the partner rather than the user, often - # manufacturer names, SKUs, etc. + # List of names provided by the manufacturer rather than the user, such as + # serial numbers, SKUs, etc. # Corresponds to the JSON property `defaultNames` # @return [Array] attr_accessor :default_names @@ -257,11 +262,7 @@ module Google end # Request type for the - # [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call. This should - # be the same format as the Actions on Google `action.devices.QUERY` - # [request](/actions/smarthome/create-app#actiondevicesquery) with the - # exception of the extra `agent_user_id` and no `intent` and `customData` - # fields. + # [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call. class QueryRequest include Google::Apis::Core::Hashable @@ -270,7 +271,7 @@ module Google # @return [String] attr_accessor :agent_user_id - # Required. Inputs containing third-party partner's device IDs for which to + # Required. Inputs containing third-party device IDs for which to # get the device states. # Corresponds to the JSON property `inputs` # @return [Array] @@ -316,7 +317,7 @@ module Google class QueryRequestPayload include Google::Apis::Core::Hashable - # Third-party partner's device IDs for which to get the device states. + # Third-party device IDs for which to get the device states. # Corresponds to the JSON property `devices` # @return [Array] attr_accessor :devices @@ -332,9 +333,11 @@ module Google end # Response type for the - # [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call. This should - # follow the same format as the Actions on Google `action.devices.QUERY` - # [response](/actions/smarthome/create-app#actiondevicesquery). + # [`Query`](#google.home.graph.v1.HomeGraphApiService.Query) call. + # This should follow the same format as the Google smart home + # `action.devices.QUERY` + # [response](https://developers.google.com/assistant/smarthome/reference/intent/ + # query). # # Example # ```json # ` @@ -406,12 +409,16 @@ module Google class ReportStateAndNotificationDevice include Google::Apis::Core::Hashable - # Notifications metadata for devices. + # Notifications metadata for devices. See the **Device NOTIFICATIONS** + # section of the individual trait [reference + # guides](https://developers.google.com/assistant/smarthome/traits). # Corresponds to the JSON property `notifications` # @return [Hash] attr_accessor :notifications - # States of devices to update. + # States of devices to update. See the **Device STATES** section + # of the individual trait [reference + # guides](https://developers.google.com/assistant/smarthome/traits). # Corresponds to the JSON property `states` # @return [Hash] attr_accessor :states @@ -430,12 +437,10 @@ module Google # Request type for the # [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService. # ReportStateAndNotification) - # call. It may include States, Notifications, or both. This request uses - # globally unique flattened state names instead of namespaces based on traits - # to align with the existing QUERY and EXECUTE APIs implemented by 90+ Smart - # Home partners. States and notifications are defined per `device_id` (for - # example, "123" - # and "456" in the following example). # Example + # call. It may include states, notifications, or both. States and notifications + # are defined per `device_id` (for example, "123" and "456" in the following + # example). + # # Example # ```json # ` # "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", @@ -526,15 +531,14 @@ module Google class RequestSyncDevicesRequest include Google::Apis::Core::Hashable - # Required. Third-party user ID issued by agent's third-party identity - # provider. + # Required. Third-party user ID. # Corresponds to the JSON property `agentUserId` # @return [String] attr_accessor :agent_user_id # Optional. If set, the request will be added to a queue and a response will - # be returned immediately. The queue allows for de-duplication of - # simultaneous requests. + # be returned immediately. This enables concurrent requests for the given + # `agent_user_id`, but the caller will not receive any error responses. # Corresponds to the JSON property `async` # @return [Boolean] attr_accessor :async @@ -554,7 +558,8 @@ module Google # Response type for the # [`RequestSyncDevices`](#google.home.graph.v1.HomeGraphApiService. # RequestSyncDevices) - # call. Intentionally empty upon success. An HTTP response code is returned + # call. + # Intentionally empty upon success. An HTTP response code is returned # with more details upon failure. class RequestSyncDevicesResponse include Google::Apis::Core::Hashable @@ -588,10 +593,7 @@ module Google end # Request type for the [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) - # call. This should follow the same format as the Actions on Google - # `action.devices.SYNC` - # [request](/actions/smarthome/create-app#actiondevicessync) with the exception - # of the extra `agent_user_id` and no `intent` field. + # call. class SyncRequest include Google::Apis::Core::Hashable @@ -617,9 +619,11 @@ module Google end # Response type for the - # [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) call. This should - # follow the same format as the Actions on Google `action.devices.SYNC` - # [response](/actions/smarthome/create-app#actiondevicessync). + # [`Sync`](#google.home.graph.v1.HomeGraphApiService.Sync) call. + # This should follow the same format as the Google smart home + # `action.devices.SYNC` + # [response](https://developers.google.com/assistant/smarthome/reference/intent/ + # sync). # # Example # ```json # ` diff --git a/generated/google/apis/homegraph_v1/service.rb b/generated/google/apis/homegraph_v1/service.rb index f76564158..d869cfcde 100644 --- a/generated/google/apis/homegraph_v1/service.rb +++ b/generated/google/apis/homegraph_v1/service.rb @@ -47,26 +47,16 @@ module Google @batch_path = 'batch' end - # Unlinks an agent user from Google. As a result, all data related to this - # user will be deleted. - # Here is how the agent user is created in Google: - # 1. When a user opens their Google Home App, they can begin linking a 3p - # partner. - # 2. User is guided through the OAuth process. - # 3. After entering the 3p credentials, Google gets the 3p OAuth token and - # uses it to make a Sync call to the 3p partner and gets back all of the - # user's data, including `agent_user_id` and devices. - # 4. Google creates the agent user and stores a mapping from the - # `agent_user_id` -> Google ID mapping. Google also - # stores all of the user's devices under that Google ID. - # The mapping from `agent_user_id` to Google ID is many to many, since one - # Google user can have multiple 3p accounts, and multiple Google users can - # map to one `agent_user_id` (e.g., a husband and wife share one Nest account - # username/password). - # The third-party user's identity is passed in as `agent_user_id`. - # The agent is identified by the JWT signed by the partner's service account. - # Note: Special characters (except "/") in `agent_user_id` must be - # URL-encoded. + # Unlinks the given third-party user from your smart home Action. + # All data related to this user will be deleted. + # For more details on how users link their accounts, see + # [fulfillment and + # authentication](https://developers.google.com/assistant/smarthome/concepts/ + # fulfillment-authentication). + # The third-party user's identity is passed in via the `agent_user_id` + # (see DeleteAgentUserRequest). + # This request must be authorized using service account credentials from your + # Actions console project. # @param [String] agent_user_id # Required. Third-party user ID. # @param [String] request_id @@ -99,10 +89,12 @@ module Google execute_or_queue_command(command, &block) end - # Gets the device states for the devices in QueryRequest. - # The third-party user's identity is passed in as `agent_user_id`. The agent - # is identified by the JWT signed by the third-party partner's service - # account. + # Gets the current states in Home Graph for the given set of the third-party + # user's devices. + # The third-party user's identity is passed in via the `agent_user_id` + # (see QueryRequest). + # This request must be authorized using service account credentials from your + # Actions console project. # @param [Google::Apis::HomegraphV1::QueryRequest] query_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -132,20 +124,21 @@ module Google execute_or_queue_command(command, &block) end - # Reports device state and optionally sends device notifications. Called by - # an agent when the device state of a third-party changes or the agent wants - # to send a notification about the device. See - # [Implement Report State](/actions/smarthome/report-state) for more - # information. - # This method updates a predefined set of states for a device, which all - # devices have according to their prescribed traits (for example, a light - # will have the [OnOff](/actions/smarthome/traits/onoff) trait that reports - # the state `on` as a boolean value). - # A new state may not be created and an INVALID_ARGUMENT code will be thrown - # if so. It also optionally takes in a list of Notifications that may be - # created, which are associated to this state change. - # The third-party user's identity is passed in as `agent_user_id`. - # The agent is identified by the JWT signed by the partner's service account. + # Reports device state and optionally sends device notifications. + # Called by your smart home Action when the state of a third-party device + # changes or you need to send a notification about the device. + # See [Implement Report + # State](https://developers.google.com/assistant/smarthome/develop/report-state) + # for more information. + # This method updates the device state according to its declared + # [traits](https://developers.google.com/assistant/smarthome/concepts/devices- + # traits). + # Publishing a new state value outside of these traits will result in an + # `INVALID_ARGUMENT` error response. + # The third-party user's identity is passed in via the `agent_user_id` + # (see ReportStateAndNotificationRequest). + # This request must be authorized using service account credentials from your + # Actions console project. # @param [Google::Apis::HomegraphV1::ReportStateAndNotificationRequest] report_state_and_notification_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -175,12 +168,14 @@ module Google execute_or_queue_command(command, &block) end - # Requests a `SYNC` call from Google to a 3p partner's home control agent for - # a user. - # The third-party user's identity is passed in as `agent_user_id` - # (see RequestSyncDevicesRequest) and forwarded back to the agent. - # The agent is identified by the API key or JWT signed by the partner's - # service account. + # Requests Google to send an `action.devices.SYNC` + # [intent](https://developers.google.com/assistant/smarthome/reference/intent/ + # sync) + # to your smart home Action to update device metadata for the given user. + # The third-party user's identity is passed via the `agent_user_id` + # (see RequestSyncDevicesRequest). + # This request must be authorized using service account credentials from your + # Actions console project. # @param [Google::Apis::HomegraphV1::RequestSyncDevicesRequest] request_sync_devices_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -211,9 +206,10 @@ module Google end # Gets all the devices associated with the given third-party user. - # The third-party user's identity is passed in as `agent_user_id`. The agent - # is identified by the JWT signed by the third-party partner's service - # account. + # The third-party user's identity is passed in via the `agent_user_id` + # (see SyncRequest). + # This request must be authorized using service account credentials from your + # Actions console project. # @param [Google::Apis::HomegraphV1::SyncRequest] sync_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/iap_v1.rb b/generated/google/apis/iap_v1.rb index 71dee3c94..f1fab848a 100644 --- a/generated/google/apis/iap_v1.rb +++ b/generated/google/apis/iap_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/iap module IapV1 VERSION = 'V1' - REVISION = '20200207' + REVISION = '20200327' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/iap_v1/classes.rb b/generated/google/apis/iap_v1/classes.rb index 69207e940..1704343fd 100644 --- a/generated/google/apis/iap_v1/classes.rb +++ b/generated/google/apis/iap_v1/classes.rb @@ -22,6 +22,28 @@ module Google module Apis module IapV1 + # Custom content configuration for access denied page. + # IAP allows customers to define a custom URI to use as the error page when + # access is denied to users. If IAP prevents access to this page, the default + # IAP error page will be displayed instead. + class AccessDeniedPageSettings + include Google::Apis::Core::Hashable + + # The URI to be redirected to when access is denied. + # Corresponds to the JSON property `accessDeniedPageUri` + # @return [String] + attr_accessor :access_denied_page_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @access_denied_page_uri = args[:access_denied_page_uri] if args.key?(:access_denied_page_uri) + end + end + # Access related settings for IAP protected apps. class AccessSettings include Google::Apis::Core::Hashable @@ -43,6 +65,15 @@ module Google # @return [Google::Apis::IapV1::OAuthSettings] attr_accessor :oauth_settings + # PolicyDelegationConfig allows google-internal teams to use IAP for apps + # hosted in a tenant project. Using these settings, the app can delegate + # permission check to happen against the linked customer project. + # This is only ever supposed to be used by google internal teams, hence the + # restriction on the proto. + # Corresponds to the JSON property `policyDelegationSettings` + # @return [Google::Apis::IapV1::PolicyDelegationSettings] + attr_accessor :policy_delegation_settings + def initialize(**args) update!(**args) end @@ -52,6 +83,7 @@ module Google @cors_settings = args[:cors_settings] if args.key?(:cors_settings) @gcip_settings = args[:gcip_settings] if args.key?(:gcip_settings) @oauth_settings = args[:oauth_settings] if args.key?(:oauth_settings) + @policy_delegation_settings = args[:policy_delegation_settings] if args.key?(:policy_delegation_settings) end end @@ -59,6 +91,14 @@ module Google class ApplicationSettings include Google::Apis::Core::Hashable + # Custom content configuration for access denied page. + # IAP allows customers to define a custom URI to use as the error page when + # access is denied to users. If IAP prevents access to this page, the default + # IAP error page will be displayed instead. + # Corresponds to the JSON property `accessDeniedPageSettings` + # @return [Google::Apis::IapV1::AccessDeniedPageSettings] + attr_accessor :access_denied_page_settings + # Configuration for RCTokens generated for CSM workloads protected by IAP. # RCTokens are IAP generated JWTs that can be verified at the application. The # RCToken is primarily used for ISTIO deployments, and can be scoped to a @@ -73,6 +113,7 @@ module Google # Update properties of this object def update!(**args) + @access_denied_page_settings = args[:access_denied_page_settings] if args.key?(:access_denied_page_settings) @csm_settings = args[:csm_settings] if args.key?(:csm_settings) end end @@ -662,6 +703,88 @@ module Google end end + # PolicyDelegationConfig allows google-internal teams to use IAP for apps + # hosted in a tenant project. Using these settings, the app can delegate + # permission check to happen against the linked customer project. + # This is only ever supposed to be used by google internal teams, hence the + # restriction on the proto. + class PolicyDelegationSettings + include Google::Apis::Core::Hashable + + # Permission to check in IAM. + # Corresponds to the JSON property `iamPermission` + # @return [String] + attr_accessor :iam_permission + + # The DNS name of the service (e.g. "resourcemanager.googleapis.com"). + # This should be the domain name part of the full resource names (see + # https://aip.dev/122#full-resource-names), which is usually + # the same as IamServiceSpec.service of the service where the resource type + # is defined. + # Corresponds to the JSON property `iamServiceName` + # @return [String] + attr_accessor :iam_service_name + + # Policy name to be checked + # Corresponds to the JSON property `policyName` + # @return [Google::Apis::IapV1::PolicyName] + attr_accessor :policy_name + + # IAM resource to check permission on + # Corresponds to the JSON property `resource` + # @return [Google::Apis::IapV1::Resource] + attr_accessor :resource + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @iam_permission = args[:iam_permission] if args.key?(:iam_permission) + @iam_service_name = args[:iam_service_name] if args.key?(:iam_service_name) + @policy_name = args[:policy_name] if args.key?(:policy_name) + @resource = args[:resource] if args.key?(:resource) + end + end + + # + class PolicyName + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # For Cloud IAM: + # The location of the Policy. + # Must be empty or "global" for Policies owned by global IAM. Must name a + # region from prodspec/cloud-iam-cloudspec for Regional IAM Policies, see + # http://go/iam-faq#where-is-iam-currently-deployed. + # For Local IAM: + # This field should be set to "local". + # Corresponds to the JSON property `region` + # @return [String] + attr_accessor :region + + # Valid values for type might be 'gce', 'gcs', 'project', 'account' etc. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @region = args[:region] if args.key?(:region) + @type = args[:type] if args.key?(:type) + end + end + # The request sent to ResetIdentityAwareProxyClientSecret. class ResetIdentityAwareProxyClientSecretRequest include Google::Apis::Core::Hashable @@ -675,6 +798,73 @@ module Google end end + # + class Resource + include Google::Apis::Core::Hashable + + # The service defined labels of the resource on which the conditions will be + # evaluated. The semantics - including the key names - are vague to IAM. + # If the effective condition has a reference to a `resource.labels[foo]` + # construct, IAM consults with this map to retrieve the values associated + # with `foo` key for Conditions evaluation. If the provided key is not found + # in the labels map, the condition would evaluate to false. + # This field is in limited use. If your intended use case is not expected + # to express resource.labels attribute in IAM Conditions, leave this field + # empty. Before planning on using this attribute please: + # * Read go/iam-conditions-labels-comm and ensure your service can meet the + # data availability and management requirements. + # * Talk to iam-conditions-eng@ about your use case. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Name of the resource on which conditions will be evaluated. + # Must use the Relative Resource Name of the resource, which is the URI + # path of the resource without the leading "/". Examples are + # "projects/_/buckets/[BUCKET-ID]" for storage buckets or + # "projects/[PROJECT-ID]/global/firewalls/[FIREWALL-ID]" for a firewall. + # This field is required for evaluating conditions with rules on resource + # names. For a `list` permission check, the resource.name value must be set + # to the parent resource. If the parent resource is a project, this field + # should be left unset. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The name of the service this resource belongs to. It is configured using + # the official_service_name of the Service as defined in service + # configurations under //configs/cloud/resourcetypes. + # For example, the official_service_name of cloud resource manager service + # is set as 'cloudresourcemanager.googleapis.com' according to + # //configs/cloud/resourcetypes/google/cloud/resourcemanager/prod.yaml + # Corresponds to the JSON property `service` + # @return [String] + attr_accessor :service + + # The public resource type name of the resource on which conditions will be + # evaluated. It is configured using the official_name of the ResourceType as + # defined in service configurations under //configs/cloud/resourcetypes. + # For example, the official_name for GCP projects is set as + # 'cloudresourcemanager.googleapis.com/Project' according to + # //configs/cloud/resourcetypes/google/cloud/resourcemanager/prod.yaml + # For details see go/iam-conditions-integration-guide. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @service = args[:service] if args.key?(:service) + @type = args[:type] if args.key?(:type) + end + end + # Request message for `SetIamPolicy` method. class SetIamPolicyRequest include Google::Apis::Core::Hashable diff --git a/generated/google/apis/iap_v1/representations.rb b/generated/google/apis/iap_v1/representations.rb index a808cc3af..a4bbcc44b 100644 --- a/generated/google/apis/iap_v1/representations.rb +++ b/generated/google/apis/iap_v1/representations.rb @@ -22,6 +22,12 @@ module Google module Apis module IapV1 + class AccessDeniedPageSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class AccessSettings class Representation < Google::Apis::Core::JsonRepresentation; end @@ -124,12 +130,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class PolicyDelegationSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PolicyName + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ResetIdentityAwareProxyClientSecretRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class Resource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SetIamPolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -148,6 +172,13 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class AccessDeniedPageSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :access_denied_page_uri, as: 'accessDeniedPageUri' + end + end + class AccessSettings # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -157,12 +188,16 @@ module Google property :oauth_settings, as: 'oauthSettings', class: Google::Apis::IapV1::OAuthSettings, decorator: Google::Apis::IapV1::OAuthSettings::Representation + property :policy_delegation_settings, as: 'policyDelegationSettings', class: Google::Apis::IapV1::PolicyDelegationSettings, decorator: Google::Apis::IapV1::PolicyDelegationSettings::Representation + end end class ApplicationSettings # @private class Representation < Google::Apis::Core::JsonRepresentation + property :access_denied_page_settings, as: 'accessDeniedPageSettings', class: Google::Apis::IapV1::AccessDeniedPageSettings, decorator: Google::Apis::IapV1::AccessDeniedPageSettings::Representation + property :csm_settings, as: 'csmSettings', class: Google::Apis::IapV1::CsmSettings, decorator: Google::Apis::IapV1::CsmSettings::Representation end @@ -296,12 +331,43 @@ module Google end end + class PolicyDelegationSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :iam_permission, as: 'iamPermission' + property :iam_service_name, as: 'iamServiceName' + property :policy_name, as: 'policyName', class: Google::Apis::IapV1::PolicyName, decorator: Google::Apis::IapV1::PolicyName::Representation + + property :resource, as: 'resource', class: Google::Apis::IapV1::Resource, decorator: Google::Apis::IapV1::Resource::Representation + + end + end + + class PolicyName + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :region, as: 'region' + property :type, as: 'type' + end + end + class ResetIdentityAwareProxyClientSecretRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end + class Resource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :labels, as: 'labels' + property :name, as: 'name' + property :service, as: 'service' + property :type, as: 'type' + end + end + class SetIamPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/jobs_v2.rb b/generated/google/apis/jobs_v2.rb index 593bf4177..faee3881c 100644 --- a/generated/google/apis/jobs_v2.rb +++ b/generated/google/apis/jobs_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/talent-solution/job-search/docs/ module JobsV2 VERSION = 'V2' - REVISION = '20200219' + REVISION = '20200409' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/language_v1.rb b/generated/google/apis/language_v1.rb index bbc78466b..f2e65bc36 100644 --- a/generated/google/apis/language_v1.rb +++ b/generated/google/apis/language_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/natural-language/ module LanguageV1 VERSION = 'V1' - REVISION = '20200222' + REVISION = '20200406' # Apply machine learning models to reveal the structure and meaning of text AUTH_CLOUD_LANGUAGE = 'https://www.googleapis.com/auth/cloud-language' diff --git a/generated/google/apis/language_v1/classes.rb b/generated/google/apis/language_v1/classes.rb index f56fa961e..798f8c10e 100644 --- a/generated/google/apis/language_v1/classes.rb +++ b/generated/google/apis/language_v1/classes.rb @@ -349,7 +349,7 @@ module Google attr_accessor :confidence # The name of the category representing the document, from the [predefined - # taxonomy](/natural-language/docs/categories). + # taxonomy](https://cloud.google.com/natural-language/docs/categories). # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -457,11 +457,11 @@ module Google # The language of the document (if not specified, the language is # automatically detected). Both ISO and BCP-47 language codes are # accepted.
    - # [Language Support](/natural-language/docs/languages) - # lists currently supported languages for each API method. - # If the language (either specified by the caller or automatically detected) - # is not supported by the called API method, an `INVALID_ARGUMENT` error - # is returned. + # [Language + # Support](https://cloud.google.com/natural-language/docs/languages) lists + # currently supported languages for each API method. If the language (either + # specified by the caller or automatically detected) is not supported by the + # called API method, an `INVALID_ARGUMENT` error is returned. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language diff --git a/generated/google/apis/language_v1beta1.rb b/generated/google/apis/language_v1beta1.rb index 268261538..e58842b24 100644 --- a/generated/google/apis/language_v1beta1.rb +++ b/generated/google/apis/language_v1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/natural-language/ module LanguageV1beta1 VERSION = 'V1beta1' - REVISION = '20200222' + REVISION = '20200406' # Apply machine learning models to reveal the structure and meaning of text AUTH_CLOUD_LANGUAGE = 'https://www.googleapis.com/auth/cloud-language' diff --git a/generated/google/apis/language_v1beta1/classes.rb b/generated/google/apis/language_v1beta1/classes.rb index 8bfae5beb..58a44339b 100644 --- a/generated/google/apis/language_v1beta1/classes.rb +++ b/generated/google/apis/language_v1beta1/classes.rb @@ -331,11 +331,11 @@ module Google # The language of the document (if not specified, the language is # automatically detected). Both ISO and BCP-47 language codes are # accepted.
    - # [Language Support](/natural-language/docs/languages) - # lists currently supported languages for each API method. - # If the language (either specified by the caller or automatically detected) - # is not supported by the called API method, an `INVALID_ARGUMENT` error - # is returned. + # [Language + # Support](https://cloud.google.com/natural-language/docs/languages) lists + # currently supported languages for each API method. If the language (either + # specified by the caller or automatically detected) is not supported by the + # called API method, an `INVALID_ARGUMENT` error is returned. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language diff --git a/generated/google/apis/language_v1beta2.rb b/generated/google/apis/language_v1beta2.rb index 258a81433..17ec72fb6 100644 --- a/generated/google/apis/language_v1beta2.rb +++ b/generated/google/apis/language_v1beta2.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/natural-language/ module LanguageV1beta2 VERSION = 'V1beta2' - REVISION = '20200222' + REVISION = '20200406' # Apply machine learning models to reveal the structure and meaning of text AUTH_CLOUD_LANGUAGE = 'https://www.googleapis.com/auth/cloud-language' diff --git a/generated/google/apis/language_v1beta2/classes.rb b/generated/google/apis/language_v1beta2/classes.rb index 362008317..c1a7f7f74 100644 --- a/generated/google/apis/language_v1beta2/classes.rb +++ b/generated/google/apis/language_v1beta2/classes.rb @@ -353,7 +353,7 @@ module Google attr_accessor :confidence # The name of the category representing the document, from the [predefined - # taxonomy](/natural-language/docs/categories). + # taxonomy](https://cloud.google.com/natural-language/docs/categories). # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -466,11 +466,11 @@ module Google # The language of the document (if not specified, the language is # automatically detected). Both ISO and BCP-47 language codes are # accepted.
    - # [Language Support](/natural-language/docs/languages) - # lists currently supported languages for each API method. - # If the language (either specified by the caller or automatically detected) - # is not supported by the called API method, an `INVALID_ARGUMENT` error - # is returned. + # [Language + # Support](https://cloud.google.com/natural-language/docs/languages) lists + # currently supported languages for each API method. If the language (either + # specified by the caller or automatically detected) is not supported by the + # called API method, an `INVALID_ARGUMENT` error is returned. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language @@ -605,7 +605,8 @@ module Google # Classify the full document into categories. If this is true, # the API will use the default model which classifies into a - # [predefined taxonomy](/natural-language/docs/categories). + # [predefined + # taxonomy](https://cloud.google.com/natural-language/docs/categories). # Corresponds to the JSON property `classifyText` # @return [Boolean] attr_accessor :classify_text diff --git a/generated/google/apis/logging_v2.rb b/generated/google/apis/logging_v2.rb index 269a90696..1ebe4b8cd 100644 --- a/generated/google/apis/logging_v2.rb +++ b/generated/google/apis/logging_v2.rb @@ -22,13 +22,13 @@ module Google # # Writes log entries and manages your Cloud Logging configuration. The table # entries below are presented in alphabetical order, not in order of common use. - # For explanations of the concepts found in the table entries, read the Cloud Logging documentation. + # For explanations of the concepts found in the table entries, read the + # documentation at https://cloud.google.com/logging/docs. # # @see https://cloud.google.com/logging/docs/ module LoggingV2 VERSION = 'V2' - REVISION = '20200228' + REVISION = '20200407' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/logging_v2/classes.rb b/generated/google/apis/logging_v2/classes.rb index 1fa408749..0f668e745 100644 --- a/generated/google/apis/logging_v2/classes.rb +++ b/generated/google/apis/logging_v2/classes.rb @@ -887,10 +887,9 @@ module Google # If this field is omitted in a new log entry, then Logging assigns it the # current time. Timestamps have nanosecond accuracy, but trailing zeros in the # fractional seconds might be omitted when the timestamp is displayed.Incoming - # log entries should have timestamps that are no more than the logs retention - # period in the past, and no more than 24 hours in the future. Log entries - # outside those time boundaries will not be available when calling entries.list, - # but those log entries can still be exported with LogSinks. + # log entries must have timestamps that don't exceed the logs retention period + # in the past, and that don't exceed 24 hours in the future. Log entries outside + # those time boundaries aren't ingested by Logging. # Corresponds to the JSON property `timestamp` # @return [String] attr_accessor :timestamp diff --git a/generated/google/apis/logging_v2/service.rb b/generated/google/apis/logging_v2/service.rb index d69d885a5..ecd7f3639 100644 --- a/generated/google/apis/logging_v2/service.rb +++ b/generated/google/apis/logging_v2/service.rb @@ -24,8 +24,8 @@ module Google # # Writes log entries and manages your Cloud Logging configuration. The table # entries below are presented in alphabetical order, not in order of common use. - # For explanations of the concepts found in the table entries, read the Cloud Logging documentation. + # For explanations of the concepts found in the table entries, read the + # documentation at https://cloud.google.com/logging/docs. # # @example # require 'google/apis/logging_v2' diff --git a/generated/google/apis/managedidentities_v1.rb b/generated/google/apis/managedidentities_v1.rb index db11194ff..e7c0fe915 100644 --- a/generated/google/apis/managedidentities_v1.rb +++ b/generated/google/apis/managedidentities_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/managed-microsoft-ad/ module ManagedidentitiesV1 VERSION = 'V1' - REVISION = '20200219' + REVISION = '20200326' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/managedidentities_v1/classes.rb b/generated/google/apis/managedidentities_v1/classes.rb index 1ae2728cf..4f0372dcc 100644 --- a/generated/google/apis/managedidentities_v1/classes.rb +++ b/generated/google/apis/managedidentities_v1/classes.rb @@ -396,6 +396,59 @@ module Google end end + # Represents the metadata of the long-running operation. + class GoogleCloudManagedidentitiesV1alpha1OpMetadata + 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. 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. 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) + @end_time = args[:end_time] if args.key?(:end_time) + @requested_cancellation = args[:requested_cancellation] if args.key?(:requested_cancellation) + @target = args[:target] if args.key?(:target) + @verb = args[:verb] if args.key?(:verb) + end + end + # Represents the metadata of the long-running operation. class GoogleCloudManagedidentitiesV1beta1OpMetadata include Google::Apis::Core::Hashable @@ -449,66 +502,7 @@ module Google end end - # Instance represents the interface for SLM services to actuate the state - # of control plane resources. - # Example Instance in JSON, where - # consumer-project=snapchat, - # producer-project=cloud-sql: - # ```json - # Instance: - # ` - # "name": - # "projects/snapchat/locations/us-east1/instances/prod-instance", - # "create_time": ` - # "seconds": 1526406431, - # `, - # "labels": ` - # "env": "prod", - # "foo": "bar" - # `, - # "state": READY, - # "software_versions": ` - # "software_update": "cloud-sql-09-28-2018", - # `, - # "maintenance_policy_names": ` - # "UpdatePolicy": - # "projects/snapchat/locations/us-east1/maintenancePolicies/prod-update- - # policy", - # ` - # "tenant_project_id": "cloud-sql-test-tenant", - # "producer_metadata": ` - # "cloud-sql-tier": "basic", - # "cloud-sql-instance-size": "1G", - # `, - # "provisioned_resources": [ - # ` - # "resource-type": "compute-instance", - # "resource-url": - # "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1- - # b/instances/vm-1", - # ` - # ], - # "maintenance_schedules": ` - # "csa_rollout": ` - # "start_time": ` - # "seconds": 1526406431, - # `, - # "end_time": ` - # "seconds": 1535406431, - # `, - # `, - # "ncsa_rollout": ` - # "start_time": ` - # "seconds": 1526406431, - # `, - # "end_time": ` - # "seconds": 1535406431, - # `, - # ` - # `, - # "consumer_defined_name": "my-sql-instance1", - # ` - # ``` + # class GoogleCloudSaasacceleratorManagementProvidersV1Instance include Google::Apis::Core::Hashable @@ -567,16 +561,6 @@ module Google # @return [Array] attr_accessor :provisioned_resources - # The map between RolloutType and the corresponding RolloutMetadata. - # This is only mutated by rollout service. For actuation implementation, - # this information is pass-through for Rollout management. Producer shall - # not modify by itself. - # For update of a single entry in this map, the update field mask shall - # follow this sementics: go/advanced-field-masks - # Corresponds to the JSON property `rolloutMetadata` - # @return [Hash] - attr_accessor :rollout_metadata - # Link to the SLM instance template. Only populated when updating SLM # instances via SSA's Actuation service adaptor. # Service producers with custom control plane (e.g. Cloud SQL) doesn't @@ -628,7 +612,6 @@ module Google @name = args[:name] if args.key?(:name) @producer_metadata = args[:producer_metadata] if args.key?(:producer_metadata) @provisioned_resources = args[:provisioned_resources] if args.key?(:provisioned_resources) - @rollout_metadata = args[:rollout_metadata] if args.key?(:rollout_metadata) @slm_instance_template = args[:slm_instance_template] if args.key?(:slm_instance_template) @slo_metadata = args[:slo_metadata] if args.key?(:slo_metadata) @software_versions = args[:software_versions] if args.key?(:software_versions) @@ -720,47 +703,6 @@ module Google end end - # This message has been deprecated. - # NotificationMetadata is the notification state for an instance. - class GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata - include Google::Apis::Core::Hashable - - # Whether the instance update has been rescheduled. - # Corresponds to the JSON property `rescheduled` - # @return [Boolean] - attr_accessor :rescheduled - alias_method :rescheduled?, :rescheduled - - # The scheduled end time for the maintenance window during which update - # can be performed on the instance. - # Corresponds to the JSON property `scheduledEndTime` - # @return [String] - attr_accessor :scheduled_end_time - - # The scheduled start time for the maintenance window during which - # update can be performed on the instance. - # Corresponds to the JSON property `scheduledStartTime` - # @return [String] - attr_accessor :scheduled_start_time - - # The target release to be applied to the instance. - # Corresponds to the JSON property `targetRelease` - # @return [String] - attr_accessor :target_release - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @rescheduled = args[:rescheduled] if args.key?(:rescheduled) - @scheduled_end_time = args[:scheduled_end_time] if args.key?(:scheduled_end_time) - @scheduled_start_time = args[:scheduled_start_time] if args.key?(:scheduled_start_time) - @target_release = args[:target_release] if args.key?(:target_release) - end - end - # Describes provisioned dataplane resources. class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource include Google::Apis::Core::Hashable @@ -792,39 +734,6 @@ module Google end end - # This message has been deprecated. - # RolloutMetadata for an actuation instance. It maps to a single RolloutType. - class GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata - include Google::Apis::Core::Hashable - - # This message has been deprecated. - # NotificationMetadata is the notification state for an instance. - # Corresponds to the JSON property `notification` - # @return [Google::Apis::ManagedidentitiesV1::GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata] - attr_accessor :notification - - # The last Release that has been applied to the instance. - # Corresponds to the JSON property `releaseName` - # @return [String] - attr_accessor :release_name - - # The last rollout that has been applied to the instance. - # Corresponds to the JSON property `rolloutName` - # @return [String] - attr_accessor :rollout_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @notification = args[:notification] if args.key?(:notification) - @release_name = args[:release_name] if args.key?(:release_name) - @rollout_name = args[:rollout_name] if args.key?(:rollout_name) - end - end - # SloEligibility is a tuple containing eligibility value: true if an instance # is eligible for SLO calculation or false if it should be excluded from all # SLO-related calculations along with a user-defined reason. diff --git a/generated/google/apis/managedidentities_v1/representations.rb b/generated/google/apis/managedidentities_v1/representations.rb index de782f0a9..94eb50b92 100644 --- a/generated/google/apis/managedidentities_v1/representations.rb +++ b/generated/google/apis/managedidentities_v1/representations.rb @@ -70,6 +70,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudManagedidentitiesV1alpha1OpMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudManagedidentitiesV1beta1OpMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -94,24 +100,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility class Representation < Google::Apis::Core::JsonRepresentation; end @@ -305,6 +299,18 @@ module Google end end + class GoogleCloudManagedidentitiesV1alpha1OpMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :api_version, as: 'apiVersion' + property :create_time, as: 'createTime' + property :end_time, as: 'endTime' + property :requested_cancellation, as: 'requestedCancellation' + property :target, as: 'target' + property :verb, as: 'verb' + end + end + class GoogleCloudManagedidentitiesV1beta1OpMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -330,8 +336,6 @@ module Google hash :producer_metadata, as: 'producerMetadata' collection :provisioned_resources, as: 'provisionedResources', class: Google::Apis::ManagedidentitiesV1::GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource, decorator: Google::Apis::ManagedidentitiesV1::GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource::Representation - hash :rollout_metadata, as: 'rolloutMetadata', class: Google::Apis::ManagedidentitiesV1::GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata, decorator: Google::Apis::ManagedidentitiesV1::GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata::Representation - property :slm_instance_template, as: 'slmInstanceTemplate' property :slo_metadata, as: 'sloMetadata', class: Google::Apis::ManagedidentitiesV1::GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata, decorator: Google::Apis::ManagedidentitiesV1::GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata::Representation @@ -362,16 +366,6 @@ module Google end end - class GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :rescheduled, as: 'rescheduled' - property :scheduled_end_time, as: 'scheduledEndTime' - property :scheduled_start_time, as: 'scheduledStartTime' - property :target_release, as: 'targetRelease' - end - end - class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -380,16 +374,6 @@ module Google end end - class GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :notification, as: 'notification', class: Google::Apis::ManagedidentitiesV1::GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata, decorator: Google::Apis::ManagedidentitiesV1::GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata::Representation - - property :release_name, as: 'releaseName' - property :rollout_name, as: 'rolloutName' - end - end - class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/managedidentities_v1alpha1.rb b/generated/google/apis/managedidentities_v1alpha1.rb index a64f8a31b..b6386e86c 100644 --- a/generated/google/apis/managedidentities_v1alpha1.rb +++ b/generated/google/apis/managedidentities_v1alpha1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/managed-microsoft-ad/ module ManagedidentitiesV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200219' + REVISION = '20200326' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/managedidentities_v1alpha1/classes.rb b/generated/google/apis/managedidentities_v1alpha1/classes.rb index c5b96a226..e44b2b2fb 100644 --- a/generated/google/apis/managedidentities_v1alpha1/classes.rb +++ b/generated/google/apis/managedidentities_v1alpha1/classes.rb @@ -404,6 +404,59 @@ module Google end end + # Represents the metadata of the long-running operation. + class GoogleCloudManagedidentitiesV1alpha1OpMetadata + 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. 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. 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) + @end_time = args[:end_time] if args.key?(:end_time) + @requested_cancellation = args[:requested_cancellation] if args.key?(:requested_cancellation) + @target = args[:target] if args.key?(:target) + @verb = args[:verb] if args.key?(:verb) + end + end + # Represents the metadata of the long-running operation. class GoogleCloudManagedidentitiesV1beta1OpMetadata include Google::Apis::Core::Hashable @@ -457,66 +510,7 @@ module Google end end - # Instance represents the interface for SLM services to actuate the state - # of control plane resources. - # Example Instance in JSON, where - # consumer-project=snapchat, - # producer-project=cloud-sql: - # ```json - # Instance: - # ` - # "name": - # "projects/snapchat/locations/us-east1/instances/prod-instance", - # "create_time": ` - # "seconds": 1526406431, - # `, - # "labels": ` - # "env": "prod", - # "foo": "bar" - # `, - # "state": READY, - # "software_versions": ` - # "software_update": "cloud-sql-09-28-2018", - # `, - # "maintenance_policy_names": ` - # "UpdatePolicy": - # "projects/snapchat/locations/us-east1/maintenancePolicies/prod-update- - # policy", - # ` - # "tenant_project_id": "cloud-sql-test-tenant", - # "producer_metadata": ` - # "cloud-sql-tier": "basic", - # "cloud-sql-instance-size": "1G", - # `, - # "provisioned_resources": [ - # ` - # "resource-type": "compute-instance", - # "resource-url": - # "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1- - # b/instances/vm-1", - # ` - # ], - # "maintenance_schedules": ` - # "csa_rollout": ` - # "start_time": ` - # "seconds": 1526406431, - # `, - # "end_time": ` - # "seconds": 1535406431, - # `, - # `, - # "ncsa_rollout": ` - # "start_time": ` - # "seconds": 1526406431, - # `, - # "end_time": ` - # "seconds": 1535406431, - # `, - # ` - # `, - # "consumer_defined_name": "my-sql-instance1", - # ` - # ``` + # class GoogleCloudSaasacceleratorManagementProvidersV1Instance include Google::Apis::Core::Hashable @@ -575,16 +569,6 @@ module Google # @return [Array] attr_accessor :provisioned_resources - # The map between RolloutType and the corresponding RolloutMetadata. - # This is only mutated by rollout service. For actuation implementation, - # this information is pass-through for Rollout management. Producer shall - # not modify by itself. - # For update of a single entry in this map, the update field mask shall - # follow this sementics: go/advanced-field-masks - # Corresponds to the JSON property `rolloutMetadata` - # @return [Hash] - attr_accessor :rollout_metadata - # Link to the SLM instance template. Only populated when updating SLM # instances via SSA's Actuation service adaptor. # Service producers with custom control plane (e.g. Cloud SQL) doesn't @@ -636,7 +620,6 @@ module Google @name = args[:name] if args.key?(:name) @producer_metadata = args[:producer_metadata] if args.key?(:producer_metadata) @provisioned_resources = args[:provisioned_resources] if args.key?(:provisioned_resources) - @rollout_metadata = args[:rollout_metadata] if args.key?(:rollout_metadata) @slm_instance_template = args[:slm_instance_template] if args.key?(:slm_instance_template) @slo_metadata = args[:slo_metadata] if args.key?(:slo_metadata) @software_versions = args[:software_versions] if args.key?(:software_versions) @@ -728,47 +711,6 @@ module Google end end - # This message has been deprecated. - # NotificationMetadata is the notification state for an instance. - class GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata - include Google::Apis::Core::Hashable - - # Whether the instance update has been rescheduled. - # Corresponds to the JSON property `rescheduled` - # @return [Boolean] - attr_accessor :rescheduled - alias_method :rescheduled?, :rescheduled - - # The scheduled end time for the maintenance window during which update - # can be performed on the instance. - # Corresponds to the JSON property `scheduledEndTime` - # @return [String] - attr_accessor :scheduled_end_time - - # The scheduled start time for the maintenance window during which - # update can be performed on the instance. - # Corresponds to the JSON property `scheduledStartTime` - # @return [String] - attr_accessor :scheduled_start_time - - # The target release to be applied to the instance. - # Corresponds to the JSON property `targetRelease` - # @return [String] - attr_accessor :target_release - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @rescheduled = args[:rescheduled] if args.key?(:rescheduled) - @scheduled_end_time = args[:scheduled_end_time] if args.key?(:scheduled_end_time) - @scheduled_start_time = args[:scheduled_start_time] if args.key?(:scheduled_start_time) - @target_release = args[:target_release] if args.key?(:target_release) - end - end - # Describes provisioned dataplane resources. class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource include Google::Apis::Core::Hashable @@ -800,39 +742,6 @@ module Google end end - # This message has been deprecated. - # RolloutMetadata for an actuation instance. It maps to a single RolloutType. - class GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata - include Google::Apis::Core::Hashable - - # This message has been deprecated. - # NotificationMetadata is the notification state for an instance. - # Corresponds to the JSON property `notification` - # @return [Google::Apis::ManagedidentitiesV1alpha1::GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata] - attr_accessor :notification - - # The last Release that has been applied to the instance. - # Corresponds to the JSON property `releaseName` - # @return [String] - attr_accessor :release_name - - # The last rollout that has been applied to the instance. - # Corresponds to the JSON property `rolloutName` - # @return [String] - attr_accessor :rollout_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @notification = args[:notification] if args.key?(:notification) - @release_name = args[:release_name] if args.key?(:release_name) - @rollout_name = args[:rollout_name] if args.key?(:rollout_name) - end - end - # SloEligibility is a tuple containing eligibility value: true if an instance # is eligible for SLO calculation or false if it should be excluded from all # SLO-related calculations along with a user-defined reason. diff --git a/generated/google/apis/managedidentities_v1alpha1/representations.rb b/generated/google/apis/managedidentities_v1alpha1/representations.rb index 6a2687ccf..5200dabfc 100644 --- a/generated/google/apis/managedidentities_v1alpha1/representations.rb +++ b/generated/google/apis/managedidentities_v1alpha1/representations.rb @@ -70,6 +70,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudManagedidentitiesV1alpha1OpMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudManagedidentitiesV1beta1OpMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -94,24 +100,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility class Representation < Google::Apis::Core::JsonRepresentation; end @@ -305,6 +299,18 @@ module Google end end + class GoogleCloudManagedidentitiesV1alpha1OpMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :api_version, as: 'apiVersion' + property :create_time, as: 'createTime' + property :end_time, as: 'endTime' + property :requested_cancellation, as: 'requestedCancellation' + property :target, as: 'target' + property :verb, as: 'verb' + end + end + class GoogleCloudManagedidentitiesV1beta1OpMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -330,8 +336,6 @@ module Google hash :producer_metadata, as: 'producerMetadata' collection :provisioned_resources, as: 'provisionedResources', class: Google::Apis::ManagedidentitiesV1alpha1::GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource, decorator: Google::Apis::ManagedidentitiesV1alpha1::GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource::Representation - hash :rollout_metadata, as: 'rolloutMetadata', class: Google::Apis::ManagedidentitiesV1alpha1::GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata, decorator: Google::Apis::ManagedidentitiesV1alpha1::GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata::Representation - property :slm_instance_template, as: 'slmInstanceTemplate' property :slo_metadata, as: 'sloMetadata', class: Google::Apis::ManagedidentitiesV1alpha1::GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata, decorator: Google::Apis::ManagedidentitiesV1alpha1::GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata::Representation @@ -362,16 +366,6 @@ module Google end end - class GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :rescheduled, as: 'rescheduled' - property :scheduled_end_time, as: 'scheduledEndTime' - property :scheduled_start_time, as: 'scheduledStartTime' - property :target_release, as: 'targetRelease' - end - end - class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -380,16 +374,6 @@ module Google end end - class GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :notification, as: 'notification', class: Google::Apis::ManagedidentitiesV1alpha1::GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata, decorator: Google::Apis::ManagedidentitiesV1alpha1::GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata::Representation - - property :release_name, as: 'releaseName' - property :rollout_name, as: 'rolloutName' - end - end - class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/managedidentities_v1beta1.rb b/generated/google/apis/managedidentities_v1beta1.rb index 4fdb3a01f..2d0b97b0a 100644 --- a/generated/google/apis/managedidentities_v1beta1.rb +++ b/generated/google/apis/managedidentities_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/managed-microsoft-ad/ module ManagedidentitiesV1beta1 VERSION = 'V1beta1' - REVISION = '20200219' + REVISION = '20200326' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/managedidentities_v1beta1/classes.rb b/generated/google/apis/managedidentities_v1beta1/classes.rb index b2a86ef69..5ed63d460 100644 --- a/generated/google/apis/managedidentities_v1beta1/classes.rb +++ b/generated/google/apis/managedidentities_v1beta1/classes.rb @@ -396,6 +396,59 @@ module Google end end + # Represents the metadata of the long-running operation. + class GoogleCloudManagedidentitiesV1alpha1OpMetadata + 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. 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. 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) + @end_time = args[:end_time] if args.key?(:end_time) + @requested_cancellation = args[:requested_cancellation] if args.key?(:requested_cancellation) + @target = args[:target] if args.key?(:target) + @verb = args[:verb] if args.key?(:verb) + end + end + # Represents the metadata of the long-running operation. class GoogleCloudManagedidentitiesV1beta1OpMetadata include Google::Apis::Core::Hashable @@ -449,66 +502,7 @@ module Google end end - # Instance represents the interface for SLM services to actuate the state - # of control plane resources. - # Example Instance in JSON, where - # consumer-project=snapchat, - # producer-project=cloud-sql: - # ```json - # Instance: - # ` - # "name": - # "projects/snapchat/locations/us-east1/instances/prod-instance", - # "create_time": ` - # "seconds": 1526406431, - # `, - # "labels": ` - # "env": "prod", - # "foo": "bar" - # `, - # "state": READY, - # "software_versions": ` - # "software_update": "cloud-sql-09-28-2018", - # `, - # "maintenance_policy_names": ` - # "UpdatePolicy": - # "projects/snapchat/locations/us-east1/maintenancePolicies/prod-update- - # policy", - # ` - # "tenant_project_id": "cloud-sql-test-tenant", - # "producer_metadata": ` - # "cloud-sql-tier": "basic", - # "cloud-sql-instance-size": "1G", - # `, - # "provisioned_resources": [ - # ` - # "resource-type": "compute-instance", - # "resource-url": - # "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1- - # b/instances/vm-1", - # ` - # ], - # "maintenance_schedules": ` - # "csa_rollout": ` - # "start_time": ` - # "seconds": 1526406431, - # `, - # "end_time": ` - # "seconds": 1535406431, - # `, - # `, - # "ncsa_rollout": ` - # "start_time": ` - # "seconds": 1526406431, - # `, - # "end_time": ` - # "seconds": 1535406431, - # `, - # ` - # `, - # "consumer_defined_name": "my-sql-instance1", - # ` - # ``` + # class GoogleCloudSaasacceleratorManagementProvidersV1Instance include Google::Apis::Core::Hashable @@ -567,16 +561,6 @@ module Google # @return [Array] attr_accessor :provisioned_resources - # The map between RolloutType and the corresponding RolloutMetadata. - # This is only mutated by rollout service. For actuation implementation, - # this information is pass-through for Rollout management. Producer shall - # not modify by itself. - # For update of a single entry in this map, the update field mask shall - # follow this sementics: go/advanced-field-masks - # Corresponds to the JSON property `rolloutMetadata` - # @return [Hash] - attr_accessor :rollout_metadata - # Link to the SLM instance template. Only populated when updating SLM # instances via SSA's Actuation service adaptor. # Service producers with custom control plane (e.g. Cloud SQL) doesn't @@ -628,7 +612,6 @@ module Google @name = args[:name] if args.key?(:name) @producer_metadata = args[:producer_metadata] if args.key?(:producer_metadata) @provisioned_resources = args[:provisioned_resources] if args.key?(:provisioned_resources) - @rollout_metadata = args[:rollout_metadata] if args.key?(:rollout_metadata) @slm_instance_template = args[:slm_instance_template] if args.key?(:slm_instance_template) @slo_metadata = args[:slo_metadata] if args.key?(:slo_metadata) @software_versions = args[:software_versions] if args.key?(:software_versions) @@ -720,47 +703,6 @@ module Google end end - # This message has been deprecated. - # NotificationMetadata is the notification state for an instance. - class GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata - include Google::Apis::Core::Hashable - - # Whether the instance update has been rescheduled. - # Corresponds to the JSON property `rescheduled` - # @return [Boolean] - attr_accessor :rescheduled - alias_method :rescheduled?, :rescheduled - - # The scheduled end time for the maintenance window during which update - # can be performed on the instance. - # Corresponds to the JSON property `scheduledEndTime` - # @return [String] - attr_accessor :scheduled_end_time - - # The scheduled start time for the maintenance window during which - # update can be performed on the instance. - # Corresponds to the JSON property `scheduledStartTime` - # @return [String] - attr_accessor :scheduled_start_time - - # The target release to be applied to the instance. - # Corresponds to the JSON property `targetRelease` - # @return [String] - attr_accessor :target_release - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @rescheduled = args[:rescheduled] if args.key?(:rescheduled) - @scheduled_end_time = args[:scheduled_end_time] if args.key?(:scheduled_end_time) - @scheduled_start_time = args[:scheduled_start_time] if args.key?(:scheduled_start_time) - @target_release = args[:target_release] if args.key?(:target_release) - end - end - # Describes provisioned dataplane resources. class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource include Google::Apis::Core::Hashable @@ -792,39 +734,6 @@ module Google end end - # This message has been deprecated. - # RolloutMetadata for an actuation instance. It maps to a single RolloutType. - class GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata - include Google::Apis::Core::Hashable - - # This message has been deprecated. - # NotificationMetadata is the notification state for an instance. - # Corresponds to the JSON property `notification` - # @return [Google::Apis::ManagedidentitiesV1beta1::GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata] - attr_accessor :notification - - # The last Release that has been applied to the instance. - # Corresponds to the JSON property `releaseName` - # @return [String] - attr_accessor :release_name - - # The last rollout that has been applied to the instance. - # Corresponds to the JSON property `rolloutName` - # @return [String] - attr_accessor :rollout_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @notification = args[:notification] if args.key?(:notification) - @release_name = args[:release_name] if args.key?(:release_name) - @rollout_name = args[:rollout_name] if args.key?(:rollout_name) - end - end - # SloEligibility is a tuple containing eligibility value: true if an instance # is eligible for SLO calculation or false if it should be excluded from all # SLO-related calculations along with a user-defined reason. diff --git a/generated/google/apis/managedidentities_v1beta1/representations.rb b/generated/google/apis/managedidentities_v1beta1/representations.rb index e62b833bc..10b887524 100644 --- a/generated/google/apis/managedidentities_v1beta1/representations.rb +++ b/generated/google/apis/managedidentities_v1beta1/representations.rb @@ -70,6 +70,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudManagedidentitiesV1alpha1OpMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudManagedidentitiesV1beta1OpMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -94,24 +100,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility class Representation < Google::Apis::Core::JsonRepresentation; end @@ -305,6 +299,18 @@ module Google end end + class GoogleCloudManagedidentitiesV1alpha1OpMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :api_version, as: 'apiVersion' + property :create_time, as: 'createTime' + property :end_time, as: 'endTime' + property :requested_cancellation, as: 'requestedCancellation' + property :target, as: 'target' + property :verb, as: 'verb' + end + end + class GoogleCloudManagedidentitiesV1beta1OpMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -330,8 +336,6 @@ module Google hash :producer_metadata, as: 'producerMetadata' collection :provisioned_resources, as: 'provisionedResources', class: Google::Apis::ManagedidentitiesV1beta1::GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource, decorator: Google::Apis::ManagedidentitiesV1beta1::GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource::Representation - hash :rollout_metadata, as: 'rolloutMetadata', class: Google::Apis::ManagedidentitiesV1beta1::GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata, decorator: Google::Apis::ManagedidentitiesV1beta1::GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata::Representation - property :slm_instance_template, as: 'slmInstanceTemplate' property :slo_metadata, as: 'sloMetadata', class: Google::Apis::ManagedidentitiesV1beta1::GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata, decorator: Google::Apis::ManagedidentitiesV1beta1::GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata::Representation @@ -362,16 +366,6 @@ module Google end end - class GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :rescheduled, as: 'rescheduled' - property :scheduled_end_time, as: 'scheduledEndTime' - property :scheduled_start_time, as: 'scheduledStartTime' - property :target_release, as: 'targetRelease' - end - end - class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -380,16 +374,6 @@ module Google end end - class GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :notification, as: 'notification', class: Google::Apis::ManagedidentitiesV1beta1::GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata, decorator: Google::Apis::ManagedidentitiesV1beta1::GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata::Representation - - property :release_name, as: 'releaseName' - property :rollout_name, as: 'rolloutName' - end - end - class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/manufacturers_v1.rb b/generated/google/apis/manufacturers_v1.rb index 940ba8a38..efa5ac786 100644 --- a/generated/google/apis/manufacturers_v1.rb +++ b/generated/google/apis/manufacturers_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/manufacturers/ module ManufacturersV1 VERSION = 'V1' - REVISION = '20200303' + REVISION = '20200317' # Manage your product listings for Google Manufacturer Center AUTH_MANUFACTURERCENTER = 'https://www.googleapis.com/auth/manufacturercenter' diff --git a/generated/google/apis/manufacturers_v1/classes.rb b/generated/google/apis/manufacturers_v1/classes.rb index f39cd2d00..e62d4f8f8 100644 --- a/generated/google/apis/manufacturers_v1/classes.rb +++ b/generated/google/apis/manufacturers_v1/classes.rb @@ -183,9 +183,9 @@ module Google # Rich product content. For more information, see # https://support.google.com/manufacturers/answer/9389865 - # Corresponds to the JSON property `richContent` + # Corresponds to the JSON property `richProductContent` # @return [Array] - attr_accessor :rich_content + attr_accessor :rich_product_content # The scent of the product. For more information, see # https://support.google.com/manufacturers/answer/6124116#scent. @@ -272,7 +272,7 @@ module Google @product_page_url = args[:product_page_url] if args.key?(:product_page_url) @product_type = args[:product_type] if args.key?(:product_type) @release_date = args[:release_date] if args.key?(:release_date) - @rich_content = args[:rich_content] if args.key?(:rich_content) + @rich_product_content = args[:rich_product_content] if args.key?(:rich_product_content) @scent = args[:scent] if args.key?(:scent) @size = args[:size] if args.key?(:size) @size_system = args[:size_system] if args.key?(:size_system) diff --git a/generated/google/apis/manufacturers_v1/representations.rb b/generated/google/apis/manufacturers_v1/representations.rb index 54978e146..89cf63839 100644 --- a/generated/google/apis/manufacturers_v1/representations.rb +++ b/generated/google/apis/manufacturers_v1/representations.rb @@ -129,7 +129,7 @@ module Google property :product_page_url, as: 'productPageUrl' collection :product_type, as: 'productType' property :release_date, as: 'releaseDate' - collection :rich_content, as: 'richContent' + collection :rich_product_content, as: 'richProductContent' property :scent, as: 'scent' property :size, as: 'size' property :size_system, as: 'sizeSystem' diff --git a/generated/google/apis/memcache_v1beta2.rb b/generated/google/apis/memcache_v1beta2.rb new file mode 100644 index 000000000..db06f642b --- /dev/null +++ b/generated/google/apis/memcache_v1beta2.rb @@ -0,0 +1,35 @@ +# Copyright 2015 Google Inc. +# +# 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 'google/apis/memcache_v1beta2/service.rb' +require 'google/apis/memcache_v1beta2/classes.rb' +require 'google/apis/memcache_v1beta2/representations.rb' + +module Google + module Apis + # Cloud Memorystore for Memcached API + # + # Google Cloud Memorystore for Memcached API is used for creating and managing + # Memcached instances in GCP. + # + # @see https://cloud.google.com/memorystore/ + module MemcacheV1beta2 + VERSION = 'V1beta2' + REVISION = '20200309' + + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' + end + end +end diff --git a/generated/google/apis/cloudprivatecatalogproducer_v1beta1/classes.rb b/generated/google/apis/memcache_v1beta2/classes.rb similarity index 50% rename from generated/google/apis/cloudprivatecatalogproducer_v1beta1/classes.rb rename to generated/google/apis/memcache_v1beta2/classes.rb index bacb01b6c..fcb946f9c 100644 --- a/generated/google/apis/cloudprivatecatalogproducer_v1beta1/classes.rb +++ b/generated/google/apis/memcache_v1beta2/classes.rb @@ -20,51 +20,24 @@ require 'google/apis/errors' module Google module Apis - module CloudprivatecatalogproducerV1beta1 + module MemcacheV1beta2 - # An association tuple that pairs a `Catalog` to a resource - # that can use the `Catalog`. After association, a - # google.cloud.privatecatalog.v1beta1.Catalog becomes available to - # consumers under specified Association.resource and all of its child - # nodes. - # Users who have the `cloudprivatecatalog.targets.get` permission on any of - # the resource nodes can access the catalog and child products under the node. - # For example, suppose the cloud resource hierarchy is as follows: - # * organizations/example.com - # * folders/team - # * projects/test - # After creating an association with `organizations/example.com`, the catalog - # `catalogs/1` is accessible from the following paths: - # * organizations/example.com - # * folders/team - # * projects/test - # Users can access them by - # google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action. - class GoogleCloudPrivatecatalogproducerV1beta1Association + # Request for ApplyParameters. + class ApplyParametersRequest include Google::Apis::Core::Hashable - # The creation time of the association. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time + # Whether to apply instance-level parameter group to all nodes. If set to + # true, will explicitly restrict users from specifying any nodes, and apply + # parameter group updates to all nodes within the instance. + # Corresponds to the JSON property `applyAll` + # @return [Boolean] + attr_accessor :apply_all + alias_method :apply_all?, :apply_all - # Output only. The resource name of the catalog association, in the format - # `catalogs/`catalog_id`/associations/`association_id`'. - # A unique identifier for the catalog association, which is - # generated by catalog service. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Required. The user-supplied fully qualified name of the `Resource` - # associated to the `Catalog`. It supports `Organization`, `Folder`, - # and `Project`. Values are of the form - # * `//cloudresourcemanager.googleapis.com/projects/`product_number`` - # * `//cloudresourcemanager.googleapis.com/folders/`folder_id`` - # * `//cloudresourcemanager.googleapis.com/organizations/`organization_id`` - # Corresponds to the JSON property `resource` - # @return [String] - attr_accessor :resource + # Nodes to which we should apply the instance-level parameter group. + # Corresponds to the JSON property `nodeIds` + # @return [Array] + attr_accessor :node_ids def initialize(**args) update!(**args) @@ -72,512 +45,8 @@ module Google # Update properties of this object def update!(**args) - @create_time = args[:create_time] if args.key?(:create_time) - @name = args[:name] if args.key?(:name) - @resource = args[:resource] if args.key?(:resource) - end - end - - # The producer representation of a catalog which is a curated collection of - # solutions that can be managed, controlled, and shared by cloud admins. - class GoogleCloudPrivatecatalogproducerV1beta1Catalog - include Google::Apis::Core::Hashable - - # Output only. The time when the catalog was created. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Required. The user-supplied description of the catalog. Maximum of 512 - # characters. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # Required. The user-supplied descriptive name of the catalog as it appears - # in UIs. Maximum 256 characters in length. - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # Output only. The resource name of the catalog, in the format - # `catalogs/`catalog_id`'. - # A unique identifier for the catalog, which is generated - # by catalog service. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Required. The parent resource name of the catalog, which can't be changed - # after a catalog is created. It can only be an organization. Values are of - # the form `//cloudresourcemanager.googleapis.com/organizations/`. - # Maximum 256 characters in length. - # Corresponds to the JSON property `parent` - # @return [String] - attr_accessor :parent - - # Output only. The time when the catalog was last updated. - # 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) - @description = args[:description] if args.key?(:description) - @display_name = args[:display_name] if args.key?(:display_name) - @name = args[:name] if args.key?(:name) - @parent = args[:parent] if args.key?(:parent) - @update_time = args[:update_time] if args.key?(:update_time) - end - end - - # - class GoogleCloudPrivatecatalogproducerV1beta1CopyProductRequest - include Google::Apis::Core::Hashable - - # The resource name of the destination product that is copied to. - # Corresponds to the JSON property `destinationProductName` - # @return [String] - attr_accessor :destination_product_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @destination_product_name = args[:destination_product_name] if args.key?(:destination_product_name) - end - end - - # - class GoogleCloudPrivatecatalogproducerV1beta1CreateAssociationRequest - include Google::Apis::Core::Hashable - - # An association tuple that pairs a `Catalog` to a resource - # that can use the `Catalog`. After association, a - # google.cloud.privatecatalog.v1beta1.Catalog becomes available to - # consumers under specified Association.resource and all of its child - # nodes. - # Users who have the `cloudprivatecatalog.targets.get` permission on any of - # the resource nodes can access the catalog and child products under the node. - # For example, suppose the cloud resource hierarchy is as follows: - # * organizations/example.com - # * folders/team - # * projects/test - # After creating an association with `organizations/example.com`, the catalog - # `catalogs/1` is accessible from the following paths: - # * organizations/example.com - # * folders/team - # * projects/test - # Users can access them by - # google.cloud.v1beta1.PrivateCatalog.SearchCatalogs action. - # Corresponds to the JSON property `association` - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleCloudPrivatecatalogproducerV1beta1Association] - attr_accessor :association - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @association = args[:association] if args.key?(:association) - end - end - - # - class GoogleCloudPrivatecatalogproducerV1beta1ListAssociationsResponse - include Google::Apis::Core::Hashable - - # The returned `Association` resources from the list call. - # Corresponds to the JSON property `associations` - # @return [Array] - attr_accessor :associations - - # A pagination token returned from a previous call to - # `ListAssociations` that indicates where the listing should continue from. - # This field is optional. - # 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) - @associations = args[:associations] if args.key?(:associations) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # - class GoogleCloudPrivatecatalogproducerV1beta1ListCatalogsResponse - include Google::Apis::Core::Hashable - - # The `Catalogs` returned from the list call. - # Corresponds to the JSON property `catalogs` - # @return [Array] - attr_accessor :catalogs - - # A pagination token returned from a previous call to ListCatalogs - # that indicates where the listing should continue from. - # This field is optional. - # 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) - @catalogs = args[:catalogs] if args.key?(:catalogs) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # - class GoogleCloudPrivatecatalogproducerV1beta1ListProductsResponse - include Google::Apis::Core::Hashable - - # A pagination token returned from a previous call to ListProducts - # that indicates where the listing should continue from. - # This field is optional. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # The `Product` returned from the list call. - # Corresponds to the JSON property `products` - # @return [Array] - attr_accessor :products - - 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) - @products = args[:products] if args.key?(:products) - end - end - - # - class GoogleCloudPrivatecatalogproducerV1beta1ListVersionsResponse - include Google::Apis::Core::Hashable - - # A pagination token returned from a previous call to ListProducts - # that indicates where the listing should continue from. - # This field is optional. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # The `VersiVersionon` returned from the list call. - # Corresponds to the JSON property `versions` - # @return [Array] - attr_accessor :versions - - 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) - @versions = args[:versions] if args.key?(:versions) - end - end - - # The producer representation of a product which is a child resource of - # `Catalog` with display metadata and a list of `Version` resources. - class GoogleCloudPrivatecatalogproducerV1beta1Product - include Google::Apis::Core::Hashable - - # Required. The type of the product asset, which cannot be changed after the - # product is created. It supports the values - # `google.deploymentmanager.Template` and - # `google.cloudprivatecatalog.ListingOnly`. Other values will be - # rejected by the server. Read only after creation. - # The following fields or resource types have different validation rules - # under each `asset_type` values: - # * Product.display_metadata has different validation schema for each - # asset type value. See its comment for details. - # * Version resource isn't allowed to be added under the - # `google.cloudprivatecatalog.ListingOnly` type. - # Corresponds to the JSON property `assetType` - # @return [String] - attr_accessor :asset_type - - # Output only. The time when the product was created. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # The user-supplied display metadata to describe the product. - # The JSON schema of the metadata differs by Product.asset_type. - # When the type is `google.deploymentmanager.Template`, the schema is as - # follows: - # ``` - # "$schema": http://json-schema.org/draft-04/schema# - # type: object - # properties: - # name: - # type: string - # minLength: 1 - # maxLength: 64 - # description: - # type: string - # minLength: 1 - # maxLength: 2048 - # tagline: - # type: string - # minLength: 1 - # maxLength: 100 - # support_info: - # type: string - # minLength: 1 - # maxLength: 2048 - # creator: - # type: string - # minLength: 1 - # maxLength: 100 - # documentation: - # type: array - # items: - # type: object - # properties: - # url: - # type: string - # pattern: - # "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" - # title: - # type: string - # minLength: 1 - # maxLength: 64 - # description: - # type: string - # minLength: 1 - # maxLength: 2048 - # required: - # - name - # - description - # additionalProperties: false - # ``` - # When the asset type is `google.cloudprivatecatalog.ListingOnly`, the schema - # is as follows: - # ``` - # "$schema": http://json-schema.org/draft-04/schema# - # type: object - # properties: - # name: - # type: string - # minLength: 1 - # maxLength: 64 - # description: - # type: string - # minLength: 1 - # maxLength: 2048 - # tagline: - # type: string - # minLength: 1 - # maxLength: 100 - # support_info: - # type: string - # minLength: 1 - # maxLength: 2048 - # creator: - # type: string - # minLength: 1 - # maxLength: 100 - # documentation: - # type: array - # items: - # type: object - # properties: - # url: - # type: string - # pattern: - # "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" - # title: - # type: string - # minLength: 1 - # maxLength: 64 - # description: - # type: string - # minLength: 1 - # maxLength: 2048 - # signup_url: - # type: string - # pattern: - # "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" - # required: - # - name - # - description - # - signup_url - # additionalProperties: false - # ``` - # Corresponds to the JSON property `displayMetadata` - # @return [Hash] - attr_accessor :display_metadata - - # Output only. The public accessible URI of the icon uploaded by - # PrivateCatalogProducer.UploadIcon. - # If no icon is uploaded, it will be the default icon's URI. - # Corresponds to the JSON property `iconUri` - # @return [String] - attr_accessor :icon_uri - - # Required. The resource name of the product in the format - # `catalogs/`catalog_id`/products/a-z*[a-z0-9]'. - # A unique identifier for the product under a catalog, which cannot - # be changed after the product is created. The final - # segment of the name must between 1 and 256 characters in length. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Output only. The time when the product was last updated. - # 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) - @asset_type = args[:asset_type] if args.key?(:asset_type) - @create_time = args[:create_time] if args.key?(:create_time) - @display_metadata = args[:display_metadata] if args.key?(:display_metadata) - @icon_uri = args[:icon_uri] if args.key?(:icon_uri) - @name = args[:name] if args.key?(:name) - @update_time = args[:update_time] if args.key?(:update_time) - end - end - - # - class GoogleCloudPrivatecatalogproducerV1beta1UndeleteCatalogRequest - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - - # - class GoogleCloudPrivatecatalogproducerV1beta1UploadIconRequest - include Google::Apis::Core::Hashable - - # The raw icon bytes user-supplied to be uploaded to the product. The format - # of the icon can only be PNG or JPEG. The minimum allowed dimensions are - # 130x130 pixels and the maximum dimensions are 10000x10000 pixels. - # Required. - # Corresponds to the JSON property `icon` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :icon - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @icon = args[:icon] if args.key?(:icon) - end - end - - # The producer representation of a version, which is a child resource under a - # `Product` with asset data. - class GoogleCloudPrivatecatalogproducerV1beta1Version - include Google::Apis::Core::Hashable - - # Output only. The asset which has been validated and is ready to be - # provisioned. See Version.original_asset for the schema. - # Corresponds to the JSON property `asset` - # @return [Hash] - attr_accessor :asset - - # Output only. The time when the version was created. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # The user-supplied description of the version. Maximum of 256 characters. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # Required. The resource name of the version, in the format - # `catalogs/`catalog_id`/products/`product_id`/versions/a-z*[a-z0-9]'. - # A unique identifier for the version under a product, which can't - # be changed after the version is created. The final segment of the name must - # between 1 and 63 characters in length. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The user-supplied asset payload. The maximum size of the payload is 2MB. - # The JSON schema of the payload is defined as: - # ``` - # type: object - # properties: - # mainTemplate: - # type: string - # description: The file name of the main template and name prefix of - # schema file. The content of the main template should be set in the - # imports list. The schema file name is expected to be - # .schema in the imports list. required: true - # imports: - # type: array - # description: Import template and schema file contents. Required to have - # both and .schema files. required: true - # minItems: 2 - # items: - # type: object - # properties: - # name: - # type: string - # content: - # type: string - # ``` - # Corresponds to the JSON property `originalAsset` - # @return [Hash] - attr_accessor :original_asset - - # Output only. The time when the version was last updated. - # 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) - @asset = args[:asset] if args.key?(:asset) - @create_time = args[:create_time] if args.key?(:create_time) - @description = args[:description] if args.key?(:description) - @name = args[:name] if args.key?(:name) - @original_asset = args[:original_asset] if args.key?(:original_asset) - @update_time = args[:update_time] if args.key?(:update_time) + @apply_all = args[:apply_all] if args.key?(:apply_all) + @node_ids = args[:node_ids] if args.key?(:node_ids) end end @@ -628,12 +97,12 @@ module Google # 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 GoogleIamV1AuditConfig + class AuditConfig include Google::Apis::Core::Hashable # The configuration for logging of each type of permission. # Corresponds to the JSON property `auditLogConfigs` - # @return [Array] + # @return [Array] attr_accessor :audit_log_configs # Specifies a service that will be enabled for audit logging. @@ -671,7 +140,7 @@ module Google # ` # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting # jose@example.com from DATA_READ logging. - class GoogleIamV1AuditLogConfig + class AuditLogConfig include Google::Apis::Core::Hashable # Specifies the identities that do not cause logging for this type of @@ -698,7 +167,7 @@ module Google end # Associates `members` with a `role`. - class GoogleIamV1Binding + class Binding include Google::Apis::Core::Hashable # Represents a textual expression in the Common Expression Language (CEL) @@ -724,7 +193,7 @@ module Google # are determined by the service that evaluates it. See the service # documentation for additional information. # Corresponds to the JSON property `condition` - # @return [Google::Apis::CloudprivatecatalogproducerV1beta1::GoogleTypeExpr] + # @return [Google::Apis::MemcacheV1beta2::Expr] attr_accessor :condition # Specifies the identities requesting access for a Cloud Platform resource. @@ -780,6 +249,1005 @@ module Google end end + # The request message for Operations.CancelOperation. + class CancelOperationRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + 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 + + # 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 Expr + 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 + + # Metadata for the given google.cloud.location.Location. + class GoogleCloudMemcacheV1beta2LocationMetadata + include Google::Apis::Core::Hashable + + # Output only. The set of available zones in the location. The map is keyed + # by the lowercase ID of each zone, as defined by GCE. These keys can be + # specified in the `zones` field when creating a Memcached instance. + # Corresponds to the JSON property `availableZones` + # @return [Hash] + attr_accessor :available_zones + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @available_zones = args[:available_zones] if args.key?(:available_zones) + end + end + + # Represents the metadata of a long-running operation. + class GoogleCloudMemcacheV1beta2OperationMetadata + include Google::Apis::Core::Hashable + + # API version used to start the operation. + # Corresponds to the JSON property `apiVersion` + # @return [String] + attr_accessor :api_version + + # 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 `cancelRequested` + # @return [Boolean] + attr_accessor :cancel_requested + alias_method :cancel_requested?, :cancel_requested + + # Time when the operation was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Time when the operation finished running. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Human-readable status of the operation, if any. + # Corresponds to the JSON property `statusDetail` + # @return [String] + attr_accessor :status_detail + + # Server-defined resource path for the target of the operation. + # Corresponds to the JSON property `target` + # @return [String] + attr_accessor :target + + # 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) + @cancel_requested = args[:cancel_requested] if args.key?(:cancel_requested) + @create_time = args[:create_time] if args.key?(:create_time) + @end_time = args[:end_time] if args.key?(:end_time) + @status_detail = args[:status_detail] if args.key?(:status_detail) + @target = args[:target] if args.key?(:target) + @verb = args[:verb] if args.key?(:verb) + end + end + + # + class GoogleCloudSaasacceleratorManagementProvidersV1Instance + include Google::Apis::Core::Hashable + + # consumer_defined_name is the name that is set by the consumer. On the other + # hand Name field represents system-assigned id of an instance so consumers + # are not necessarily aware of it. + # consumer_defined_name is used for notification/UI purposes for consumer to + # recognize their instances. + # Corresponds to the JSON property `consumerDefinedName` + # @return [String] + attr_accessor :consumer_defined_name + + # Output only. Timestamp when the resource was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Optional. Resource labels to represent user provided metadata. Each label + # is a key-value pair, where both the key and the value are arbitrary strings + # provided by the user. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # The MaintenancePolicies that have been attached to the instance. + # The key must be of the type name of the oneof policy name defined in + # MaintenancePolicy, and the referenced policy must define the same policy + # type. For complete details of MaintenancePolicy, please refer to + # go/cloud-saas-mw-ug. + # Corresponds to the JSON property `maintenancePolicyNames` + # @return [Hash] + attr_accessor :maintenance_policy_names + + # The MaintenanceSchedule contains the scheduling information of published + # maintenance schedule. + # Corresponds to the JSON property `maintenanceSchedules` + # @return [Hash] + attr_accessor :maintenance_schedules + + # Unique name of the resource. It uses the form: + # `projects/`project_id`/locations/`location_id`/instances/`instance_id`` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. Custom string attributes used primarily to expose + # producer-specific information in monitoring dashboards. + # See go/get-instance-metadata. + # Corresponds to the JSON property `producerMetadata` + # @return [Hash] + attr_accessor :producer_metadata + + # Output only. The list of data plane resources provisioned for this + # instance, e.g. compute VMs. See go/get-instance-metadata. + # Corresponds to the JSON property `provisionedResources` + # @return [Array] + attr_accessor :provisioned_resources + + # Link to the SLM instance template. Only populated when updating SLM + # instances via SSA's Actuation service adaptor. + # Service producers with custom control plane (e.g. Cloud SQL) doesn't + # need to populate this field. Instead they should use software_versions. + # Corresponds to the JSON property `slmInstanceTemplate` + # @return [String] + attr_accessor :slm_instance_template + + # SloMetadata contains resources required for proper SLO classification of the + # instance. + # Corresponds to the JSON property `sloMetadata` + # @return [Google::Apis::MemcacheV1beta2::GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata] + attr_accessor :slo_metadata + + # Software versions that are used to deploy this instance. This can be + # mutated by rollout services. + # Corresponds to the JSON property `softwareVersions` + # @return [Hash] + attr_accessor :software_versions + + # Output only. Current lifecycle state of the resource (e.g. if it's being + # created or ready to use). + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # Output only. ID of the associated GCP tenant project. + # See go/get-instance-metadata. + # Corresponds to the JSON property `tenantProjectId` + # @return [String] + attr_accessor :tenant_project_id + + # Output only. Timestamp when the resource was last modified. + # 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) + @consumer_defined_name = args[:consumer_defined_name] if args.key?(:consumer_defined_name) + @create_time = args[:create_time] if args.key?(:create_time) + @labels = args[:labels] if args.key?(:labels) + @maintenance_policy_names = args[:maintenance_policy_names] if args.key?(:maintenance_policy_names) + @maintenance_schedules = args[:maintenance_schedules] if args.key?(:maintenance_schedules) + @name = args[:name] if args.key?(:name) + @producer_metadata = args[:producer_metadata] if args.key?(:producer_metadata) + @provisioned_resources = args[:provisioned_resources] if args.key?(:provisioned_resources) + @slm_instance_template = args[:slm_instance_template] if args.key?(:slm_instance_template) + @slo_metadata = args[:slo_metadata] if args.key?(:slo_metadata) + @software_versions = args[:software_versions] if args.key?(:software_versions) + @state = args[:state] if args.key?(:state) + @tenant_project_id = args[:tenant_project_id] if args.key?(:tenant_project_id) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # Maintenance schedule which is exposed to customer and potentially end user, + # indicating published upcoming future maintenance schedule + class GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule + include Google::Apis::Core::Hashable + + # Can this scheduled update be rescheduled? + # By default, it's true and API needs to do explicitly check whether it's + # set, if it's set as false explicitly, it's false + # Corresponds to the JSON property `canReschedule` + # @return [Boolean] + attr_accessor :can_reschedule + alias_method :can_reschedule?, :can_reschedule + + # The scheduled end time for the maintenance. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # The rollout management policy this maintenance schedule is associated + # with. When doing reschedule update request, the reschedule should be + # against this given policy. + # Corresponds to the JSON property `rolloutManagementPolicy` + # @return [String] + attr_accessor :rollout_management_policy + + # The scheduled start time for the maintenance. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @can_reschedule = args[:can_reschedule] if args.key?(:can_reschedule) + @end_time = args[:end_time] if args.key?(:end_time) + @rollout_management_policy = args[:rollout_management_policy] if args.key?(:rollout_management_policy) + @start_time = args[:start_time] if args.key?(:start_time) + end + end + + # Node information for custom per-node SLO implementations. + # SSA does not support per-node SLO, but producers can populate per-node + # information in SloMetadata for custom precomputations. + # SSA Eligibility Exporter will emit per-node metric based on this information. + class GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata + include Google::Apis::Core::Hashable + + # By default node is eligible if instance is eligible. + # But individual node might be excluded from SLO by adding entry here. + # For semantic see SloMetadata.exclusions. + # If both instance and node level exclusions are present for time period, + # the node level's reason will be reported by Eligibility Exporter. + # Corresponds to the JSON property `exclusions` + # @return [Array] + attr_accessor :exclusions + + # The location of the node, if different from instance location. + # Corresponds to the JSON property `location` + # @return [String] + attr_accessor :location + + # The id of the node. + # This should be equal to SaasInstanceNode.node_id. + # Corresponds to the JSON property `nodeId` + # @return [String] + attr_accessor :node_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @exclusions = args[:exclusions] if args.key?(:exclusions) + @location = args[:location] if args.key?(:location) + @node_id = args[:node_id] if args.key?(:node_id) + end + end + + # Describes provisioned dataplane resources. + class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource + include Google::Apis::Core::Hashable + + # Type of the resource. This can be either a GCP resource or a custom one + # (e.g. another cloud provider's VM). For GCP compute resources use singular + # form of the names listed in GCP compute API documentation + # (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with + # 'compute-', for example: 'compute-instance', 'compute-disk', + # 'compute-autoscaler'. + # Corresponds to the JSON property `resourceType` + # @return [String] + attr_accessor :resource_type + + # URL identifying the resource, e.g. + # "https://www.googleapis.com/compute/v1/projects/...)". + # Corresponds to the JSON property `resourceUrl` + # @return [String] + attr_accessor :resource_url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_type = args[:resource_type] if args.key?(:resource_type) + @resource_url = args[:resource_url] if args.key?(:resource_url) + end + end + + # SloEligibility is a tuple containing eligibility value: true if an instance + # is eligible for SLO calculation or false if it should be excluded from all + # SLO-related calculations along with a user-defined reason. + class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility + include Google::Apis::Core::Hashable + + # Whether an instance is eligible or ineligible. + # Corresponds to the JSON property `eligible` + # @return [Boolean] + attr_accessor :eligible + alias_method :eligible?, :eligible + + # User-defined reason for the current value of instance eligibility. Usually, + # this can be directly mapped to the internal state. An empty reason is + # allowed. + # Corresponds to the JSON property `reason` + # @return [String] + attr_accessor :reason + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @eligible = args[:eligible] if args.key?(:eligible) + @reason = args[:reason] if args.key?(:reason) + end + end + + # SloExclusion represents an exclusion in SLI calculation applies to all SLOs. + class GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion + include Google::Apis::Core::Hashable + + # Exclusion duration. No restrictions on the possible values. + # When an ongoing operation is taking longer than initially expected, + # an existing entry in the exclusion list can be updated by extending the + # duration. This is supported by the subsystem exporting eligibility data + # as long as such extension is committed at least 10 minutes before the + # original exclusion expiration - otherwise it is possible that there will + # be "gaps" in the exclusion application in the exported timeseries. + # Corresponds to the JSON property `duration` + # @return [String] + attr_accessor :duration + + # Human-readable reason for the exclusion. + # This should be a static string (e.g. "Disruptive update in progress") + # and should not contain dynamically generated data (e.g. instance name). + # Can be left empty. + # Corresponds to the JSON property `reason` + # @return [String] + attr_accessor :reason + + # Name of an SLI that this exclusion applies to. Can be left empty, + # signaling that the instance should be excluded from all SLIs defined + # in the service SLO configuration. + # Corresponds to the JSON property `sliName` + # @return [String] + attr_accessor :sli_name + + # Start time of the exclusion. No alignment (e.g. to a full minute) needed. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @duration = args[:duration] if args.key?(:duration) + @reason = args[:reason] if args.key?(:reason) + @sli_name = args[:sli_name] if args.key?(:sli_name) + @start_time = args[:start_time] if args.key?(:start_time) + end + end + + # SloMetadata contains resources required for proper SLO classification of the + # instance. + class GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata + include Google::Apis::Core::Hashable + + # SloEligibility is a tuple containing eligibility value: true if an instance + # is eligible for SLO calculation or false if it should be excluded from all + # SLO-related calculations along with a user-defined reason. + # Corresponds to the JSON property `eligibility` + # @return [Google::Apis::MemcacheV1beta2::GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility] + attr_accessor :eligibility + + # List of SLO exclusion windows. When multiple entries in the list match + # (matching the exclusion time-window against current time point) + # the exclusion reason used in the first matching entry will be published. + # It is not needed to include expired exclusion in this list, as only the + # currently applicable exclusions are taken into account by the eligibility + # exporting subsystem (the historical state of exclusions will be reflected + # in the historically produced timeseries regardless of the current state). + # This field can be used to mark the instance as temporary ineligible + # for the purpose of SLO calculation. For permanent instance SLO exclusion, + # use of custom instance eligibility is recommended. See 'eligibility' field + # below. + # Corresponds to the JSON property `exclusions` + # @return [Array] + attr_accessor :exclusions + + # Optional. List of nodes. + # Some producers need to use per-node metadata to calculate SLO. + # This field allows such producers to publish per-node SLO meta data, + # which will be consumed by SSA Eligibility Exporter and published in the + # form of per node metric to Monarch. + # Corresponds to the JSON property `nodes` + # @return [Array] + attr_accessor :nodes + + # Name of the SLO tier the Instance belongs to. This name will be expected to + # match the tiers specified in the service SLO configuration. + # Field is mandatory and must not be empty. + # Corresponds to the JSON property `tier` + # @return [String] + attr_accessor :tier + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @eligibility = args[:eligibility] if args.key?(:eligibility) + @exclusions = args[:exclusions] if args.key?(:exclusions) + @nodes = args[:nodes] if args.key?(:nodes) + @tier = args[:tier] if args.key?(:tier) + end + end + + # + class Instance + include Google::Apis::Core::Hashable + + # Optional. The full name of the Google Compute Engine + # [network](/compute/docs/networks-and-firewalls#networks) to which the + # instance is connected. If left unspecified, the `default` network + # will be used. + # Corresponds to the JSON property `authorizedNetwork` + # @return [String] + attr_accessor :authorized_network + + # Output only. The time the instance was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Output only. Endpoint for Discovery API + # Corresponds to the JSON property `discoveryEndpoint` + # @return [String] + attr_accessor :discovery_endpoint + + # Optional. User provided name for the instance only used for display + # purposes. Cannot be more than 80 characters. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # List of messages that describe current statuses of memcached instance. + # Corresponds to the JSON property `instanceMessages` + # @return [Array] + attr_accessor :instance_messages + + # 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] + attr_accessor :labels + + # Output only. The full version of memcached server running on this instance. + # System automatically determines the full memcached version for an instance + # based on the input MemcacheVersion. + # The full version format will be "memcached-1.5.16". + # Corresponds to the JSON property `memcacheFullVersion` + # @return [String] + attr_accessor :memcache_full_version + + # Output only. List of Memcached nodes. + # Refer to [Node] message for more details. + # Corresponds to the JSON property `memcacheNodes` + # @return [Array] + attr_accessor :memcache_nodes + + # Optional. The major version of Memcached software. + # If not provided, latest supported version will be used. Currently the + # latest supported major version is MEMCACHE_1_5. + # The minor version will be automatically determined by our system based on + # the latest supported minor version. + # Corresponds to the JSON property `memcacheVersion` + # @return [String] + attr_accessor :memcache_version + + # Required. Unique name of the resource in this scope including project and + # location using the form: + # `projects/`project_id`/locations/`location_id`/instances/`instance_id`` + # Note: Memcached instances are managed and addressed at regional level so + # location_id here refers to a GCP region; however, users may choose which + # zones Memcached nodes within an instances should be provisioned in. + # Refer to [zones] field for more details. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Configuration for a Memcached Node. + # Corresponds to the JSON property `nodeConfig` + # @return [Google::Apis::MemcacheV1beta2::NodeConfig] + attr_accessor :node_config + + # Required. Number of nodes in the Memcached instance. + # Corresponds to the JSON property `nodeCount` + # @return [Fixnum] + attr_accessor :node_count + + # Optional: User defined parameters to apply to the memcached process + # on each node. + # Corresponds to the JSON property `parameters` + # @return [Google::Apis::MemcacheV1beta2::MemcacheParameters] + attr_accessor :parameters + + # Output only. The state of this Memcached instance. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # Output only. The time the instance was updated. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + # Optional. Zones where Memcached nodes should be provisioned in. + # Memcached nodes will be equally distributed across these zones. If not + # provided, the service will by default create nodes in all zones in the + # region for the instance. + # Corresponds to the JSON property `zones` + # @return [Array] + attr_accessor :zones + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @authorized_network = args[:authorized_network] if args.key?(:authorized_network) + @create_time = args[:create_time] if args.key?(:create_time) + @discovery_endpoint = args[:discovery_endpoint] if args.key?(:discovery_endpoint) + @display_name = args[:display_name] if args.key?(:display_name) + @instance_messages = args[:instance_messages] if args.key?(:instance_messages) + @labels = args[:labels] if args.key?(:labels) + @memcache_full_version = args[:memcache_full_version] if args.key?(:memcache_full_version) + @memcache_nodes = args[:memcache_nodes] if args.key?(:memcache_nodes) + @memcache_version = args[:memcache_version] if args.key?(:memcache_version) + @name = args[:name] if args.key?(:name) + @node_config = args[:node_config] if args.key?(:node_config) + @node_count = args[:node_count] if args.key?(:node_count) + @parameters = args[:parameters] if args.key?(:parameters) + @state = args[:state] if args.key?(:state) + @update_time = args[:update_time] if args.key?(:update_time) + @zones = args[:zones] if args.key?(:zones) + end + end + + # + class InstanceMessage + include Google::Apis::Core::Hashable + + # A code that correspond to one type of user-facing message. + # Corresponds to the JSON property `code` + # @return [String] + attr_accessor :code + + # Message on memcached instance which will be exposed to users. + # 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) + @message = args[:message] if args.key?(:message) + end + end + + # Response for ListInstances. + class ListInstancesResponse + include Google::Apis::Core::Hashable + + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # A list of Memcached instances in the project in the specified location, + # or across all locations. + # If the `location_id` in the parent field of the request is "-", all regions + # available to the project are queried, and the results aggregated. + # Corresponds to the JSON property `resources` + # @return [Array] + attr_accessor :resources + + # Locations that could not be reached. + # Corresponds to the JSON property `unreachable` + # @return [Array] + attr_accessor :unreachable + + 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) + @resources = args[:resources] if args.key?(:resources) + @unreachable = args[:unreachable] if args.key?(:unreachable) + end + end + + # The response message for Locations.ListLocations. + class ListLocationsResponse + 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] + 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 ListOperationsResponse + 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] + 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 Location + 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] + 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] + 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 + + # + class MemcacheParameters + include Google::Apis::Core::Hashable + + # Output only. The unique ID associated with this set of parameters. Users + # can use this id to determine if the parameters associated with the instance + # differ from the parameters associated with the nodes and any action needs + # to be taken to apply parameters on nodes. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # User defined set of parameters to use in the memcached process. + # Corresponds to the JSON property `params` + # @return [Hash] + attr_accessor :params + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @params = args[:params] if args.key?(:params) + end + end + + # + class Node + include Google::Apis::Core::Hashable + + # Output only. Hostname or IP address of the Memcached node used by the + # clients to connect to the Memcached server on this node. + # Corresponds to the JSON property `host` + # @return [String] + attr_accessor :host + + # Output only. Identifier of the Memcached node. The node id does not + # include project or location like the Memcached instance name. + # Corresponds to the JSON property `nodeId` + # @return [String] + attr_accessor :node_id + + # User defined parameters currently applied to the node. + # Corresponds to the JSON property `parameters` + # @return [Google::Apis::MemcacheV1beta2::MemcacheParameters] + attr_accessor :parameters + + # Output only. The port number of the Memcached server on this node. + # Corresponds to the JSON property `port` + # @return [Fixnum] + attr_accessor :port + + # Output only. Current state of the Memcached node. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # Output only. Location (GCP Zone) for the Memcached node. + # Corresponds to the JSON property `zone` + # @return [String] + attr_accessor :zone + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @host = args[:host] if args.key?(:host) + @node_id = args[:node_id] if args.key?(:node_id) + @parameters = args[:parameters] if args.key?(:parameters) + @port = args[:port] if args.key?(:port) + @state = args[:state] if args.key?(:state) + @zone = args[:zone] if args.key?(:zone) + end + end + + # Configuration for a Memcached Node. + class NodeConfig + include Google::Apis::Core::Hashable + + # Required. Number of cpus per Memcached node. + # Corresponds to the JSON property `cpuCount` + # @return [Fixnum] + attr_accessor :cpu_count + + # Required. Memory size in MiB for each Memcached node. + # Corresponds to the JSON property `memorySizeMb` + # @return [Fixnum] + attr_accessor :memory_size_mb + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cpu_count = args[:cpu_count] if args.key?(:cpu_count) + @memory_size_mb = args[:memory_size_mb] if args.key?(:memory_size_mb) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + class Operation + 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::MemcacheV1beta2::Status] + 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] + 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] + 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 + # 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 @@ -836,19 +1304,19 @@ module Google # - version: 3 # For a description of IAM and its features, see the # [IAM documentation](https://cloud.google.com/iam/docs/). - class GoogleIamV1Policy + class Policy include Google::Apis::Core::Hashable # Specifies cloud audit logging configuration for this policy. # Corresponds to the JSON property `auditConfigs` - # @return [Array] + # @return [Array] 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] + # @return [Array] attr_accessor :bindings # `etag` is used for optimistic concurrency control as a way to help @@ -901,7 +1369,7 @@ module Google end # Request message for `SetIamPolicy` method. - class GoogleIamV1SetIamPolicyRequest + class SetIamPolicyRequest include Google::Apis::Core::Hashable # An Identity and Access Management (IAM) policy, which specifies access @@ -961,7 +1429,7 @@ module Google # 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::CloudprivatecatalogproducerV1beta1::GoogleIamV1Policy] + # @return [Google::Apis::MemcacheV1beta2::Policy] attr_accessor :policy # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only @@ -984,176 +1452,13 @@ module Google end end - # Request message for `TestIamPermissions` method. - class GoogleIamV1TestIamPermissionsRequest - 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] - 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 GoogleIamV1TestIamPermissionsResponse - include Google::Apis::Core::Hashable - - # A subset of `TestPermissionsRequest.permissions` that the caller is - # allowed. - # Corresponds to the JSON property `permissions` - # @return [Array] - 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 - - # The request message for Operations.CancelOperation. - class GoogleLongrunningCancelOperationRequest - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - - # The response message for Operations.ListOperations. - class GoogleLongrunningListOperationsResponse - 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] - 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 - - # This resource represents a long-running operation that is the result of a - # network API call. - class GoogleLongrunningOperation - 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::CloudprivatecatalogproducerV1beta1::GoogleRpcStatus] - 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] - 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] - 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 - - # 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 GoogleProtobufEmpty - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - 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 GoogleRpcStatus + class Status include Google::Apis::Core::Hashable # The status code, which should be an enum value of google.rpc.Code. @@ -1186,55 +1491,76 @@ module Google 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 GoogleTypeExpr + # Request message for `TestIamPermissions` method. + class TestIamPermissionsRequest 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 + # 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] + 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 TestIamPermissionsResponse + include Google::Apis::Core::Hashable + + # A subset of `TestPermissionsRequest.permissions` that the caller is + # allowed. + # Corresponds to the JSON property `permissions` + # @return [Array] + 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 + + # Request for UpdateParameters. + class UpdateParametersRequest + include Google::Apis::Core::Hashable + + # The parameters to apply to the instance. + # Corresponds to the JSON property `parameters` + # @return [Google::Apis::MemcacheV1beta2::MemcacheParameters] + attr_accessor :parameters + + # Required. Mask of fields to update. + # 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) + @parameters = args[:parameters] if args.key?(:parameters) + @update_mask = args[:update_mask] if args.key?(:update_mask) + end + end + + # + class ZoneMetadata + include Google::Apis::Core::Hashable def initialize(**args) update!(**args) @@ -1242,10 +1568,6 @@ module Google # 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 end diff --git a/generated/google/apis/memcache_v1beta2/representations.rb b/generated/google/apis/memcache_v1beta2/representations.rb new file mode 100644 index 000000000..70f24016c --- /dev/null +++ b/generated/google/apis/memcache_v1beta2/representations.rb @@ -0,0 +1,557 @@ +# Copyright 2015 Google Inc. +# +# 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 MemcacheV1beta2 + + class ApplyParametersRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuditConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuditLogConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Binding + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CancelOperationRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Expr + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudMemcacheV1beta2LocationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudMemcacheV1beta2OperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudSaasacceleratorManagementProvidersV1Instance + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Instance + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InstanceMessage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListInstancesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListLocationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListOperationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Location + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MemcacheParameters + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Node + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NodeConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Operation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Policy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SetIamPolicyRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Status + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TestIamPermissionsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TestIamPermissionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UpdateParametersRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ZoneMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ApplyParametersRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :apply_all, as: 'applyAll' + collection :node_ids, as: 'nodeIds' + end + end + + class AuditConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::MemcacheV1beta2::AuditLogConfig, decorator: Google::Apis::MemcacheV1beta2::AuditLogConfig::Representation + + property :service, as: 'service' + end + end + + class AuditLogConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :exempted_members, as: 'exemptedMembers' + property :log_type, as: 'logType' + end + end + + class Binding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :condition, as: 'condition', class: Google::Apis::MemcacheV1beta2::Expr, decorator: Google::Apis::MemcacheV1beta2::Expr::Representation + + collection :members, as: 'members' + property :role, as: 'role' + end + end + + class CancelOperationRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class Expr + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :expression, as: 'expression' + property :location, as: 'location' + property :title, as: 'title' + end + end + + class GoogleCloudMemcacheV1beta2LocationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :available_zones, as: 'availableZones', class: Google::Apis::MemcacheV1beta2::ZoneMetadata, decorator: Google::Apis::MemcacheV1beta2::ZoneMetadata::Representation + + end + end + + class GoogleCloudMemcacheV1beta2OperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :api_version, as: 'apiVersion' + property :cancel_requested, as: 'cancelRequested' + property :create_time, as: 'createTime' + property :end_time, as: 'endTime' + property :status_detail, as: 'statusDetail' + property :target, as: 'target' + property :verb, as: 'verb' + end + end + + class GoogleCloudSaasacceleratorManagementProvidersV1Instance + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :consumer_defined_name, as: 'consumerDefinedName' + property :create_time, as: 'createTime' + hash :labels, as: 'labels' + hash :maintenance_policy_names, as: 'maintenancePolicyNames' + hash :maintenance_schedules, as: 'maintenanceSchedules', class: Google::Apis::MemcacheV1beta2::GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule, decorator: Google::Apis::MemcacheV1beta2::GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule::Representation + + property :name, as: 'name' + hash :producer_metadata, as: 'producerMetadata' + collection :provisioned_resources, as: 'provisionedResources', class: Google::Apis::MemcacheV1beta2::GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource, decorator: Google::Apis::MemcacheV1beta2::GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource::Representation + + property :slm_instance_template, as: 'slmInstanceTemplate' + property :slo_metadata, as: 'sloMetadata', class: Google::Apis::MemcacheV1beta2::GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata, decorator: Google::Apis::MemcacheV1beta2::GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata::Representation + + hash :software_versions, as: 'softwareVersions' + property :state, as: 'state' + property :tenant_project_id, as: 'tenantProjectId' + property :update_time, as: 'updateTime' + end + end + + class GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :can_reschedule, as: 'canReschedule' + property :end_time, as: 'endTime' + property :rollout_management_policy, as: 'rolloutManagementPolicy' + property :start_time, as: 'startTime' + end + end + + class GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :exclusions, as: 'exclusions', class: Google::Apis::MemcacheV1beta2::GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion, decorator: Google::Apis::MemcacheV1beta2::GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion::Representation + + property :location, as: 'location' + property :node_id, as: 'nodeId' + end + end + + class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :resource_type, as: 'resourceType' + property :resource_url, as: 'resourceUrl' + end + end + + class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :eligible, as: 'eligible' + property :reason, as: 'reason' + end + end + + class GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :duration, as: 'duration' + property :reason, as: 'reason' + property :sli_name, as: 'sliName' + property :start_time, as: 'startTime' + end + end + + class GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :eligibility, as: 'eligibility', class: Google::Apis::MemcacheV1beta2::GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility, decorator: Google::Apis::MemcacheV1beta2::GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility::Representation + + collection :exclusions, as: 'exclusions', class: Google::Apis::MemcacheV1beta2::GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion, decorator: Google::Apis::MemcacheV1beta2::GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion::Representation + + collection :nodes, as: 'nodes', class: Google::Apis::MemcacheV1beta2::GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata, decorator: Google::Apis::MemcacheV1beta2::GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata::Representation + + property :tier, as: 'tier' + end + end + + class Instance + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :authorized_network, as: 'authorizedNetwork' + property :create_time, as: 'createTime' + property :discovery_endpoint, as: 'discoveryEndpoint' + property :display_name, as: 'displayName' + collection :instance_messages, as: 'instanceMessages', class: Google::Apis::MemcacheV1beta2::InstanceMessage, decorator: Google::Apis::MemcacheV1beta2::InstanceMessage::Representation + + hash :labels, as: 'labels' + property :memcache_full_version, as: 'memcacheFullVersion' + collection :memcache_nodes, as: 'memcacheNodes', class: Google::Apis::MemcacheV1beta2::Node, decorator: Google::Apis::MemcacheV1beta2::Node::Representation + + property :memcache_version, as: 'memcacheVersion' + property :name, as: 'name' + property :node_config, as: 'nodeConfig', class: Google::Apis::MemcacheV1beta2::NodeConfig, decorator: Google::Apis::MemcacheV1beta2::NodeConfig::Representation + + property :node_count, as: 'nodeCount' + property :parameters, as: 'parameters', class: Google::Apis::MemcacheV1beta2::MemcacheParameters, decorator: Google::Apis::MemcacheV1beta2::MemcacheParameters::Representation + + property :state, as: 'state' + property :update_time, as: 'updateTime' + collection :zones, as: 'zones' + end + end + + class InstanceMessage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + property :message, as: 'message' + end + end + + class ListInstancesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :resources, as: 'resources', class: Google::Apis::MemcacheV1beta2::Instance, decorator: Google::Apis::MemcacheV1beta2::Instance::Representation + + collection :unreachable, as: 'unreachable' + end + end + + class ListLocationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :locations, as: 'locations', class: Google::Apis::MemcacheV1beta2::Location, decorator: Google::Apis::MemcacheV1beta2::Location::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListOperationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :operations, as: 'operations', class: Google::Apis::MemcacheV1beta2::Operation, decorator: Google::Apis::MemcacheV1beta2::Operation::Representation + + end + end + + class Location + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + hash :labels, as: 'labels' + property :location_id, as: 'locationId' + hash :metadata, as: 'metadata' + property :name, as: 'name' + end + end + + class MemcacheParameters + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + hash :params, as: 'params' + end + end + + class Node + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :host, as: 'host' + property :node_id, as: 'nodeId' + property :parameters, as: 'parameters', class: Google::Apis::MemcacheV1beta2::MemcacheParameters, decorator: Google::Apis::MemcacheV1beta2::MemcacheParameters::Representation + + property :port, as: 'port' + property :state, as: 'state' + property :zone, as: 'zone' + end + end + + class NodeConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cpu_count, as: 'cpuCount' + property :memory_size_mb, as: 'memorySizeMb' + end + end + + class Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::MemcacheV1beta2::Status, decorator: Google::Apis::MemcacheV1beta2::Status::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class Policy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_configs, as: 'auditConfigs', class: Google::Apis::MemcacheV1beta2::AuditConfig, decorator: Google::Apis::MemcacheV1beta2::AuditConfig::Representation + + collection :bindings, as: 'bindings', class: Google::Apis::MemcacheV1beta2::Binding, decorator: Google::Apis::MemcacheV1beta2::Binding::Representation + + property :etag, :base64 => true, as: 'etag' + property :version, as: 'version' + end + end + + class SetIamPolicyRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :policy, as: 'policy', class: Google::Apis::MemcacheV1beta2::Policy, decorator: Google::Apis::MemcacheV1beta2::Policy::Representation + + property :update_mask, as: 'updateMask' + end + end + + class Status + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + + class TestIamPermissionsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class TestIamPermissionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class UpdateParametersRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :parameters, as: 'parameters', class: Google::Apis::MemcacheV1beta2::MemcacheParameters, decorator: Google::Apis::MemcacheV1beta2::MemcacheParameters::Representation + + property :update_mask, as: 'updateMask' + end + end + + class ZoneMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + end + end +end diff --git a/generated/google/apis/memcache_v1beta2/service.rb b/generated/google/apis/memcache_v1beta2/service.rb new file mode 100644 index 000000000..9c4bd4f15 --- /dev/null +++ b/generated/google/apis/memcache_v1beta2/service.rb @@ -0,0 +1,674 @@ +# Copyright 2015 Google Inc. +# +# 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 '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 MemcacheV1beta2 + # Cloud Memorystore for Memcached API + # + # Google Cloud Memorystore for Memcached API is used for creating and managing + # Memcached instances in GCP. + # + # @example + # require 'google/apis/memcache_v1beta2' + # + # Memcache = Google::Apis::MemcacheV1beta2 # Alias the module + # service = Memcache::CloudMemorystoreforMemcachedService.new + # + # @see https://cloud.google.com/memorystore/ + class CloudMemorystoreforMemcachedService < Google::Apis::Core::BaseService + # @return [String] + # API key. Your API key identifies your project and provides you with API access, + # quota, and reports. Required unless you provide an OAuth 2.0 token. + attr_accessor :key + + # @return [String] + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + attr_accessor :quota_user + + def initialize + super('https://memcache.googleapis.com/', '') + @batch_path = 'batch' + end + + # Gets information about a location. + # @param [String] name + # Resource name for the location. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MemcacheV1beta2::Location] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MemcacheV1beta2::Location] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta2/{+name}', options) + command.response_representation = Google::Apis::MemcacheV1beta2::Location::Representation + command.response_class = Google::Apis::MemcacheV1beta2::Location + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists information about the supported locations for this service. + # @param [String] name + # The resource that owns the locations collection, if applicable. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MemcacheV1beta2::ListLocationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MemcacheV1beta2::ListLocationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta2/{+name}/locations', options) + command.response_representation = Google::Apis::MemcacheV1beta2::ListLocationsResponse::Representation + command.response_class = Google::Apis::MemcacheV1beta2::ListLocationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # ApplyParameters will update current set of Parameters to the set of + # specified nodes of the Memcached Instance. + # @param [String] name + # Required. Resource name of the Memcached instance for which parameter group + # updates + # should be applied. + # @param [Google::Apis::MemcacheV1beta2::ApplyParametersRequest] apply_parameters_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MemcacheV1beta2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MemcacheV1beta2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def apply_instance_parameters(name, apply_parameters_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta2/{+name}:applyParameters', options) + command.request_representation = Google::Apis::MemcacheV1beta2::ApplyParametersRequest::Representation + command.request_object = apply_parameters_request_object + command.response_representation = Google::Apis::MemcacheV1beta2::Operation::Representation + command.response_class = Google::Apis::MemcacheV1beta2::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new Instance in a given project and location. + # @param [String] parent + # Required. The resource name of the instance location using the form: + # `projects/`project_id`/locations/`location_id`` + # where `location_id` refers to a GCP region + # @param [Google::Apis::MemcacheV1beta2::Instance] instance_object + # @param [String] instance_id + # Required. The logical name of the Memcached instance in the user + # project with the following restrictions: + # * Must contain only lowercase letters, numbers, and hyphens. + # * Must start with a letter. + # * Must be between 1-40 characters. + # * Must end with a number or a letter. + # * Must be unique within the user project / location + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MemcacheV1beta2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MemcacheV1beta2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_instance(parent, instance_object = nil, instance_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta2/{+parent}/instances', options) + command.request_representation = Google::Apis::MemcacheV1beta2::Instance::Representation + command.request_object = instance_object + command.response_representation = Google::Apis::MemcacheV1beta2::Operation::Representation + command.response_class = Google::Apis::MemcacheV1beta2::Operation + command.params['parent'] = parent unless parent.nil? + command.query['instanceId'] = instance_id unless instance_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a single Instance. + # @param [String] name + # Memcached instance resource name in the format: + # `projects/`project_id`/locations/`location_id`/instances/`instance_id`` + # where `location_id` refers to a GCP region + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MemcacheV1beta2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MemcacheV1beta2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_instance(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta2/{+name}', options) + command.response_representation = Google::Apis::MemcacheV1beta2::Operation::Representation + command.response_class = Google::Apis::MemcacheV1beta2::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets details of a single Instance. + # @param [String] name + # Required. Memcached instance resource name in the format: + # `projects/`project_id`/locations/`location_id`/instances/`instance_id`` + # where `location_id` refers to a GCP region + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MemcacheV1beta2::Instance] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MemcacheV1beta2::Instance] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_instance(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta2/{+name}', options) + command.response_representation = Google::Apis::MemcacheV1beta2::Instance::Representation + command.response_class = Google::Apis::MemcacheV1beta2::Instance + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a resource. + # Returns an empty policy if the resource exists and does not have a policy + # set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Fixnum] options_requested_policy_version + # Optional. The policy format version to be returned. + # Valid values are 0, 1, and 3. Requests specifying an invalid value will be + # rejected. + # Requests for policies with any conditional bindings must specify version 3. + # Policies without any conditional bindings may specify any valid value or + # leave the field unset. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MemcacheV1beta2::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MemcacheV1beta2::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_instance_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta2/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::MemcacheV1beta2::Policy::Representation + command.response_class = Google::Apis::MemcacheV1beta2::Policy + command.params['resource'] = resource unless resource.nil? + command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists Instances in a given project and location. + # @param [String] parent + # Required. The resource name of the instance location using the form: + # `projects/`project_id`/locations/`location_id`` + # where `location_id` refers to a GCP region + # @param [String] filter + # List filter. For example, exclude all Memcached instances with name as + # my-instance by specifying "name != my-instance". + # @param [String] order_by + # Sort results. Supported values are "name", "name desc" or "" (unsorted). + # @param [Fixnum] page_size + # The maximum number of items to return. + # If not specified, a default value of 1000 will be used by the service. + # Regardless of the page_size value, the response may include a partial list + # and a caller should only rely on response's + # next_page_token + # to determine if there are more instances left to be queried. + # @param [String] page_token + # The next_page_token value returned from a previous List request, + # if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MemcacheV1beta2::ListInstancesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MemcacheV1beta2::ListInstancesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_instances(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta2/{+parent}/instances', options) + command.response_representation = Google::Apis::MemcacheV1beta2::ListInstancesResponse::Representation + command.response_class = Google::Apis::MemcacheV1beta2::ListInstancesResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing Instance in a given project and location. + # @param [String] name + # Required. Unique name of the resource in this scope including project and + # location using the form: + # `projects/`project_id`/locations/`location_id`/instances/`instance_id`` + # Note: Memcached instances are managed and addressed at regional level so + # location_id here refers to a GCP region; however, users may choose which + # zones Memcached nodes within an instances should be provisioned in. + # Refer to [zones] field for more details. + # @param [Google::Apis::MemcacheV1beta2::Instance] instance_object + # @param [String] update_mask + # Required. Mask of fields to update. + # * `displayName` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MemcacheV1beta2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MemcacheV1beta2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_instance(name, instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta2/{+name}', options) + command.request_representation = Google::Apis::MemcacheV1beta2::Instance::Representation + command.request_object = instance_object + command.response_representation = Google::Apis::MemcacheV1beta2::Operation::Representation + command.response_class = Google::Apis::MemcacheV1beta2::Operation + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on the specified resource. Replaces any + # existing policy. + # Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::MemcacheV1beta2::SetIamPolicyRequest] set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MemcacheV1beta2::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MemcacheV1beta2::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_instance_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta2/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::MemcacheV1beta2::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::MemcacheV1beta2::Policy::Representation + command.response_class = Google::Apis::MemcacheV1beta2::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns permissions that a caller has on the specified resource. + # If the resource does not exist, this will return an empty set of + # permissions, not a NOT_FOUND error. + # Note: This operation is designed to be used for building permission-aware + # UIs and command-line tools, not for authorization checking. This operation + # may "fail open" without warning. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::MemcacheV1beta2::TestIamPermissionsRequest] test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MemcacheV1beta2::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MemcacheV1beta2::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_instance_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta2/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::MemcacheV1beta2::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::MemcacheV1beta2::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::MemcacheV1beta2::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the defined Memcached Parameters for an existing Instance. + # This method only stages the parameters, it must be followed by + # ApplyParameters to apply the parameters to nodes of the Memcached Instance. + # @param [String] name + # Required. Resource name of the Memcached instance for which the parameters + # should be + # updated. + # @param [Google::Apis::MemcacheV1beta2::UpdateParametersRequest] update_parameters_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MemcacheV1beta2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MemcacheV1beta2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_instance_parameters(name, update_parameters_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta2/{+name}:updateParameters', options) + command.request_representation = Google::Apis::MemcacheV1beta2::UpdateParametersRequest::Representation + command.request_object = update_parameters_request_object + command.response_representation = Google::Apis::MemcacheV1beta2::Operation::Representation + command.response_class = Google::Apis::MemcacheV1beta2::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Starts asynchronous cancellation on a long-running operation. The server + # makes a best effort to cancel the operation, but success is not + # guaranteed. If the server doesn't support this method, it returns + # `google.rpc.Code.UNIMPLEMENTED`. Clients can use + # Operations.GetOperation or + # other methods to check whether the cancellation succeeded or whether the + # operation completed despite cancellation. On successful cancellation, + # the operation is not deleted; instead, it becomes an operation with + # an Operation.error value with a google.rpc.Status.code of 1, + # corresponding to `Code.CANCELLED`. + # @param [String] name + # The name of the operation resource to be cancelled. + # @param [Google::Apis::MemcacheV1beta2::CancelOperationRequest] cancel_operation_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MemcacheV1beta2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MemcacheV1beta2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta2/{+name}:cancel', options) + command.request_representation = Google::Apis::MemcacheV1beta2::CancelOperationRequest::Representation + command.request_object = cancel_operation_request_object + command.response_representation = Google::Apis::MemcacheV1beta2::Empty::Representation + command.response_class = Google::Apis::MemcacheV1beta2::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a long-running operation. This method indicates that the client is + # no longer interested in the operation result. It does not cancel the + # operation. If the server doesn't support this method, it returns + # `google.rpc.Code.UNIMPLEMENTED`. + # @param [String] name + # The name of the operation resource to be deleted. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MemcacheV1beta2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MemcacheV1beta2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta2/{+name}', options) + command.response_representation = Google::Apis::MemcacheV1beta2::Empty::Representation + command.response_class = Google::Apis::MemcacheV1beta2::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of a long-running operation. Clients can use this + # method to poll the operation result at intervals as recommended by the API + # service. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MemcacheV1beta2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MemcacheV1beta2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta2/{+name}', options) + command.response_representation = Google::Apis::MemcacheV1beta2::Operation::Representation + command.response_class = Google::Apis::MemcacheV1beta2::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists operations that match the specified filter in the request. If the + # server doesn't support this method, it returns `UNIMPLEMENTED`. + # NOTE: the `name` binding allows API services to override the binding + # to use different resource name schemes, such as `users/*/operations`. To + # override the binding, API services can add a binding such as + # `"/v1/`name=users/*`/operations"` to their service configuration. + # For backwards compatibility, the default name includes the operations + # collection id, however overriding users must ensure the name binding + # is the parent resource, without the operations collection id. + # @param [String] name + # The name of the operation's parent resource. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MemcacheV1beta2::ListOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MemcacheV1beta2::ListOperationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta2/{+name}/operations', options) + command.response_representation = Google::Apis::MemcacheV1beta2::ListOperationsResponse::Representation + command.response_class = Google::Apis::MemcacheV1beta2::ListOperationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/mirror_v1/classes.rb b/generated/google/apis/mirror_v1/classes.rb deleted file mode 100644 index 4711a5488..000000000 --- a/generated/google/apis/mirror_v1/classes.rb +++ /dev/null @@ -1,1072 +0,0 @@ -# Copyright 2015 Google Inc. -# -# 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 MirrorV1 - - # Represents an account passed into the Account Manager on Glass. - class Account - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `authTokens` - # @return [Array] - attr_accessor :auth_tokens - - # - # Corresponds to the JSON property `features` - # @return [Array] - attr_accessor :features - - # - # Corresponds to the JSON property `password` - # @return [String] - attr_accessor :password - - # - # Corresponds to the JSON property `userData` - # @return [Array] - attr_accessor :user_data - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @auth_tokens = args[:auth_tokens] if args.key?(:auth_tokens) - @features = args[:features] if args.key?(:features) - @password = args[:password] if args.key?(:password) - @user_data = args[:user_data] if args.key?(:user_data) - end - end - - # Represents media content, such as a photo, that can be attached to a timeline - # item. - class Attachment - include Google::Apis::Core::Hashable - - # The MIME type of the attachment. - # Corresponds to the JSON property `contentType` - # @return [String] - attr_accessor :content_type - - # The URL for the content. - # Corresponds to the JSON property `contentUrl` - # @return [String] - attr_accessor :content_url - - # The ID of the attachment. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Indicates that the contentUrl is not available because the attachment content - # is still being processed. If the caller wishes to retrieve the content, it - # should try again later. - # Corresponds to the JSON property `isProcessingContent` - # @return [Boolean] - attr_accessor :is_processing_content - alias_method :is_processing_content?, :is_processing_content - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @content_type = args[:content_type] if args.key?(:content_type) - @content_url = args[:content_url] if args.key?(:content_url) - @id = args[:id] if args.key?(:id) - @is_processing_content = args[:is_processing_content] if args.key?(:is_processing_content) - end - end - - # A list of Attachments. This is the response from the server to GET requests on - # the attachments collection. - class ListAttachmentsResponse - include Google::Apis::Core::Hashable - - # The list of attachments. - # Corresponds to the JSON property `items` - # @return [Array] - attr_accessor :items - - # The type of resource. This is always mirror#attachmentsList. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @items = args[:items] if args.key?(:items) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class AuthToken - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `authToken` - # @return [String] - attr_accessor :auth_token - - # - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @auth_token = args[:auth_token] if args.key?(:auth_token) - @type = args[:type] if args.key?(:type) - end - end - - # A single menu command that is part of a Contact. - class Command - include Google::Apis::Core::Hashable - - # The type of operation this command corresponds to. Allowed values are: - # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech - # from the "Take a note" voice menu command. - # - POST_AN_UPDATE - Shares a timeline item with the transcription of user - # speech from the "Post an update" voice menu command. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @type = args[:type] if args.key?(:type) - end - end - - # A person or group that can be used as a creator or a contact. - class Contact - include Google::Apis::Core::Hashable - - # A list of voice menu commands that a contact can handle. Glass shows up to - # three contacts for each voice menu command. If there are more than that, the - # three contacts with the highest priority are shown for that particular command. - # Corresponds to the JSON property `acceptCommands` - # @return [Array] - attr_accessor :accept_commands - - # A list of MIME types that a contact supports. The contact will be shown to the - # user if any of its acceptTypes matches any of the types of the attachments on - # the item. If no acceptTypes are given, the contact will be shown for all items. - # Corresponds to the JSON property `acceptTypes` - # @return [Array] - attr_accessor :accept_types - - # The name to display for this contact. - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # An ID for this contact. This is generated by the application and is treated as - # an opaque token. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Set of image URLs to display for a contact. Most contacts will have a single - # image, but a "group" contact may include up to 8 image URLs and they will be - # resized and cropped into a mosaic on the client. - # Corresponds to the JSON property `imageUrls` - # @return [Array] - attr_accessor :image_urls - - # The type of resource. This is always mirror#contact. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Primary phone number for the contact. This can be a fully-qualified number, - # with country calling code and area code, or a local number. - # Corresponds to the JSON property `phoneNumber` - # @return [String] - attr_accessor :phone_number - - # Priority for the contact to determine ordering in a list of contacts. Contacts - # with higher priorities will be shown before ones with lower priorities. - # Corresponds to the JSON property `priority` - # @return [Fixnum] - attr_accessor :priority - - # A list of sharing features that a contact can handle. Allowed values are: - # - ADD_CAPTION - # Corresponds to the JSON property `sharingFeatures` - # @return [Array] - attr_accessor :sharing_features - - # The ID of the application that created this contact. This is populated by the - # API - # Corresponds to the JSON property `source` - # @return [String] - attr_accessor :source - - # Name of this contact as it should be pronounced. If this contact's name must - # be spoken as part of a voice disambiguation menu, this name is used as the - # expected pronunciation. This is useful for contact names with unpronounceable - # characters or whose display spelling is otherwise not phonetic. - # Corresponds to the JSON property `speakableName` - # @return [String] - attr_accessor :speakable_name - - # The type for this contact. This is used for sorting in UIs. Allowed values are: - # - # - INDIVIDUAL - Represents a single person. This is the default. - # - GROUP - Represents more than a single person. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @accept_commands = args[:accept_commands] if args.key?(:accept_commands) - @accept_types = args[:accept_types] if args.key?(:accept_types) - @display_name = args[:display_name] if args.key?(:display_name) - @id = args[:id] if args.key?(:id) - @image_urls = args[:image_urls] if args.key?(:image_urls) - @kind = args[:kind] if args.key?(:kind) - @phone_number = args[:phone_number] if args.key?(:phone_number) - @priority = args[:priority] if args.key?(:priority) - @sharing_features = args[:sharing_features] if args.key?(:sharing_features) - @source = args[:source] if args.key?(:source) - @speakable_name = args[:speakable_name] if args.key?(:speakable_name) - @type = args[:type] if args.key?(:type) - end - end - - # A list of Contacts representing contacts. This is the response from the server - # to GET requests on the contacts collection. - class ListContactsResponse - include Google::Apis::Core::Hashable - - # Contact list. - # Corresponds to the JSON property `items` - # @return [Array] - attr_accessor :items - - # The type of resource. This is always mirror#contacts. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @items = args[:items] if args.key?(:items) - @kind = args[:kind] if args.key?(:kind) - end - end - - # A geographic location that can be associated with a timeline item. - class Location - include Google::Apis::Core::Hashable - - # The accuracy of the location fix in meters. - # Corresponds to the JSON property `accuracy` - # @return [Float] - attr_accessor :accuracy - - # The full address of the location. - # Corresponds to the JSON property `address` - # @return [String] - attr_accessor :address - - # The name to be displayed. This may be a business name or a user-defined place, - # such as "Home". - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # The ID of the location. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # The type of resource. This is always mirror#location. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The latitude, in degrees. - # Corresponds to the JSON property `latitude` - # @return [Float] - attr_accessor :latitude - - # The longitude, in degrees. - # Corresponds to the JSON property `longitude` - # @return [Float] - attr_accessor :longitude - - # The time at which this location was captured, formatted according to RFC 3339. - # Corresponds to the JSON property `timestamp` - # @return [DateTime] - attr_accessor :timestamp - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @accuracy = args[:accuracy] if args.key?(:accuracy) - @address = args[:address] if args.key?(:address) - @display_name = args[:display_name] if args.key?(:display_name) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @latitude = args[:latitude] if args.key?(:latitude) - @longitude = args[:longitude] if args.key?(:longitude) - @timestamp = args[:timestamp] if args.key?(:timestamp) - end - end - - # A list of Locations. This is the response from the server to GET requests on - # the locations collection. - class ListLocationsResponse - include Google::Apis::Core::Hashable - - # The list of locations. - # Corresponds to the JSON property `items` - # @return [Array] - attr_accessor :items - - # The type of resource. This is always mirror#locationsList. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @items = args[:items] if args.key?(:items) - @kind = args[:kind] if args.key?(:kind) - end - end - - # A custom menu item that can be presented to the user by a timeline item. - class MenuItem - include Google::Apis::Core::Hashable - - # Controls the behavior when the user picks the menu option. Allowed values are: - # - # - CUSTOM - Custom action set by the service. When the user selects this - # menuItem, the API triggers a notification to your callbackUrl with the - # userActions.type set to CUSTOM and the userActions.payload set to the ID of - # this menu item. This is the default value. - # - Built-in actions: - # - REPLY - Initiate a reply to the timeline item using the voice recording UI. - # The creator attribute must be set in the timeline item for this menu to be - # available. - # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients - # will be added to the reply item. - # - DELETE - Delete the timeline item. - # - SHARE - Share the timeline item with the available contacts. - # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is - # not set, read the text field; if none of those fields are set, this menu item - # is ignored. - # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a - # menu item (currently, only transcribed text from voice input is supported). - # Subscribe to notifications when users invoke this menu item to receive the - # timeline item ID. Retrieve the media from the timeline item in the payload - # property. - # - VOICE_CALL - Initiate a phone call using the timeline item's creator. - # phoneNumber attribute as recipient. - # - NAVIGATE - Navigate to the timeline item's location. - # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item. - # - OPEN_URI - Open the payload of the menu item in the browser. - # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player. - # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator: - # - If the creator.phoneNumber is set and Glass is connected to an Android phone, - # the message is an SMS. - # - Otherwise, if the creator.email is set, the message is an email. - # Corresponds to the JSON property `action` - # @return [String] - attr_accessor :action - - # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). - # The voice label for this command will be displayed in the voice menu and the - # touch label will be displayed in the touch menu. Note that the default menu - # value's display name will be overriden if you specify this property. Values - # that do not correspond to a ContextualMenus.Command name will be ignored. - # Corresponds to the JSON property `contextual_command` - # @return [String] - attr_accessor :contextual_command - - # The ID for this menu item. This is generated by the application and is treated - # as an opaque token. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # A generic payload whose meaning changes depending on this MenuItem's action. - # - When the action is OPEN_URI, the payload is the URL of the website to view. - # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video - # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of - # a user's speech input - # Corresponds to the JSON property `payload` - # @return [String] - attr_accessor :payload - - # If set to true on a CUSTOM menu item, that item will be removed from the menu - # after it is selected. - # Corresponds to the JSON property `removeWhenSelected` - # @return [Boolean] - attr_accessor :remove_when_selected - alias_method :remove_when_selected?, :remove_when_selected - - # For CUSTOM items, a list of values controlling the appearance of the menu item - # in each of its states. A value for the DEFAULT state must be provided. If the - # PENDING or CONFIRMED states are missing, they will not be shown. - # Corresponds to the JSON property `values` - # @return [Array] - attr_accessor :values - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @action = args[:action] if args.key?(:action) - @contextual_command = args[:contextual_command] if args.key?(:contextual_command) - @id = args[:id] if args.key?(:id) - @payload = args[:payload] if args.key?(:payload) - @remove_when_selected = args[:remove_when_selected] if args.key?(:remove_when_selected) - @values = args[:values] if args.key?(:values) - end - end - - # A single value that is part of a MenuItem. - class MenuValue - include Google::Apis::Core::Hashable - - # The name to display for the menu item. If you specify this property for a - # built-in menu item, the default contextual voice command for that menu item is - # not shown. - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # URL of an icon to display with the menu item. - # Corresponds to the JSON property `iconUrl` - # @return [String] - attr_accessor :icon_url - - # The state that this value applies to. Allowed values are: - # - DEFAULT - Default value shown when displayed in the menuItems list. - # - PENDING - Value shown when the menuItem has been selected by the user but - # can still be cancelled. - # - CONFIRMED - Value shown when the menuItem has been selected by the user and - # can no longer be cancelled. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @display_name = args[:display_name] if args.key?(:display_name) - @icon_url = args[:icon_url] if args.key?(:icon_url) - @state = args[:state] if args.key?(:state) - end - end - - # A notification delivered by the API. - class Notification - include Google::Apis::Core::Hashable - - # The collection that generated the notification. - # Corresponds to the JSON property `collection` - # @return [String] - attr_accessor :collection - - # The ID of the item that generated the notification. - # Corresponds to the JSON property `itemId` - # @return [String] - attr_accessor :item_id - - # The type of operation that generated the notification. - # Corresponds to the JSON property `operation` - # @return [String] - attr_accessor :operation - - # A list of actions taken by the user that triggered the notification. - # Corresponds to the JSON property `userActions` - # @return [Array] - attr_accessor :user_actions - - # The user token provided by the service when it subscribed for notifications. - # Corresponds to the JSON property `userToken` - # @return [String] - attr_accessor :user_token - - # The secret verify token provided by the service when it subscribed for - # notifications. - # Corresponds to the JSON property `verifyToken` - # @return [String] - attr_accessor :verify_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @collection = args[:collection] if args.key?(:collection) - @item_id = args[:item_id] if args.key?(:item_id) - @operation = args[:operation] if args.key?(:operation) - @user_actions = args[:user_actions] if args.key?(:user_actions) - @user_token = args[:user_token] if args.key?(:user_token) - @verify_token = args[:verify_token] if args.key?(:verify_token) - end - end - - # Controls how notifications for a timeline item are presented to the user. - class NotificationConfig - include Google::Apis::Core::Hashable - - # The time at which the notification should be delivered. - # Corresponds to the JSON property `deliveryTime` - # @return [DateTime] - attr_accessor :delivery_time - - # Describes how important the notification is. Allowed values are: - # - DEFAULT - Notifications of default importance. A chime will be played to - # alert users. - # Corresponds to the JSON property `level` - # @return [String] - attr_accessor :level - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @delivery_time = args[:delivery_time] if args.key?(:delivery_time) - @level = args[:level] if args.key?(:level) - end - end - - # A setting for Glass. - class Setting - include Google::Apis::Core::Hashable - - # The setting's ID. The following IDs are valid: - # - locale - The key to the user’s language/locale (BCP 47 identifier) that - # Glassware should use to render localized content. - # - timezone - The key to the user’s current time zone region as defined in the - # tz database. Example: America/Los_Angeles. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # The type of resource. This is always mirror#setting. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The setting value, as a string. - # Corresponds to the JSON property `value` - # @return [String] - attr_accessor :value - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @value = args[:value] if args.key?(:value) - end - end - - # A subscription to events on a collection. - class Subscription - include Google::Apis::Core::Hashable - - # The URL where notifications should be delivered (must start with https://). - # Corresponds to the JSON property `callbackUrl` - # @return [String] - attr_accessor :callback_url - - # The collection to subscribe to. Allowed values are: - # - timeline - Changes in the timeline including insertion, deletion, and - # updates. - # - locations - Location updates. - # - settings - Settings updates. - # Corresponds to the JSON property `collection` - # @return [String] - attr_accessor :collection - - # The ID of the subscription. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # The type of resource. This is always mirror#subscription. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # A notification delivered by the API. - # Corresponds to the JSON property `notification` - # @return [Google::Apis::MirrorV1::Notification] - attr_accessor :notification - - # A list of operations that should be subscribed to. An empty list indicates - # that all operations on the collection should be subscribed to. Allowed values - # are: - # - UPDATE - The item has been updated. - # - INSERT - A new item has been inserted. - # - DELETE - The item has been deleted. - # - MENU_ACTION - A custom menu item has been triggered by the user. - # Corresponds to the JSON property `operation` - # @return [Array] - attr_accessor :operation - - # The time at which this subscription was last modified, formatted according to - # RFC 3339. - # Corresponds to the JSON property `updated` - # @return [DateTime] - attr_accessor :updated - - # An opaque token sent to the subscriber in notifications so that it can - # determine the ID of the user. - # Corresponds to the JSON property `userToken` - # @return [String] - attr_accessor :user_token - - # A secret token sent to the subscriber in notifications so that it can verify - # that the notification was generated by Google. - # Corresponds to the JSON property `verifyToken` - # @return [String] - attr_accessor :verify_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @callback_url = args[:callback_url] if args.key?(:callback_url) - @collection = args[:collection] if args.key?(:collection) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @notification = args[:notification] if args.key?(:notification) - @operation = args[:operation] if args.key?(:operation) - @updated = args[:updated] if args.key?(:updated) - @user_token = args[:user_token] if args.key?(:user_token) - @verify_token = args[:verify_token] if args.key?(:verify_token) - end - end - - # A list of Subscriptions. This is the response from the server to GET requests - # on the subscription collection. - class ListSubscriptionsResponse - include Google::Apis::Core::Hashable - - # The list of subscriptions. - # Corresponds to the JSON property `items` - # @return [Array] - attr_accessor :items - - # The type of resource. This is always mirror#subscriptionsList. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @items = args[:items] if args.key?(:items) - @kind = args[:kind] if args.key?(:kind) - end - end - - # Each item in the user's timeline is represented as a TimelineItem JSON - # structure, described below. - class TimelineItem - include Google::Apis::Core::Hashable - - # A list of media attachments associated with this item. As a convenience, you - # can refer to attachments in your HTML payloads with the attachment or cid - # scheme. For example: - # - attachment: where attachment_index - # is the 0-based index of this array. - # - cid: where attachment_id is the ID of the - # attachment. - # Corresponds to the JSON property `attachments` - # @return [Array] - attr_accessor :attachments - - # The bundle ID for this item. Services can specify a bundleId to group many - # items together. They appear under a single top-level item on the device. - # Corresponds to the JSON property `bundleId` - # @return [String] - attr_accessor :bundle_id - - # A canonical URL pointing to the canonical/high quality version of the data - # represented by the timeline item. - # Corresponds to the JSON property `canonicalUrl` - # @return [String] - attr_accessor :canonical_url - - # The time at which this item was created, formatted according to RFC 3339. - # Corresponds to the JSON property `created` - # @return [DateTime] - attr_accessor :created - - # A person or group that can be used as a creator or a contact. - # Corresponds to the JSON property `creator` - # @return [Google::Apis::MirrorV1::Contact] - attr_accessor :creator - - # The time that should be displayed when this item is viewed in the timeline, - # formatted according to RFC 3339. This user's timeline is sorted - # chronologically on display time, so this will also determine where the item is - # displayed in the timeline. If not set by the service, the display time - # defaults to the updated time. - # Corresponds to the JSON property `displayTime` - # @return [DateTime] - attr_accessor :display_time - - # ETag for this item. - # Corresponds to the JSON property `etag` - # @return [String] - attr_accessor :etag - - # HTML content for this item. If both text and html are provided for an item, - # the html will be rendered in the timeline. - # Allowed HTML elements - You can use these elements in your timeline cards. - # - # - Headers: h1, h2, h3, h4, h5, h6 - # - Images: img - # - Lists: li, ol, ul - # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, - # nav, section, summary, time - # - Structural: blockquote, br, div, hr, p, span - # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup - # - Tables: table, tbody, td, tfoot, th, thead, tr - # Blocked HTML elements: These elements and their contents are removed from HTML - # payloads. - # - # - Document headers: head, title - # - Embeds: audio, embed, object, source, video - # - Frames: frame, frameset - # - Scripting: applet, script - # Other elements: Any elements that aren't listed are removed, but their - # contents are preserved. - # Corresponds to the JSON property `html` - # @return [String] - attr_accessor :html - - # The ID of the timeline item. This is unique within a user's timeline. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # If this item was generated as a reply to another item, this field will be set - # to the ID of the item being replied to. This can be used to attach a reply to - # the appropriate conversation or post. - # Corresponds to the JSON property `inReplyTo` - # @return [String] - attr_accessor :in_reply_to - - # Whether this item is a bundle cover. - # If an item is marked as a bundle cover, it will be the entry point to the - # bundle of items that have the same bundleId as that item. It will be shown - # only on the main timeline — not within the opened bundle. - # On the main timeline, items that are shown are: - # - Items that have isBundleCover set to true - # - Items that do not have a bundleId In a bundle sub-timeline, items that are - # shown are: - # - Items that have the bundleId in question AND isBundleCover set to false - # Corresponds to the JSON property `isBundleCover` - # @return [Boolean] - attr_accessor :is_bundle_cover - alias_method :is_bundle_cover?, :is_bundle_cover - - # When true, indicates this item is deleted, and only the ID property is set. - # Corresponds to the JSON property `isDeleted` - # @return [Boolean] - attr_accessor :is_deleted - alias_method :is_deleted?, :is_deleted - - # When true, indicates this item is pinned, which means it's grouped alongside " - # active" items like navigation and hangouts, on the opposite side of the home - # screen from historical (non-pinned) timeline items. You can allow the user to - # toggle the value of this property with the TOGGLE_PINNED built-in menu item. - # Corresponds to the JSON property `isPinned` - # @return [Boolean] - attr_accessor :is_pinned - alias_method :is_pinned?, :is_pinned - - # The type of resource. This is always mirror#timelineItem. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # A geographic location that can be associated with a timeline item. - # Corresponds to the JSON property `location` - # @return [Google::Apis::MirrorV1::Location] - attr_accessor :location - - # A list of menu items that will be presented to the user when this item is - # selected in the timeline. - # Corresponds to the JSON property `menuItems` - # @return [Array] - attr_accessor :menu_items - - # Controls how notifications for a timeline item are presented to the user. - # Corresponds to the JSON property `notification` - # @return [Google::Apis::MirrorV1::NotificationConfig] - attr_accessor :notification - - # For pinned items, this determines the order in which the item is displayed in - # the timeline, with a higher score appearing closer to the clock. Note: setting - # this field is currently not supported. - # Corresponds to the JSON property `pinScore` - # @return [Fixnum] - attr_accessor :pin_score - - # A list of users or groups that this item has been shared with. - # Corresponds to the JSON property `recipients` - # @return [Array] - attr_accessor :recipients - - # A URL that can be used to retrieve this item. - # Corresponds to the JSON property `selfLink` - # @return [String] - attr_accessor :self_link - - # Opaque string you can use to map a timeline item to data in your own service. - # Corresponds to the JSON property `sourceItemId` - # @return [String] - attr_accessor :source_item_id - - # The speakable version of the content of this item. Along with the READ_ALOUD - # menu item, use this field to provide text that would be clearer when read - # aloud, or to provide extended information to what is displayed visually on - # Glass. - # Glassware should also specify the speakableType field, which will be spoken - # before this text in cases where the additional context is useful, for example - # when the user requests that the item be read aloud following a notification. - # Corresponds to the JSON property `speakableText` - # @return [String] - attr_accessor :speakable_text - - # A speakable description of the type of this item. This will be announced to - # the user prior to reading the content of the item in cases where the - # additional context is useful, for example when the user requests that the item - # be read aloud following a notification. - # This should be a short, simple noun phrase such as "Email", "Text message", or - # "Daily Planet News Update". - # Glassware are encouraged to populate this field for every timeline item, even - # if the item does not contain speakableText or text so that the user can learn - # the type of the item without looking at the screen. - # Corresponds to the JSON property `speakableType` - # @return [String] - attr_accessor :speakable_type - - # Text content of this item. - # Corresponds to the JSON property `text` - # @return [String] - attr_accessor :text - - # The title of this item. - # Corresponds to the JSON property `title` - # @return [String] - attr_accessor :title - - # The time at which this item was last modified, formatted according to RFC 3339. - # Corresponds to the JSON property `updated` - # @return [DateTime] - attr_accessor :updated - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @attachments = args[:attachments] if args.key?(:attachments) - @bundle_id = args[:bundle_id] if args.key?(:bundle_id) - @canonical_url = args[:canonical_url] if args.key?(:canonical_url) - @created = args[:created] if args.key?(:created) - @creator = args[:creator] if args.key?(:creator) - @display_time = args[:display_time] if args.key?(:display_time) - @etag = args[:etag] if args.key?(:etag) - @html = args[:html] if args.key?(:html) - @id = args[:id] if args.key?(:id) - @in_reply_to = args[:in_reply_to] if args.key?(:in_reply_to) - @is_bundle_cover = args[:is_bundle_cover] if args.key?(:is_bundle_cover) - @is_deleted = args[:is_deleted] if args.key?(:is_deleted) - @is_pinned = args[:is_pinned] if args.key?(:is_pinned) - @kind = args[:kind] if args.key?(:kind) - @location = args[:location] if args.key?(:location) - @menu_items = args[:menu_items] if args.key?(:menu_items) - @notification = args[:notification] if args.key?(:notification) - @pin_score = args[:pin_score] if args.key?(:pin_score) - @recipients = args[:recipients] if args.key?(:recipients) - @self_link = args[:self_link] if args.key?(:self_link) - @source_item_id = args[:source_item_id] if args.key?(:source_item_id) - @speakable_text = args[:speakable_text] if args.key?(:speakable_text) - @speakable_type = args[:speakable_type] if args.key?(:speakable_type) - @text = args[:text] if args.key?(:text) - @title = args[:title] if args.key?(:title) - @updated = args[:updated] if args.key?(:updated) - end - end - - # A list of timeline items. This is the response from the server to GET requests - # on the timeline collection. - class ListTimelineResponse - include Google::Apis::Core::Hashable - - # Items in the timeline. - # Corresponds to the JSON property `items` - # @return [Array] - attr_accessor :items - - # The type of resource. This is always mirror#timeline. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The next page token. Provide this as the pageToken parameter in the request to - # retrieve the next page of results. - # 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) - @items = args[:items] if args.key?(:items) - @kind = args[:kind] if args.key?(:kind) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # Represents an action taken by the user that triggered a notification. - class UserAction - include Google::Apis::Core::Hashable - - # An optional payload for the action. - # For actions of type CUSTOM, this is the ID of the custom menu item that was - # selected. - # Corresponds to the JSON property `payload` - # @return [String] - attr_accessor :payload - - # The type of action. The value of this can be: - # - SHARE - the user shared an item. - # - REPLY - the user replied to an item. - # - REPLY_ALL - the user replied to all recipients of an item. - # - CUSTOM - the user selected a custom menu item on the timeline item. - # - DELETE - the user deleted the item. - # - PIN - the user pinned the item. - # - UNPIN - the user unpinned the item. - # - LAUNCH - the user initiated a voice command. In the future, additional - # types may be added. UserActions with unrecognized types should be ignored. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @payload = args[:payload] if args.key?(:payload) - @type = args[:type] if args.key?(:type) - end - end - - # - class UserData - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `key` - # @return [String] - attr_accessor :key - - # - # Corresponds to the JSON property `value` - # @return [String] - attr_accessor :value - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @key = args[:key] if args.key?(:key) - @value = args[:value] if args.key?(:value) - end - end - end - end -end diff --git a/generated/google/apis/mirror_v1/representations.rb b/generated/google/apis/mirror_v1/representations.rb deleted file mode 100644 index 0f2df8f9e..000000000 --- a/generated/google/apis/mirror_v1/representations.rb +++ /dev/null @@ -1,390 +0,0 @@ -# Copyright 2015 Google Inc. -# -# 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 MirrorV1 - - class Account - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Attachment - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListAttachmentsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AuthToken - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Command - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Contact - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListContactsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Location - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListLocationsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class MenuItem - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class MenuValue - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Notification - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class NotificationConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Setting - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Subscription - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListSubscriptionsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TimelineItem - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListTimelineResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UserAction - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UserData - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Account - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :auth_tokens, as: 'authTokens', class: Google::Apis::MirrorV1::AuthToken, decorator: Google::Apis::MirrorV1::AuthToken::Representation - - collection :features, as: 'features' - property :password, as: 'password' - collection :user_data, as: 'userData', class: Google::Apis::MirrorV1::UserData, decorator: Google::Apis::MirrorV1::UserData::Representation - - end - end - - class Attachment - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :content_type, as: 'contentType' - property :content_url, as: 'contentUrl' - property :id, as: 'id' - property :is_processing_content, as: 'isProcessingContent' - end - end - - class ListAttachmentsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :items, as: 'items', class: Google::Apis::MirrorV1::Attachment, decorator: Google::Apis::MirrorV1::Attachment::Representation - - property :kind, as: 'kind' - end - end - - class AuthToken - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :auth_token, as: 'authToken' - property :type, as: 'type' - end - end - - class Command - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :type, as: 'type' - end - end - - class Contact - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :accept_commands, as: 'acceptCommands', class: Google::Apis::MirrorV1::Command, decorator: Google::Apis::MirrorV1::Command::Representation - - collection :accept_types, as: 'acceptTypes' - property :display_name, as: 'displayName' - property :id, as: 'id' - collection :image_urls, as: 'imageUrls' - property :kind, as: 'kind' - property :phone_number, as: 'phoneNumber' - property :priority, as: 'priority' - collection :sharing_features, as: 'sharingFeatures' - property :source, as: 'source' - property :speakable_name, as: 'speakableName' - property :type, as: 'type' - end - end - - class ListContactsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :items, as: 'items', class: Google::Apis::MirrorV1::Contact, decorator: Google::Apis::MirrorV1::Contact::Representation - - property :kind, as: 'kind' - end - end - - class Location - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :accuracy, as: 'accuracy' - property :address, as: 'address' - property :display_name, as: 'displayName' - property :id, as: 'id' - property :kind, as: 'kind' - property :latitude, as: 'latitude' - property :longitude, as: 'longitude' - property :timestamp, as: 'timestamp', type: DateTime - - end - end - - class ListLocationsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :items, as: 'items', class: Google::Apis::MirrorV1::Location, decorator: Google::Apis::MirrorV1::Location::Representation - - property :kind, as: 'kind' - end - end - - class MenuItem - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :action, as: 'action' - property :contextual_command, as: 'contextual_command' - property :id, as: 'id' - property :payload, as: 'payload' - property :remove_when_selected, as: 'removeWhenSelected' - collection :values, as: 'values', class: Google::Apis::MirrorV1::MenuValue, decorator: Google::Apis::MirrorV1::MenuValue::Representation - - end - end - - class MenuValue - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :display_name, as: 'displayName' - property :icon_url, as: 'iconUrl' - property :state, as: 'state' - end - end - - class Notification - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :collection, as: 'collection' - property :item_id, as: 'itemId' - property :operation, as: 'operation' - collection :user_actions, as: 'userActions', class: Google::Apis::MirrorV1::UserAction, decorator: Google::Apis::MirrorV1::UserAction::Representation - - property :user_token, as: 'userToken' - property :verify_token, as: 'verifyToken' - end - end - - class NotificationConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :delivery_time, as: 'deliveryTime', type: DateTime - - property :level, as: 'level' - end - end - - class Setting - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :id, as: 'id' - property :kind, as: 'kind' - property :value, as: 'value' - end - end - - class Subscription - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :callback_url, as: 'callbackUrl' - property :collection, as: 'collection' - property :id, as: 'id' - property :kind, as: 'kind' - property :notification, as: 'notification', class: Google::Apis::MirrorV1::Notification, decorator: Google::Apis::MirrorV1::Notification::Representation - - collection :operation, as: 'operation' - property :updated, as: 'updated', type: DateTime - - property :user_token, as: 'userToken' - property :verify_token, as: 'verifyToken' - end - end - - class ListSubscriptionsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :items, as: 'items', class: Google::Apis::MirrorV1::Subscription, decorator: Google::Apis::MirrorV1::Subscription::Representation - - property :kind, as: 'kind' - end - end - - class TimelineItem - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :attachments, as: 'attachments', class: Google::Apis::MirrorV1::Attachment, decorator: Google::Apis::MirrorV1::Attachment::Representation - - property :bundle_id, as: 'bundleId' - property :canonical_url, as: 'canonicalUrl' - property :created, as: 'created', type: DateTime - - property :creator, as: 'creator', class: Google::Apis::MirrorV1::Contact, decorator: Google::Apis::MirrorV1::Contact::Representation - - property :display_time, as: 'displayTime', type: DateTime - - property :etag, as: 'etag' - property :html, as: 'html' - property :id, as: 'id' - property :in_reply_to, as: 'inReplyTo' - property :is_bundle_cover, as: 'isBundleCover' - property :is_deleted, as: 'isDeleted' - property :is_pinned, as: 'isPinned' - property :kind, as: 'kind' - property :location, as: 'location', class: Google::Apis::MirrorV1::Location, decorator: Google::Apis::MirrorV1::Location::Representation - - collection :menu_items, as: 'menuItems', class: Google::Apis::MirrorV1::MenuItem, decorator: Google::Apis::MirrorV1::MenuItem::Representation - - property :notification, as: 'notification', class: Google::Apis::MirrorV1::NotificationConfig, decorator: Google::Apis::MirrorV1::NotificationConfig::Representation - - property :pin_score, as: 'pinScore' - collection :recipients, as: 'recipients', class: Google::Apis::MirrorV1::Contact, decorator: Google::Apis::MirrorV1::Contact::Representation - - property :self_link, as: 'selfLink' - property :source_item_id, as: 'sourceItemId' - property :speakable_text, as: 'speakableText' - property :speakable_type, as: 'speakableType' - property :text, as: 'text' - property :title, as: 'title' - property :updated, as: 'updated', type: DateTime - - end - end - - class ListTimelineResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :items, as: 'items', class: Google::Apis::MirrorV1::TimelineItem, decorator: Google::Apis::MirrorV1::TimelineItem::Representation - - property :kind, as: 'kind' - property :next_page_token, as: 'nextPageToken' - end - end - - class UserAction - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :payload, as: 'payload' - property :type, as: 'type' - end - end - - class UserData - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :key, as: 'key' - property :value, as: 'value' - end - end - end - end -end diff --git a/generated/google/apis/mirror_v1/service.rb b/generated/google/apis/mirror_v1/service.rb deleted file mode 100644 index bad513649..000000000 --- a/generated/google/apis/mirror_v1/service.rb +++ /dev/null @@ -1,928 +0,0 @@ -# Copyright 2015 Google Inc. -# -# 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 '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 MirrorV1 - # Google Mirror API - # - # Interacts with Glass users via the timeline. - # - # @example - # require 'google/apis/mirror_v1' - # - # Mirror = Google::Apis::MirrorV1 # Alias the module - # service = Mirror::MirrorService.new - # - # @see https://developers.google.com/glass - class MirrorService < Google::Apis::Core::BaseService - # @return [String] - # API key. Your API key identifies your project and provides you with API access, - # quota, and reports. Required unless you provide an OAuth 2.0 token. - attr_accessor :key - - # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - attr_accessor :quota_user - - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - - def initialize - super('https://www.googleapis.com/', 'mirror/v1/') - @batch_path = 'batch/mirror/v1' - end - - # Inserts a new account for a user - # @param [String] user_token - # The ID for the user. - # @param [String] account_type - # Account type to be passed to Android Account Manager. - # @param [String] account_name - # The name of the account to be passed to the Android Account Manager. - # @param [Google::Apis::MirrorV1::Account] account_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::Account] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::Account] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_account(user_token, account_type, account_name, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'accounts/{userToken}/{accountType}/{accountName}', options) - command.request_representation = Google::Apis::MirrorV1::Account::Representation - command.request_object = account_object - command.response_representation = Google::Apis::MirrorV1::Account::Representation - command.response_class = Google::Apis::MirrorV1::Account - command.params['userToken'] = user_token unless user_token.nil? - command.params['accountType'] = account_type unless account_type.nil? - command.params['accountName'] = account_name unless account_name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a contact. - # @param [String] id - # The ID of the contact. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_contact(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'contacts/{id}', options) - command.params['id'] = id unless id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Gets a single contact by ID. - # @param [String] id - # The ID of the contact. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::Contact] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::Contact] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_contact(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'contacts/{id}', options) - command.response_representation = Google::Apis::MirrorV1::Contact::Representation - command.response_class = Google::Apis::MirrorV1::Contact - command.params['id'] = id unless id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Inserts a new contact. - # @param [Google::Apis::MirrorV1::Contact] contact_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::Contact] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::Contact] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_contact(contact_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'contacts', options) - command.request_representation = Google::Apis::MirrorV1::Contact::Representation - command.request_object = contact_object - command.response_representation = Google::Apis::MirrorV1::Contact::Representation - command.response_class = Google::Apis::MirrorV1::Contact - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves a list of contacts for the authenticated user. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::ListContactsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::ListContactsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_contacts(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'contacts', options) - command.response_representation = Google::Apis::MirrorV1::ListContactsResponse::Representation - command.response_class = Google::Apis::MirrorV1::ListContactsResponse - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates a contact in place. This method supports patch semantics. - # @param [String] id - # The ID of the contact. - # @param [Google::Apis::MirrorV1::Contact] contact_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::Contact] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::Contact] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_contact(id, contact_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'contacts/{id}', options) - command.request_representation = Google::Apis::MirrorV1::Contact::Representation - command.request_object = contact_object - command.response_representation = Google::Apis::MirrorV1::Contact::Representation - command.response_class = Google::Apis::MirrorV1::Contact - command.params['id'] = id unless id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates a contact in place. - # @param [String] id - # The ID of the contact. - # @param [Google::Apis::MirrorV1::Contact] contact_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::Contact] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::Contact] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_contact(id, contact_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'contacts/{id}', options) - command.request_representation = Google::Apis::MirrorV1::Contact::Representation - command.request_object = contact_object - command.response_representation = Google::Apis::MirrorV1::Contact::Representation - command.response_class = Google::Apis::MirrorV1::Contact - command.params['id'] = id unless id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Gets a single location by ID. - # @param [String] id - # The ID of the location or latest for the last known location. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::Location] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::Location] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_location(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'locations/{id}', options) - command.response_representation = Google::Apis::MirrorV1::Location::Representation - command.response_class = Google::Apis::MirrorV1::Location - command.params['id'] = id unless id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves a list of locations for the user. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::ListLocationsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::ListLocationsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_locations(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'locations', options) - command.response_representation = Google::Apis::MirrorV1::ListLocationsResponse::Representation - command.response_class = Google::Apis::MirrorV1::ListLocationsResponse - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Gets a single setting by ID. - # @param [String] id - # The ID of the setting. The following IDs are valid: - # - locale - The key to the user’s language/locale (BCP 47 identifier) that - # Glassware should use to render localized content. - # - timezone - The key to the user’s current time zone region as defined in the - # tz database. Example: America/Los_Angeles. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::Setting] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::Setting] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_setting(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'settings/{id}', options) - command.response_representation = Google::Apis::MirrorV1::Setting::Representation - command.response_class = Google::Apis::MirrorV1::Setting - command.params['id'] = id unless id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a subscription. - # @param [String] id - # The ID of the subscription. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_subscription(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'subscriptions/{id}', options) - command.params['id'] = id unless id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Creates a new subscription. - # @param [Google::Apis::MirrorV1::Subscription] subscription_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::Subscription] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::Subscription] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_subscription(subscription_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'subscriptions', options) - command.request_representation = Google::Apis::MirrorV1::Subscription::Representation - command.request_object = subscription_object - command.response_representation = Google::Apis::MirrorV1::Subscription::Representation - command.response_class = Google::Apis::MirrorV1::Subscription - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves a list of subscriptions for the authenticated user and service. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::ListSubscriptionsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::ListSubscriptionsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_subscriptions(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'subscriptions', options) - command.response_representation = Google::Apis::MirrorV1::ListSubscriptionsResponse::Representation - command.response_class = Google::Apis::MirrorV1::ListSubscriptionsResponse - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates an existing subscription in place. - # @param [String] id - # The ID of the subscription. - # @param [Google::Apis::MirrorV1::Subscription] subscription_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::Subscription] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::Subscription] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_subscription(id, subscription_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'subscriptions/{id}', options) - command.request_representation = Google::Apis::MirrorV1::Subscription::Representation - command.request_object = subscription_object - command.response_representation = Google::Apis::MirrorV1::Subscription::Representation - command.response_class = Google::Apis::MirrorV1::Subscription - command.params['id'] = id unless id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a timeline item. - # @param [String] id - # The ID of the timeline item. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_timeline(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'timeline/{id}', options) - command.params['id'] = id unless id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Gets a single timeline item by ID. - # @param [String] id - # The ID of the timeline item. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::TimelineItem] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::TimelineItem] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_timeline(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'timeline/{id}', options) - command.response_representation = Google::Apis::MirrorV1::TimelineItem::Representation - command.response_class = Google::Apis::MirrorV1::TimelineItem - command.params['id'] = id unless id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Inserts a new item into the timeline. - # @param [Google::Apis::MirrorV1::TimelineItem] timeline_item_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [IO, String] upload_source - # IO stream or filename containing content to upload - # @param [String] content_type - # Content type of the uploaded content. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::TimelineItem] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::TimelineItem] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_timeline(timeline_item_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) - if upload_source.nil? - command = make_simple_command(:post, 'timeline', options) - else - command = make_upload_command(:post, 'timeline', options) - command.upload_source = upload_source - command.upload_content_type = content_type - end - command.request_representation = Google::Apis::MirrorV1::TimelineItem::Representation - command.request_object = timeline_item_object - command.response_representation = Google::Apis::MirrorV1::TimelineItem::Representation - command.response_class = Google::Apis::MirrorV1::TimelineItem - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves a list of timeline items for the authenticated user. - # @param [String] bundle_id - # If provided, only items with the given bundleId will be returned. - # @param [Boolean] include_deleted - # If true, tombstone records for deleted items will be returned. - # @param [Fixnum] max_results - # The maximum number of items to include in the response, used for paging. - # @param [String] order_by - # Controls the order in which timeline items are returned. - # @param [String] page_token - # Token for the page of results to return. - # @param [Boolean] pinned_only - # If true, only pinned items will be returned. - # @param [String] source_item_id - # If provided, only items with the given sourceItemId will be returned. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::ListTimelineResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::ListTimelineResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_timelines(bundle_id: nil, include_deleted: nil, max_results: nil, order_by: nil, page_token: nil, pinned_only: nil, source_item_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'timeline', options) - command.response_representation = Google::Apis::MirrorV1::ListTimelineResponse::Representation - command.response_class = Google::Apis::MirrorV1::ListTimelineResponse - command.query['bundleId'] = bundle_id unless bundle_id.nil? - command.query['includeDeleted'] = include_deleted unless include_deleted.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['orderBy'] = order_by unless order_by.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['pinnedOnly'] = pinned_only unless pinned_only.nil? - command.query['sourceItemId'] = source_item_id unless source_item_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates a timeline item in place. This method supports patch semantics. - # @param [String] id - # The ID of the timeline item. - # @param [Google::Apis::MirrorV1::TimelineItem] timeline_item_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::TimelineItem] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::TimelineItem] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_timeline(id, timeline_item_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'timeline/{id}', options) - command.request_representation = Google::Apis::MirrorV1::TimelineItem::Representation - command.request_object = timeline_item_object - command.response_representation = Google::Apis::MirrorV1::TimelineItem::Representation - command.response_class = Google::Apis::MirrorV1::TimelineItem - command.params['id'] = id unless id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates a timeline item in place. - # @param [String] id - # The ID of the timeline item. - # @param [Google::Apis::MirrorV1::TimelineItem] timeline_item_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [IO, String] upload_source - # IO stream or filename containing content to upload - # @param [String] content_type - # Content type of the uploaded content. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::TimelineItem] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::TimelineItem] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_timeline(id, timeline_item_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) - if upload_source.nil? - command = make_simple_command(:put, 'timeline/{id}', options) - else - command = make_upload_command(:put, 'timeline/{id}', options) - command.upload_source = upload_source - command.upload_content_type = content_type - end - command.request_representation = Google::Apis::MirrorV1::TimelineItem::Representation - command.request_object = timeline_item_object - command.response_representation = Google::Apis::MirrorV1::TimelineItem::Representation - command.response_class = Google::Apis::MirrorV1::TimelineItem - command.params['id'] = id unless id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Deletes an attachment from a timeline item. - # @param [String] item_id - # The ID of the timeline item the attachment belongs to. - # @param [String] attachment_id - # The ID of the attachment. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_timeline_attachment(item_id, attachment_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'timeline/{itemId}/attachments/{attachmentId}', options) - command.params['itemId'] = item_id unless item_id.nil? - command.params['attachmentId'] = attachment_id unless attachment_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves an attachment on a timeline item by item ID and attachment ID. - # @param [String] item_id - # The ID of the timeline item the attachment belongs to. - # @param [String] attachment_id - # The ID of the attachment. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [IO, String] download_dest - # IO stream or filename to receive content download - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::Attachment] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::Attachment] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_timeline_attachment(item_id, attachment_id, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) - if download_dest.nil? - command = make_simple_command(:get, 'timeline/{itemId}/attachments/{attachmentId}', options) - else - command = make_download_command(:get, 'timeline/{itemId}/attachments/{attachmentId}', options) - command.download_dest = download_dest - end - command.response_representation = Google::Apis::MirrorV1::Attachment::Representation - command.response_class = Google::Apis::MirrorV1::Attachment - command.params['itemId'] = item_id unless item_id.nil? - command.params['attachmentId'] = attachment_id unless attachment_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Adds a new attachment to a timeline item. - # @param [String] item_id - # The ID of the timeline item the attachment belongs to. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [IO, String] upload_source - # IO stream or filename containing content to upload - # @param [String] content_type - # Content type of the uploaded content. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::Attachment] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::Attachment] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_timeline_attachment(item_id, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) - if upload_source.nil? - command = make_simple_command(:post, 'timeline/{itemId}/attachments', options) - else - command = make_upload_command(:post, 'timeline/{itemId}/attachments', options) - command.upload_source = upload_source - command.upload_content_type = content_type - end - command.response_representation = Google::Apis::MirrorV1::Attachment::Representation - command.response_class = Google::Apis::MirrorV1::Attachment - command.params['itemId'] = item_id unless item_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Returns a list of attachments for a timeline item. - # @param [String] item_id - # The ID of the timeline item whose attachments should be listed. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MirrorV1::ListAttachmentsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MirrorV1::ListAttachmentsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_timeline_attachments(item_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'timeline/{itemId}/attachments', options) - command.response_representation = Google::Apis::MirrorV1::ListAttachmentsResponse::Representation - command.response_class = Google::Apis::MirrorV1::ListAttachmentsResponse - command.params['itemId'] = item_id unless item_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - protected - - def apply_command_defaults(command) - command.query['key'] = key unless key.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - end - end - end - end -end diff --git a/generated/google/apis/ml_v1.rb b/generated/google/apis/ml_v1.rb index 8bf5931dd..dc521ddba 100644 --- a/generated/google/apis/ml_v1.rb +++ b/generated/google/apis/ml_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/ml/ module MlV1 VERSION = 'V1' - REVISION = '20200307' + REVISION = '20200328' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/ml_v1/classes.rb b/generated/google/apis/ml_v1/classes.rb index bdc59b4e1..ee974782e 100644 --- a/generated/google/apis/ml_v1/classes.rb +++ b/generated/google/apis/ml_v1/classes.rb @@ -1555,7 +1555,7 @@ module Google alias_method :online_prediction_logging?, :online_prediction_logging # Optional. The list of regions where the model is going to be deployed. - # Currently only one region per model is supported. + # Only one region per model is supported. # Defaults to 'us-central1' if nothing is set. # See the available regions # for AI Platform services. @@ -1934,7 +1934,7 @@ module Google # The Docker image to run on the replica. This image must be in Container # Registry. Learn more about [configuring custom - # containers](/ml-engine/docs/distributed-training-containers). + # containers](/ai-platform/training/docs/distributed-training-containers). # Corresponds to the JSON property `imageUri` # @return [String] attr_accessor :image_uri @@ -2300,7 +2300,12 @@ module Google class GoogleCloudMlV1TrainingInput include Google::Apis::Core::Hashable - # Optional. Command line arguments to pass to the program. + # Optional. Arguments passed to the training. + # - If it is a python package training: + # It will be passed as command line argument to the program. + # - If it is a custom container training, + # It will be passed as an argument to the custom container + # image. # Corresponds to the JSON property `args` # @return [Array] attr_accessor :args @@ -2311,6 +2316,34 @@ module Google # @return [Google::Apis::MlV1::GoogleCloudMlV1EncryptionConfig] attr_accessor :encryption_config + # Represents the configuration for a replica in a cluster. + # Corresponds to the JSON property `evaluatorConfig` + # @return [Google::Apis::MlV1::GoogleCloudMlV1ReplicaConfig] + attr_accessor :evaluator_config + + # Optional. The number of evaluator replicas to use for the training job. + # Each replica in the cluster will be of the type specified in + # `evaluator_type`. + # This value can only be used when `scale_tier` is set to `CUSTOM`. If you + # set this value, you must also set `evaluator_type`. + # The default value is zero. + # Corresponds to the JSON property `evaluatorCount` + # @return [Fixnum] + attr_accessor :evaluator_count + + # Optional. Specifies the type of virtual machine to use for your training + # job's evaluator nodes. + # The supported values are the same as those described in the entry for + # `masterType`. + # This value must be consistent with the category of machine type that + # `masterType` uses. In other words, both must be Compute Engine machine + # types or both must be legacy machine types. + # This value must be present when `scaleTier` is set to `CUSTOM` and + # `evaluatorCount` is greater than zero. + # Corresponds to the JSON property `evaluatorType` + # @return [String] + attr_accessor :evaluator_type + # Represents a set of hyperparameters to optimize. # Corresponds to the JSON property `hyperparameters` # @return [Google::Apis::MlV1::GoogleCloudMlV1HyperparameterSpec] @@ -2393,7 +2426,7 @@ module Google # Optional. The number of parameter server replicas to use for the training # job. Each replica in the cluster will be of the type specified in # `parameter_server_type`. - # This value can only be used when `scale_tier` is set to `CUSTOM`.If you + # This value can only be used when `scale_tier` is set to `CUSTOM`. If you # set this value, you must also set `parameter_server_type`. # The default value is zero. # Corresponds to the JSON property `parameterServerCount` @@ -2459,9 +2492,13 @@ module Google # @return [Google::Apis::MlV1::GoogleCloudMlV1Scheduling] attr_accessor :scheduling - # Optional. Use 'chief' instead of 'master' in TF_CONFIG when Custom - # Container is used and evaluator is not specified. - # Defaults to false. + # Optional. Use `chief` instead of `master` in the `TF_CONFIG` environment + # variable when training with a custom container. Defaults to `false`. [Learn + # more about this + # field.](/ai-platform/training/docs/distributed-training-details#chief-versus- + # master) + # This field has no effect for training jobs that don't use a custom + # container. # Corresponds to the JSON property `useChiefInTfConfig` # @return [Boolean] attr_accessor :use_chief_in_tf_config @@ -2506,6 +2543,9 @@ module Google def update!(**args) @args = args[:args] if args.key?(:args) @encryption_config = args[:encryption_config] if args.key?(:encryption_config) + @evaluator_config = args[:evaluator_config] if args.key?(:evaluator_config) + @evaluator_count = args[:evaluator_count] if args.key?(:evaluator_count) + @evaluator_type = args[:evaluator_type] if args.key?(:evaluator_type) @hyperparameters = args[:hyperparameters] if args.key?(:hyperparameters) @job_dir = args[:job_dir] if args.key?(:job_dir) @master_config = args[:master_config] if args.key?(:master_config) diff --git a/generated/google/apis/ml_v1/representations.rb b/generated/google/apis/ml_v1/representations.rb index e97c109f5..7eb7776fc 100644 --- a/generated/google/apis/ml_v1/representations.rb +++ b/generated/google/apis/ml_v1/representations.rb @@ -1083,6 +1083,10 @@ module Google collection :args, as: 'args' property :encryption_config, as: 'encryptionConfig', class: Google::Apis::MlV1::GoogleCloudMlV1EncryptionConfig, decorator: Google::Apis::MlV1::GoogleCloudMlV1EncryptionConfig::Representation + property :evaluator_config, as: 'evaluatorConfig', class: Google::Apis::MlV1::GoogleCloudMlV1ReplicaConfig, decorator: Google::Apis::MlV1::GoogleCloudMlV1ReplicaConfig::Representation + + property :evaluator_count, :numeric_string => true, as: 'evaluatorCount' + property :evaluator_type, as: 'evaluatorType' property :hyperparameters, as: 'hyperparameters', class: Google::Apis::MlV1::GoogleCloudMlV1HyperparameterSpec, decorator: Google::Apis::MlV1::GoogleCloudMlV1HyperparameterSpec::Representation property :job_dir, as: 'jobDir' diff --git a/generated/google/apis/monitoring_v1.rb b/generated/google/apis/monitoring_v1.rb index 7420d86b3..70c09ad7a 100644 --- a/generated/google/apis/monitoring_v1.rb +++ b/generated/google/apis/monitoring_v1.rb @@ -18,19 +18,18 @@ require 'google/apis/monitoring_v1/representations.rb' module Google module Apis - # Stackdriver Monitoring API + # Cloud Monitoring API # - # Manages your Stackdriver Monitoring data and configurations. Most projects - # must be associated with a Stackdriver account, with a few exceptions as noted - # on the individual method pages. The table entries below are presented in - # alphabetical order, not in order of common use. For explanations of the - # concepts found in the table entries, read the Stackdriver Monitoring - # documentation. + # Manages your Cloud Monitoring data and configurations. Most projects must be + # associated with a Workspace, with a few exceptions as noted on the individual + # method pages. The table entries below are presented in alphabetical order, not + # in order of common use. For explanations of the concepts found in the table + # entries, read the Cloud Monitoring documentation. # # @see https://cloud.google.com/monitoring/api/ module MonitoringV1 VERSION = 'V1' - REVISION = '20200210' + REVISION = '20200405' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/monitoring_v1/classes.rb b/generated/google/apis/monitoring_v1/classes.rb index 59bacae45..72fb657fd 100644 --- a/generated/google/apis/monitoring_v1/classes.rb +++ b/generated/google/apis/monitoring_v1/classes.rb @@ -41,7 +41,8 @@ module Google # 95% latency across the average of all tasks in a cluster". This representative # data can be more easily graphed and comprehended, and the individual time # series data is still available for later drilldown. For more details, see - # Aggregating Time Series. + # Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/ + # aggregation). class Aggregation include Google::Apis::Core::Hashable @@ -217,7 +218,7 @@ module Google # @return [Google::Apis::MonitoringV1::ColumnLayout] attr_accessor :column_layout - # The mutable, human-readable name. + # Required. The mutable, human-readable name. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -238,7 +239,7 @@ module Google # @return [Google::Apis::MonitoringV1::GridLayout] attr_accessor :grid_layout - # The resource name of the dashboard. + # Immutable. The resource name of the dashboard. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -608,13 +609,14 @@ module Google # 95% latency across the average of all tasks in a cluster". This representative # data can be more easily graphed and comprehended, and the individual time # series data is still available for later drilldown. For more details, see - # Aggregating Time Series. + # Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/ + # aggregation). # Corresponds to the JSON property `aggregation` # @return [Google::Apis::MonitoringV1::Aggregation] attr_accessor :aggregation - # Required. The monitoring filter that identifies the metric types, resources, - # and projects to query. + # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/ + # filters) that identifies the metric types, resources, and projects to query. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter @@ -797,7 +799,7 @@ module Google # @return [String] attr_accessor :min_alignment_period - # The type of sparkchart to show in this chartView. + # Required. The type of sparkchart to show in this chartView. # Corresponds to the JSON property `sparkChartType` # @return [String] attr_accessor :spark_chart_type @@ -877,7 +879,8 @@ module Google end # A filter that defines a subset of time series data that is displayed in a - # widget. Time series data is fetched using the ListTimeSeries method. + # widget. Time series data is fetched using the ListTimeSeries (https://cloud. + # google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) method. class TimeSeriesFilter include Google::Apis::Core::Hashable @@ -900,13 +903,14 @@ module Google # 95% latency across the average of all tasks in a cluster". This representative # data can be more easily graphed and comprehended, and the individual time # series data is still available for later drilldown. For more details, see - # Aggregating Time Series. + # Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/ + # aggregation). # Corresponds to the JSON property `aggregation` # @return [Google::Apis::MonitoringV1::Aggregation] attr_accessor :aggregation - # Required. The monitoring filter that identifies the metric types, resources, - # and projects to query. + # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/ + # filters) that identifies the metric types, resources, and projects to query. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter @@ -921,6 +925,31 @@ module Google # @return [Google::Apis::MonitoringV1::PickTimeSeriesFilter] attr_accessor :pick_time_series_filter + # Describes how to combine multiple time series to provide a different view of + # the data. Aggregation of time series is done in two steps. First, each time + # series in the set is aligned to the same time interval boundaries, then the + # set of time series is optionally reduced in number.Alignment consists of + # applying the per_series_aligner operation to each time series after its data + # has been divided into regular alignment_period time intervals. This process + # takes all of the data points in an alignment period, applies a mathematical + # transformation such as averaging, minimum, maximum, delta, etc., and converts + # them into a single data point per period.Reduction is when the aligned and + # transformed time series can optionally be combined, reducing the number of + # time series through similar mathematical transformations. Reduction involves + # applying a cross_series_reducer to all the time series, optionally sorting the + # time series into subsets with group_by_fields, and applying the reducer to + # each subset.The raw time series data can contain a huge amount of information + # from multiple sources. Alignment and reduction transforms this mass of data + # into a more manageable and representative collection of data, for example "the + # 95% latency across the average of all tasks in a cluster". This representative + # data can be more easily graphed and comprehended, and the individual time + # series data is still available for later drilldown. For more details, see + # Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/ + # aggregation). + # Corresponds to the JSON property `secondaryAggregation` + # @return [Google::Apis::MonitoringV1::Aggregation] + attr_accessor :secondary_aggregation + def initialize(**args) update!(**args) end @@ -930,6 +959,7 @@ module Google @aggregation = args[:aggregation] if args.key?(:aggregation) @filter = args[:filter] if args.key?(:filter) @pick_time_series_filter = args[:pick_time_series_filter] if args.key?(:pick_time_series_filter) + @secondary_aggregation = args[:secondary_aggregation] if args.key?(:secondary_aggregation) end end @@ -980,7 +1010,8 @@ module Google # 95% latency across the average of all tasks in a cluster". This representative # data can be more easily graphed and comprehended, and the individual time # series data is still available for later drilldown. For more details, see - # Aggregating Time Series. + # Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/ + # aggregation). # Corresponds to the JSON property `secondaryAggregation` # @return [Google::Apis::MonitoringV1::Aggregation] attr_accessor :secondary_aggregation @@ -1004,7 +1035,8 @@ module Google include Google::Apis::Core::Hashable # A filter that defines a subset of time series data that is displayed in a - # widget. Time series data is fetched using the ListTimeSeries method. + # widget. Time series data is fetched using the ListTimeSeries (https://cloud. + # google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) method. # Corresponds to the JSON property `timeSeriesFilter` # @return [Google::Apis::MonitoringV1::TimeSeriesFilter] attr_accessor :time_series_filter @@ -1016,9 +1048,15 @@ module Google # @return [Google::Apis::MonitoringV1::TimeSeriesFilterRatio] attr_accessor :time_series_filter_ratio + # A query used to fetch time series. + # Corresponds to the JSON property `timeSeriesQueryLanguage` + # @return [String] + attr_accessor :time_series_query_language + # The unit of data contained in fetched time series. If non-empty, this unit # will override any unit that accompanies fetched data. The format is the same - # as the unit field in MetricDescriptor. + # as the unit (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects. + # metricDescriptors) field in MetricDescriptor. # Corresponds to the JSON property `unitOverride` # @return [String] attr_accessor :unit_override @@ -1031,6 +1069,7 @@ module Google def update!(**args) @time_series_filter = args[:time_series_filter] if args.key?(:time_series_filter) @time_series_filter_ratio = args[:time_series_filter_ratio] if args.key?(:time_series_filter_ratio) + @time_series_query_language = args[:time_series_query_language] if args.key?(:time_series_query_language) @unit_override = args[:unit_override] if args.key?(:unit_override) end end @@ -1145,7 +1184,7 @@ module Google # @return [Google::Apis::MonitoringV1::ChartOptions] attr_accessor :chart_options - # The data displayed in this chart. + # Required. The data displayed in this chart. # Corresponds to the JSON property `dataSets` # @return [Array] attr_accessor :data_sets diff --git a/generated/google/apis/monitoring_v1/representations.rb b/generated/google/apis/monitoring_v1/representations.rb index be2909833..7da96935e 100644 --- a/generated/google/apis/monitoring_v1/representations.rb +++ b/generated/google/apis/monitoring_v1/representations.rb @@ -431,6 +431,8 @@ module Google property :filter, as: 'filter' property :pick_time_series_filter, as: 'pickTimeSeriesFilter', class: Google::Apis::MonitoringV1::PickTimeSeriesFilter, decorator: Google::Apis::MonitoringV1::PickTimeSeriesFilter::Representation + property :secondary_aggregation, as: 'secondaryAggregation', class: Google::Apis::MonitoringV1::Aggregation, decorator: Google::Apis::MonitoringV1::Aggregation::Representation + end end @@ -455,6 +457,7 @@ module Google property :time_series_filter_ratio, as: 'timeSeriesFilterRatio', class: Google::Apis::MonitoringV1::TimeSeriesFilterRatio, decorator: Google::Apis::MonitoringV1::TimeSeriesFilterRatio::Representation + property :time_series_query_language, as: 'timeSeriesQueryLanguage' property :unit_override, as: 'unitOverride' end end diff --git a/generated/google/apis/monitoring_v1/service.rb b/generated/google/apis/monitoring_v1/service.rb index 6e586f5b0..7d623fa17 100644 --- a/generated/google/apis/monitoring_v1/service.rb +++ b/generated/google/apis/monitoring_v1/service.rb @@ -20,14 +20,13 @@ require 'google/apis/errors' module Google module Apis module MonitoringV1 - # Stackdriver Monitoring API + # Cloud Monitoring API # - # Manages your Stackdriver Monitoring data and configurations. Most projects - # must be associated with a Stackdriver account, with a few exceptions as noted - # on the individual method pages. The table entries below are presented in - # alphabetical order, not in order of common use. For explanations of the - # concepts found in the table entries, read the Stackdriver Monitoring - # documentation. + # Manages your Cloud Monitoring data and configurations. Most projects must be + # associated with a Workspace, with a few exceptions as noted on the individual + # method pages. The table entries below are presented in alphabetical order, not + # in order of common use. For explanations of the concepts found in the table + # entries, read the Cloud Monitoring documentation. # # @example # require 'google/apis/monitoring_v1' @@ -204,7 +203,7 @@ module Google # dashboard. For more information, see Google Cloud IAM (https://cloud.google. # com/iam). # @param [String] name - # The resource name of the dashboard. + # Immutable. The resource name of the dashboard. # @param [Google::Apis::MonitoringV1::Dashboard] dashboard_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/monitoring_v3.rb b/generated/google/apis/monitoring_v3.rb index 003436fc6..a97878d3b 100644 --- a/generated/google/apis/monitoring_v3.rb +++ b/generated/google/apis/monitoring_v3.rb @@ -18,19 +18,18 @@ require 'google/apis/monitoring_v3/representations.rb' module Google module Apis - # Stackdriver Monitoring API + # Cloud Monitoring API # - # Manages your Stackdriver Monitoring data and configurations. Most projects - # must be associated with a Stackdriver account, with a few exceptions as noted - # on the individual method pages. The table entries below are presented in - # alphabetical order, not in order of common use. For explanations of the - # concepts found in the table entries, read the Stackdriver Monitoring - # documentation. + # Manages your Cloud Monitoring data and configurations. Most projects must be + # associated with a Workspace, with a few exceptions as noted on the individual + # method pages. The table entries below are presented in alphabetical order, not + # in order of common use. For explanations of the concepts found in the table + # entries, read the Cloud Monitoring documentation. # # @see https://cloud.google.com/monitoring/api/ module MonitoringV3 VERSION = 'V3' - REVISION = '20200219' + REVISION = '20200329' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/monitoring_v3/classes.rb b/generated/google/apis/monitoring_v3/classes.rb index 0be824aa9..beb13ab06 100644 --- a/generated/google/apis/monitoring_v3/classes.rb +++ b/generated/google/apis/monitoring_v3/classes.rb @@ -41,7 +41,8 @@ module Google # 95% latency across the average of all tasks in a cluster". This representative # data can be more easily graphed and comprehended, and the individual time # series data is still available for later drilldown. For more details, see - # Aggregating Time Series. + # Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/ + # aggregation). class Aggregation include Google::Apis::Core::Hashable @@ -116,7 +117,8 @@ module Google # A description of the conditions under which some aspect of your system is # considered to be "unhealthy" and the ways to notify people or services about - # this state. For an overview of alert policies, see Introduction to Alerting. + # this state. For an overview of alert policies, see Introduction to Alerting ( + # https://cloud.google.com/monitoring/alerts/). class AlertPolicy include Google::Apis::Core::Hashable @@ -649,6 +651,12 @@ module Google # @return [Google::Apis::MonitoringV3::MetricThreshold] attr_accessor :condition_threshold + # A condition type that allows alert policies to be defined using Monitoring + # Query Language. + # Corresponds to the JSON property `conditionTimeSeriesQueryLanguage` + # @return [Google::Apis::MonitoringV3::TimeSeriesQueryLanguageCondition] + attr_accessor :condition_time_series_query_language + # A short name or phrase used to identify the condition in dashboards, # notifications, and incidents. To avoid confusion, don't use the same display # name for multiple conditions in the same policy. @@ -683,6 +691,7 @@ module Google def update!(**args) @condition_absent = args[:condition_absent] if args.key?(:condition_absent) @condition_threshold = args[:condition_threshold] if args.key?(:condition_threshold) + @condition_time_series_query_language = args[:condition_time_series_query_language] if args.key?(:condition_time_series_query_language) @display_name = args[:display_name] if args.key?(:display_name) @name = args[:name] if args.key?(:name) end @@ -874,14 +883,14 @@ module Google class Distribution include Google::Apis::Core::Hashable - # Required in the Stackdriver Monitoring API v3. The values for each bucket - # specified in bucket_options. The sum of the values in bucketCounts must equal - # the value in the count field of the Distribution object. The order of the - # bucket counts follows the numbering schemes described for the three bucket - # types. The underflow bucket has number 0; the finite buckets, if any, have - # numbers 1 through N-2; and the overflow bucket has number N-1. The size of - # bucket_counts must not be greater than N. If the size is less than N, then the - # remaining buckets are assigned values of zero. + # Required in the Cloud Monitoring API v3. The values for each bucket specified + # in bucket_options. The sum of the values in bucketCounts must equal the value + # in the count field of the Distribution object. The order of the bucket counts + # follows the numbering schemes described for the three bucket types. The + # underflow bucket has number 0; the finite buckets, if any, have numbers 1 + # through N-2; and the overflow bucket has number N-1. The size of bucket_counts + # must not be greater than N. If the size is less than N, then the remaining + # buckets are assigned values of zero. # Corresponds to the JSON property `bucketCounts` # @return [Array] attr_accessor :bucket_counts @@ -1593,6 +1602,38 @@ module Google end end + # A label value. + class LabelValue + include Google::Apis::Core::Hashable + + # A bool label value. + # Corresponds to the JSON property `boolValue` + # @return [Boolean] + attr_accessor :bool_value + alias_method :bool_value?, :bool_value + + # An int64 label value. + # Corresponds to the JSON property `int64Value` + # @return [Fixnum] + attr_accessor :int64_value + + # A string label value. + # Corresponds to the JSON property `stringValue` + # @return [String] + attr_accessor :string_value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bool_value = args[:bool_value] if args.key?(:bool_value) + @int64_value = args[:int64_value] if args.key?(:int64_value) + @string_value = args[:string_value] if args.key?(:string_value) + end + end + # Parameters for a latency threshold SLI. class LatencyCriteria include Google::Apis::Core::Hashable @@ -2075,8 +2116,9 @@ module Google # multiple streams on each resource to a single stream for each resource or when # aggregating streams across all members of a group of resrouces). Multiple # aggregations are applied in the order specified.This field is similar to the - # one in the ListTimeSeries request. It is advisable to use the ListTimeSeries - # method when debugging this field. + # one in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ + # ref_v3/rest/v3/projects.timeSeries/list). It is advisable to use the + # ListTimeSeries method when debugging this field. # Corresponds to the JSON property `aggregations` # @return [Array] attr_accessor :aggregations @@ -2091,11 +2133,12 @@ module Google # A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies # which time series should be compared with the threshold.The filter is similar - # to the one that is specified in the ListTimeSeries request (that call is - # useful to verify the time series that will be retrieved / processed) and must - # specify the metric type and optionally may contain restrictions on resource - # type, resource labels, and metric labels. This field may not exceed 2048 - # Unicode characters in length. + # to the one that is specified in the ListTimeSeries request (https://cloud. + # google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that call + # is useful to verify the time series that will be retrieved / processed) and + # must specify the metric type and optionally may contain restrictions on + # resource type, resource labels, and metric labels. This field may not exceed + # 2048 Unicode characters in length. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter @@ -2365,8 +2408,9 @@ module Google # multiple streams on each resource to a single stream for each resource or when # aggregating streams across all members of a group of resrouces). Multiple # aggregations are applied in the order specified.This field is similar to the - # one in the ListTimeSeries request. It is advisable to use the ListTimeSeries - # method when debugging this field. + # one in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ + # ref_v3/rest/v3/projects.timeSeries/list). It is advisable to use the + # ListTimeSeries method when debugging this field. # Corresponds to the JSON property `aggregations` # @return [Array] attr_accessor :aggregations @@ -2417,11 +2461,12 @@ module Google # A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies # which time series should be compared with the threshold.The filter is similar - # to the one that is specified in the ListTimeSeries request (that call is - # useful to verify the time series that will be retrieved / processed) and must - # specify the metric type and optionally may contain restrictions on resource - # type, resource labels, and metric labels. This field may not exceed 2048 - # Unicode characters in length. + # to the one that is specified in the ListTimeSeries request (https://cloud. + # google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that call + # is useful to verify the time series that will be retrieved / processed) and + # must specify the metric type and optionally may contain restrictions on + # resource type, resource labels, and metric labels. This field may not exceed + # 2048 Unicode characters in length. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter @@ -2887,6 +2932,122 @@ module Google end end + # A point's value columns and time interval. Each point has one or more point + # values corresponding to the entries in point_descriptors field in the + # TimeSeriesDescriptor associated with this object. + class PointData + include Google::Apis::Core::Hashable + + # A closed time interval. It extends from the start time to the end time, and + # includes both: [startTime, endTime]. Valid time intervals depend on the + # MetricKind of the metric value. In no case can the end time be earlier than + # the start time. + # For a GAUGE metric, the startTime value is technically optional; if no value + # is specified, the start time defaults to the value of the end time, and the + # interval represents a single point in time. If both start and end times are + # specified, they must be identical. Such an interval is valid only for GAUGE + # metrics, which are point-in-time measurements. + # For DELTA and CUMULATIVE metrics, the start time must be earlier than the end + # time. + # In all cases, the start time of the next interval must be at least a + # microsecond after the end time of the previous interval. Because the interval + # is closed, if the start time of a new interval is the same as the end time of + # the previous interval, data written at the new start time could overwrite + # data written at the previous end time. + # Corresponds to the JSON property `timeInterval` + # @return [Google::Apis::MonitoringV3::TimeInterval] + attr_accessor :time_interval + + # The values that make up the point. + # Corresponds to the JSON property `values` + # @return [Array] + attr_accessor :values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @time_interval = args[:time_interval] if args.key?(:time_interval) + @values = args[:values] if args.key?(:values) + end + end + + # The QueryTimeSeries request. + class QueryTimeSeriesRequest + include Google::Apis::Core::Hashable + + # A positive number that is the maximum number of time_series_data to return. + # Corresponds to the JSON property `pageSize` + # @return [Fixnum] + attr_accessor :page_size + + # If this field is not empty then it must contain the nextPageToken value + # returned by a previous call to this method. Using this field causes the method + # to return additional results from the previous method call. + # Corresponds to the JSON property `pageToken` + # @return [String] + attr_accessor :page_token + + # Required. The query in the monitoring query language format. The default time + # zone is in UTC. + # Corresponds to the JSON property `query` + # @return [String] + attr_accessor :query + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @page_size = args[:page_size] if args.key?(:page_size) + @page_token = args[:page_token] if args.key?(:page_token) + @query = args[:query] if args.key?(:query) + end + end + + # The QueryTimeSeries response. + class QueryTimeSeriesResponse + include Google::Apis::Core::Hashable + + # If there are more results than have been returned, then this field is set to a + # non-empty value. To see the additional results, use that value as page_token + # in the next call to this method. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Query execution errors that may have caused the time series data returned to + # be incomplete. The available data will be available in the response. + # Corresponds to the JSON property `partialErrors` + # @return [Array] + attr_accessor :partial_errors + + # The time series data. + # Corresponds to the JSON property `timeSeriesData` + # @return [Array] + attr_accessor :time_series_data + + # A descriptor for the labels and points in a timeseries. + # Corresponds to the JSON property `timeSeriesDescriptor` + # @return [Google::Apis::MonitoringV3::TimeSeriesDescriptor] + attr_accessor :time_series_descriptor + + 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) + @partial_errors = args[:partial_errors] if args.key?(:partial_errors) + @time_series_data = args[:time_series_data] if args.key?(:time_series_data) + @time_series_descriptor = args[:time_series_descriptor] if args.key?(:time_series_descriptor) + end + end + # The range of the population values. class Range include Google::Apis::Core::Hashable @@ -2989,8 +3150,8 @@ module Google # A Service is a discrete, autonomous, and network-accessible unit, designed to # solve an individual concern (Wikipedia (https://en.wikipedia.org/wiki/Service- - # orientation)). In Stackdriver Monitoring, a Service acts as the root resource - # under which operational aspects of the service are accessible. + # orientation)). In Cloud Monitoring, a Service acts as the root resource under + # which operational aspects of the service are accessible. class Service include Google::Apis::Core::Hashable @@ -3027,7 +3188,7 @@ module Google attr_accessor :mesh_istio # Resource name for this Service. The format is: - # projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID` + # projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3427,6 +3588,87 @@ module Google end end + # Represents the values of a time series associated with a TimeSeriesDescriptor. + class TimeSeriesData + include Google::Apis::Core::Hashable + + # The values of the labels in the time series identifier, given in the same + # order as the label_descriptors field of the TimeSeriesDescriptor associated + # with this object. Each value must have a value of the type given in the + # corresponding entry of label_descriptors. + # Corresponds to the JSON property `labelValues` + # @return [Array] + attr_accessor :label_values + + # The points in the time series. + # Corresponds to the JSON property `pointData` + # @return [Array] + attr_accessor :point_data + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @label_values = args[:label_values] if args.key?(:label_values) + @point_data = args[:point_data] if args.key?(:point_data) + end + end + + # A descriptor for the labels and points in a timeseries. + class TimeSeriesDescriptor + include Google::Apis::Core::Hashable + + # Descriptors for the labels. + # Corresponds to the JSON property `labelDescriptors` + # @return [Array] + attr_accessor :label_descriptors + + # Descriptors for the point data value columns. + # Corresponds to the JSON property `pointDescriptors` + # @return [Array] + attr_accessor :point_descriptors + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @label_descriptors = args[:label_descriptors] if args.key?(:label_descriptors) + @point_descriptors = args[:point_descriptors] if args.key?(:point_descriptors) + end + end + + # A condition type that allows alert policies to be defined using Monitoring + # Query Language. + class TimeSeriesQueryLanguageCondition + include Google::Apis::Core::Hashable + + # Monitoring Query Language query that generates time series data and describes + # a condition for alerting on that data. + # Corresponds to the JSON property `query` + # @return [String] + attr_accessor :query + + # A short explanation of what the query represents. For example:"Error ratio + # exceeds 15% for >5% of servers in >2 regions" + # Corresponds to the JSON property `summary` + # @return [String] + attr_accessor :summary + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @query = args[:query] if args.key?(:query) + @summary = args[:summary] if args.key?(:summary) + end + end + # A TimeSeriesRatio specifies two TimeSeries to use for computing the # good_service / total_service ratio. The specified TimeSeries must have # ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = @@ -3765,6 +4007,37 @@ module Google end end + # A descriptor for the value columns in a data point. + class ValueDescriptor + include Google::Apis::Core::Hashable + + # The value key. + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # The value stream kind. + # Corresponds to the JSON property `metricKind` + # @return [String] + attr_accessor :metric_kind + + # The value type. + # Corresponds to the JSON property `valueType` + # @return [String] + attr_accessor :value_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @key = args[:key] if args.key?(:key) + @metric_kind = args[:metric_kind] if args.key?(:metric_kind) + @value_type = args[:value_type] if args.key?(:value_type) + end + end + # The VerifyNotificationChannel request. class VerifyNotificationChannelRequest include Google::Apis::Core::Hashable diff --git a/generated/google/apis/monitoring_v3/representations.rb b/generated/google/apis/monitoring_v3/representations.rb index 485665d98..0d73141f2 100644 --- a/generated/google/apis/monitoring_v3/representations.rb +++ b/generated/google/apis/monitoring_v3/representations.rb @@ -244,6 +244,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class LabelValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class LatencyCriteria class Representation < Google::Apis::Core::JsonRepresentation; end @@ -424,6 +430,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class PointData + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class QueryTimeSeriesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class QueryTimeSeriesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Range class Representation < Google::Apis::Core::JsonRepresentation; end @@ -508,6 +532,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class TimeSeriesData + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TimeSeriesDescriptor + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TimeSeriesQueryLanguageCondition + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class TimeSeriesRatio class Representation < Google::Apis::Core::JsonRepresentation; end @@ -544,6 +586,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ValueDescriptor + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class VerifyNotificationChannelRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -704,6 +752,8 @@ module Google property :condition_threshold, as: 'conditionThreshold', class: Google::Apis::MonitoringV3::MetricThreshold, decorator: Google::Apis::MonitoringV3::MetricThreshold::Representation + property :condition_time_series_query_language, as: 'conditionTimeSeriesQueryLanguage', class: Google::Apis::MonitoringV3::TimeSeriesQueryLanguageCondition, decorator: Google::Apis::MonitoringV3::TimeSeriesQueryLanguageCondition::Representation + property :display_name, as: 'displayName' property :name, as: 'name' end @@ -928,6 +978,15 @@ module Google end end + class LabelValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bool_value, as: 'boolValue' + property :int64_value, :numeric_string => true, as: 'int64Value' + property :string_value, as: 'stringValue' + end + end + class LatencyCriteria # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1232,6 +1291,38 @@ module Google end end + class PointData + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :time_interval, as: 'timeInterval', class: Google::Apis::MonitoringV3::TimeInterval, decorator: Google::Apis::MonitoringV3::TimeInterval::Representation + + collection :values, as: 'values', class: Google::Apis::MonitoringV3::TypedValue, decorator: Google::Apis::MonitoringV3::TypedValue::Representation + + end + end + + class QueryTimeSeriesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :page_size, as: 'pageSize' + property :page_token, as: 'pageToken' + property :query, as: 'query' + end + end + + class QueryTimeSeriesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :partial_errors, as: 'partialErrors', class: Google::Apis::MonitoringV3::Status, decorator: Google::Apis::MonitoringV3::Status::Representation + + collection :time_series_data, as: 'timeSeriesData', class: Google::Apis::MonitoringV3::TimeSeriesData, decorator: Google::Apis::MonitoringV3::TimeSeriesData::Representation + + property :time_series_descriptor, as: 'timeSeriesDescriptor', class: Google::Apis::MonitoringV3::TimeSeriesDescriptor, decorator: Google::Apis::MonitoringV3::TimeSeriesDescriptor::Representation + + end + end + class Range # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1370,6 +1461,34 @@ module Google end end + class TimeSeriesData + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :label_values, as: 'labelValues', class: Google::Apis::MonitoringV3::LabelValue, decorator: Google::Apis::MonitoringV3::LabelValue::Representation + + collection :point_data, as: 'pointData', class: Google::Apis::MonitoringV3::PointData, decorator: Google::Apis::MonitoringV3::PointData::Representation + + end + end + + class TimeSeriesDescriptor + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :label_descriptors, as: 'labelDescriptors', class: Google::Apis::MonitoringV3::LabelDescriptor, decorator: Google::Apis::MonitoringV3::LabelDescriptor::Representation + + collection :point_descriptors, as: 'pointDescriptors', class: Google::Apis::MonitoringV3::ValueDescriptor, decorator: Google::Apis::MonitoringV3::ValueDescriptor::Representation + + end + end + + class TimeSeriesQueryLanguageCondition + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :query, as: 'query' + property :summary, as: 'summary' + end + end + class TimeSeriesRatio # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1447,6 +1566,15 @@ module Google end end + class ValueDescriptor + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :metric_kind, as: 'metricKind' + property :value_type, as: 'valueType' + end + end + class VerifyNotificationChannelRequest # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/monitoring_v3/service.rb b/generated/google/apis/monitoring_v3/service.rb index b7a70ff72..1fe2d151f 100644 --- a/generated/google/apis/monitoring_v3/service.rb +++ b/generated/google/apis/monitoring_v3/service.rb @@ -20,14 +20,13 @@ require 'google/apis/errors' module Google module Apis module MonitoringV3 - # Stackdriver Monitoring API + # Cloud Monitoring API # - # Manages your Stackdriver Monitoring data and configurations. Most projects - # must be associated with a Stackdriver account, with a few exceptions as noted - # on the individual method pages. The table entries below are presented in - # alphabetical order, not in order of common use. For explanations of the - # concepts found in the table entries, read the Stackdriver Monitoring - # documentation. + # Manages your Cloud Monitoring data and configurations. Most projects must be + # associated with a Workspace, with a few exceptions as noted on the individual + # method pages. The table entries below are presented in alphabetical order, not + # in order of common use. For explanations of the concepts found in the table + # entries, read the Cloud Monitoring documentation. # # @example # require 'google/apis/monitoring_v3' @@ -629,8 +628,7 @@ module Google execute_or_queue_command(command, &block) end - # Gets a single metric descriptor. This method does not require a Stackdriver - # account. + # Gets a single metric descriptor. This method does not require a Workspace. # @param [String] name # Required. The metric descriptor on which to execute the request. The format is: # projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] @@ -664,7 +662,7 @@ module Google end # Lists metric descriptors that match a filter. This method does not require a - # Stackdriver account. + # Workspace. # @param [String] name # Required. The project on which to execute the request. The format is: # projects/[PROJECT_ID_OR_NUMBER] @@ -712,7 +710,7 @@ module Google end # Gets a single monitored resource descriptor. This method does not require a - # Stackdriver account. + # Workspace. # @param [String] name # Required. The monitored resource descriptor to get. The format is: # projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE] @@ -745,7 +743,7 @@ module Google end # Lists monitored resource descriptors that match a filter. This method does not - # require a Stackdriver account. + # require a Workspace. # @param [String] name # Required. The project on which to execute the request. The format is: # projects/[PROJECT_ID_OR_NUMBER] @@ -1229,7 +1227,7 @@ module Google end # Lists time series that match a filter. This method does not require a - # Stackdriver account. + # Workspace. # @param [String] name # Required. The project on which to execute the request. The format is: # projects/[PROJECT_ID_OR_NUMBER] @@ -1342,6 +1340,41 @@ module Google execute_or_queue_command(command, &block) end + # Queries time series using the time series query language. This method does not + # require a Workspace. + # @param [String] name + # Required. The project on which to execute the request. The format is: + # projects/[PROJECT_ID_OR_NUMBER] + # @param [Google::Apis::MonitoringV3::QueryTimeSeriesRequest] query_time_series_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MonitoringV3::QueryTimeSeriesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MonitoringV3::QueryTimeSeriesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def query_time_series(name, query_time_series_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v3/{+name}/timeSeries:query', options) + command.request_representation = Google::Apis::MonitoringV3::QueryTimeSeriesRequest::Representation + command.request_object = query_time_series_request_object + command.response_representation = Google::Apis::MonitoringV3::QueryTimeSeriesResponse::Representation + command.response_class = Google::Apis::MonitoringV3::QueryTimeSeriesResponse + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a new Uptime check configuration. # @param [String] parent # Required. The project in which to create the Uptime check. The format is: @@ -1633,9 +1666,9 @@ module Google # List Services for this workspace. # @param [String] parent # Required. Resource name of the parent containing the listed services, either a - # project or Stackdriver Account (workspace). The formats are: + # project or a Monitoring Workspace. The formats are: # projects/[PROJECT_ID_OR_NUMBER] - # workspaces/[HOST_PROJECT_ID] + # workspaces/[HOST_PROJECT_ID_OR_NUMBER] # @param [String] filter # A filter specifying what Services to return. The filter currently supports the # following fields: @@ -1690,7 +1723,7 @@ module Google # Update this Service. # @param [String] name # Resource name for this Service. The format is: - # projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID` + # projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] # @param [Google::Apis::MonitoringV3::Service] service_object # @param [String] update_mask # A set of field paths defining which fields to use for the update. @@ -1834,8 +1867,10 @@ module Google # List the ServiceLevelObjectives for the given Service. # @param [String] parent - # Required. Resource name of the parent Service. The format is: + # Required. Resource name of the parent containing the listed SLOs, either a + # project or a Monitoring Workspace. The formats are: # projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] + # workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/- # @param [String] filter # A filter specifying what ServiceLevelObjectives to return. # @param [Fixnum] page_size diff --git a/generated/google/apis/oauth2_v1.rb b/generated/google/apis/oauth2_v1.rb deleted file mode 100644 index 8a212ee7c..000000000 --- a/generated/google/apis/oauth2_v1.rb +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2015 Google Inc. -# -# 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 'google/apis/oauth2_v1/service.rb' -require 'google/apis/oauth2_v1/classes.rb' -require 'google/apis/oauth2_v1/representations.rb' - -module Google - module Apis - # Google OAuth2 API - # - # Obtains end-user authorization grants for use with other Google APIs. - # - # @see https://developers.google.com/accounts/docs/OAuth2 - module Oauth2V1 - VERSION = 'V1' - REVISION = '20190313' - - # Associate you with your personal info on Google - AUTH_PLUS_ME = 'https://www.googleapis.com/auth/plus.me' - - # View your email address - AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' - - # See your personal info, including any personal info you've made publicly available - AUTH_USERINFO_PROFILE = 'https://www.googleapis.com/auth/userinfo.profile' - end - end -end diff --git a/generated/google/apis/oauth2_v1/classes.rb b/generated/google/apis/oauth2_v1/classes.rb deleted file mode 100644 index d4b949552..000000000 --- a/generated/google/apis/oauth2_v1/classes.rb +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright 2015 Google Inc. -# -# 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 Oauth2V1 - - # - class Tokeninfo - include Google::Apis::Core::Hashable - - # The access type granted with this token. It can be offline or online. - # Corresponds to the JSON property `access_type` - # @return [String] - attr_accessor :access_type - - # Who is the intended audience for this token. In general the same as issued_to. - # Corresponds to the JSON property `audience` - # @return [String] - attr_accessor :audience - - # The email address of the user. Present only if the email scope is present in - # the request. - # Corresponds to the JSON property `email` - # @return [String] - attr_accessor :email - - # Boolean flag which is true if the email address is verified. Present only if - # the email scope is present in the request. - # Corresponds to the JSON property `email_verified` - # @return [Boolean] - attr_accessor :email_verified - alias_method :email_verified?, :email_verified - - # The expiry time of the token, as number of seconds left until expiry. - # Corresponds to the JSON property `expires_in` - # @return [Fixnum] - attr_accessor :expires_in - - # The issue time of the token, as number of seconds. - # Corresponds to the JSON property `issued_at` - # @return [Fixnum] - attr_accessor :issued_at - - # To whom was the token issued to. In general the same as audience. - # Corresponds to the JSON property `issued_to` - # @return [String] - attr_accessor :issued_to - - # Who issued the token. - # Corresponds to the JSON property `issuer` - # @return [String] - attr_accessor :issuer - - # Nonce of the id token. - # Corresponds to the JSON property `nonce` - # @return [String] - attr_accessor :nonce - - # The space separated list of scopes granted to this token. - # Corresponds to the JSON property `scope` - # @return [String] - attr_accessor :scope - - # The obfuscated user id. - # Corresponds to the JSON property `user_id` - # @return [String] - attr_accessor :user_id - - # Boolean flag which is true if the email address is verified. Present only if - # the email scope is present in the request. - # Corresponds to the JSON property `verified_email` - # @return [Boolean] - attr_accessor :verified_email - alias_method :verified_email?, :verified_email - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @access_type = args[:access_type] if args.key?(:access_type) - @audience = args[:audience] if args.key?(:audience) - @email = args[:email] if args.key?(:email) - @email_verified = args[:email_verified] if args.key?(:email_verified) - @expires_in = args[:expires_in] if args.key?(:expires_in) - @issued_at = args[:issued_at] if args.key?(:issued_at) - @issued_to = args[:issued_to] if args.key?(:issued_to) - @issuer = args[:issuer] if args.key?(:issuer) - @nonce = args[:nonce] if args.key?(:nonce) - @scope = args[:scope] if args.key?(:scope) - @user_id = args[:user_id] if args.key?(:user_id) - @verified_email = args[:verified_email] if args.key?(:verified_email) - end - end - - # - class Userinfoplus - include Google::Apis::Core::Hashable - - # The user's email address. - # Corresponds to the JSON property `email` - # @return [String] - attr_accessor :email - - # The user's last name. - # Corresponds to the JSON property `family_name` - # @return [String] - attr_accessor :family_name - - # The user's gender. - # Corresponds to the JSON property `gender` - # @return [String] - attr_accessor :gender - - # The user's first name. - # Corresponds to the JSON property `given_name` - # @return [String] - attr_accessor :given_name - - # The hosted domain e.g. example.com if the user is Google apps user. - # Corresponds to the JSON property `hd` - # @return [String] - attr_accessor :hd - - # The obfuscated ID of the user. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # URL of the profile page. - # Corresponds to the JSON property `link` - # @return [String] - attr_accessor :link - - # The user's preferred locale. - # Corresponds to the JSON property `locale` - # @return [String] - attr_accessor :locale - - # The user's full name. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # URL of the user's picture image. - # Corresponds to the JSON property `picture` - # @return [String] - attr_accessor :picture - - # Boolean flag which is true if the email address is verified. Always verified - # because we only return the user's primary email address. - # Corresponds to the JSON property `verified_email` - # @return [Boolean] - attr_accessor :verified_email - alias_method :verified_email?, :verified_email - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @email = args[:email] if args.key?(:email) - @family_name = args[:family_name] if args.key?(:family_name) - @gender = args[:gender] if args.key?(:gender) - @given_name = args[:given_name] if args.key?(:given_name) - @hd = args[:hd] if args.key?(:hd) - @id = args[:id] if args.key?(:id) - @link = args[:link] if args.key?(:link) - @locale = args[:locale] if args.key?(:locale) - @name = args[:name] if args.key?(:name) - @picture = args[:picture] if args.key?(:picture) - @verified_email = args[:verified_email] if args.key?(:verified_email) - end - end - end - end -end diff --git a/generated/google/apis/oauth2_v1/representations.rb b/generated/google/apis/oauth2_v1/representations.rb deleted file mode 100644 index 79cf5cc12..000000000 --- a/generated/google/apis/oauth2_v1/representations.rb +++ /dev/null @@ -1,73 +0,0 @@ -# Copyright 2015 Google Inc. -# -# 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 Oauth2V1 - - class Tokeninfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Userinfoplus - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Tokeninfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :access_type, as: 'access_type' - property :audience, as: 'audience' - property :email, as: 'email' - property :email_verified, as: 'email_verified' - property :expires_in, as: 'expires_in' - property :issued_at, as: 'issued_at' - property :issued_to, as: 'issued_to' - property :issuer, as: 'issuer' - property :nonce, as: 'nonce' - property :scope, as: 'scope' - property :user_id, as: 'user_id' - property :verified_email, as: 'verified_email' - end - end - - class Userinfoplus - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :email, as: 'email' - property :family_name, as: 'family_name' - property :gender, as: 'gender' - property :given_name, as: 'given_name' - property :hd, as: 'hd' - property :id, as: 'id' - property :link, as: 'link' - property :locale, as: 'locale' - property :name, as: 'name' - property :picture, as: 'picture' - property :verified_email, as: 'verified_email' - end - end - end - end -end diff --git a/generated/google/apis/oauth2_v1/service.rb b/generated/google/apis/oauth2_v1/service.rb deleted file mode 100644 index d60add7f9..000000000 --- a/generated/google/apis/oauth2_v1/service.rb +++ /dev/null @@ -1,160 +0,0 @@ -# Copyright 2015 Google Inc. -# -# 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 '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 Oauth2V1 - # Google OAuth2 API - # - # Obtains end-user authorization grants for use with other Google APIs. - # - # @example - # require 'google/apis/oauth2_v1' - # - # Oauth2 = Google::Apis::Oauth2V1 # Alias the module - # service = Oauth2::Oauth2Service.new - # - # @see https://developers.google.com/accounts/docs/OAuth2 - class Oauth2Service < Google::Apis::Core::BaseService - # @return [String] - # API key. Your API key identifies your project and provides you with API access, - # quota, and reports. Required unless you provide an OAuth 2.0 token. - attr_accessor :key - - # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - attr_accessor :quota_user - - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - - def initialize - super('https://www.googleapis.com/', '') - @batch_path = 'batch/oauth2/v1' - end - - # Get token info - # @param [String] access_token - # The oauth2 access token - # @param [String] id_token - # The ID token - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::Oauth2V1::Tokeninfo] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::Oauth2V1::Tokeninfo] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def tokeninfo(access_token: nil, id_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'oauth2/v1/tokeninfo', options) - command.response_representation = Google::Apis::Oauth2V1::Tokeninfo::Representation - command.response_class = Google::Apis::Oauth2V1::Tokeninfo - command.query['access_token'] = access_token unless access_token.nil? - command.query['id_token'] = id_token unless id_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Get user info - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::Oauth2V1::Userinfoplus] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::Oauth2V1::Userinfoplus] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_userinfo(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'oauth2/v1/userinfo', options) - command.response_representation = Google::Apis::Oauth2V1::Userinfoplus::Representation - command.response_class = Google::Apis::Oauth2V1::Userinfoplus - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Get user info - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::Oauth2V1::Userinfoplus] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::Oauth2V1::Userinfoplus] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_userinfo_v2_me(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'userinfo/v2/me', options) - command.response_representation = Google::Apis::Oauth2V1::Userinfoplus::Representation - command.response_class = Google::Apis::Oauth2V1::Userinfoplus - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - protected - - def apply_command_defaults(command) - command.query['key'] = key unless key.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - end - end - end - end -end diff --git a/generated/google/apis/oauth2_v2.rb b/generated/google/apis/oauth2_v2.rb index 0f5e0eeee..483381e83 100644 --- a/generated/google/apis/oauth2_v2.rb +++ b/generated/google/apis/oauth2_v2.rb @@ -22,19 +22,19 @@ module Google # # Obtains end-user authorization grants for use with other Google APIs. # - # @see https://developers.google.com/accounts/docs/OAuth2 + # @see https://developers.google.com/identity/protocols/oauth2/ module Oauth2V2 VERSION = 'V2' REVISION = '20200213' - # Associate you with your personal info on Google - AUTH_PLUS_ME = 'https://www.googleapis.com/auth/plus.me' - # View your email address AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' # See your personal info, including any personal info you've made publicly available AUTH_USERINFO_PROFILE = 'https://www.googleapis.com/auth/userinfo.profile' + + # Associate you with your personal info on Google + PENID = 'openid' end end end diff --git a/generated/google/apis/oauth2_v2/classes.rb b/generated/google/apis/oauth2_v2/classes.rb index b91205e5d..ada9a3162 100644 --- a/generated/google/apis/oauth2_v2/classes.rb +++ b/generated/google/apis/oauth2_v2/classes.rb @@ -26,11 +26,6 @@ module Google class Tokeninfo include Google::Apis::Core::Hashable - # The access type granted with this token. It can be offline or online. - # Corresponds to the JSON property `access_type` - # @return [String] - attr_accessor :access_type - # Who is the intended audience for this token. In general the same as issued_to. # Corresponds to the JSON property `audience` # @return [String] @@ -57,11 +52,6 @@ module Google # @return [String] attr_accessor :scope - # The token handle associated with this token. - # Corresponds to the JSON property `token_handle` - # @return [String] - attr_accessor :token_handle - # The obfuscated user id. # Corresponds to the JSON property `user_id` # @return [String] @@ -80,20 +70,18 @@ module Google # Update properties of this object def update!(**args) - @access_type = args[:access_type] if args.key?(:access_type) @audience = args[:audience] if args.key?(:audience) @email = args[:email] if args.key?(:email) @expires_in = args[:expires_in] if args.key?(:expires_in) @issued_to = args[:issued_to] if args.key?(:issued_to) @scope = args[:scope] if args.key?(:scope) - @token_handle = args[:token_handle] if args.key?(:token_handle) @user_id = args[:user_id] if args.key?(:user_id) @verified_email = args[:verified_email] if args.key?(:verified_email) end end # - class Userinfoplus + class Userinfo include Google::Apis::Core::Hashable # The user's email address. diff --git a/generated/google/apis/oauth2_v2/representations.rb b/generated/google/apis/oauth2_v2/representations.rb index 76f7fed92..b1ce7fd9d 100644 --- a/generated/google/apis/oauth2_v2/representations.rb +++ b/generated/google/apis/oauth2_v2/representations.rb @@ -28,7 +28,7 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class Userinfoplus + class Userinfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -37,19 +37,17 @@ module Google class Tokeninfo # @private class Representation < Google::Apis::Core::JsonRepresentation - property :access_type, as: 'access_type' property :audience, as: 'audience' property :email, as: 'email' property :expires_in, as: 'expires_in' property :issued_to, as: 'issued_to' property :scope, as: 'scope' - property :token_handle, as: 'token_handle' property :user_id, as: 'user_id' property :verified_email, as: 'verified_email' end end - class Userinfoplus + class Userinfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :email, as: 'email' diff --git a/generated/google/apis/oauth2_v2/service.rb b/generated/google/apis/oauth2_v2/service.rb index f61852896..295c53e74 100644 --- a/generated/google/apis/oauth2_v2/service.rb +++ b/generated/google/apis/oauth2_v2/service.rb @@ -30,7 +30,7 @@ module Google # Oauth2 = Google::Apis::Oauth2V2 # Alias the module # service = Oauth2::Oauth2Service.new # - # @see https://developers.google.com/accounts/docs/OAuth2 + # @see https://developers.google.com/identity/protocols/oauth2/ class Oauth2Service < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, @@ -54,7 +54,6 @@ module Google # # @param [String] access_token # @param [String] id_token - # @param [String] token_handle # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -74,13 +73,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def tokeninfo(access_token: nil, id_token: nil, token_handle: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def tokeninfo(access_token: nil, id_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'oauth2/v2/tokeninfo', options) command.response_representation = Google::Apis::Oauth2V2::Tokeninfo::Representation command.response_class = Google::Apis::Oauth2V2::Tokeninfo command.query['access_token'] = access_token unless access_token.nil? command.query['id_token'] = id_token unless id_token.nil? - command.query['token_handle'] = token_handle unless token_handle.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -99,18 +97,18 @@ module Google # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::Oauth2V2::Userinfoplus] parsed result object + # @yieldparam result [Google::Apis::Oauth2V2::Userinfo] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [Google::Apis::Oauth2V2::Userinfoplus] + # @return [Google::Apis::Oauth2V2::Userinfo] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def get_userinfo(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'oauth2/v2/userinfo', options) - command.response_representation = Google::Apis::Oauth2V2::Userinfoplus::Representation - command.response_class = Google::Apis::Oauth2V2::Userinfoplus + command.response_representation = Google::Apis::Oauth2V2::Userinfo::Representation + command.response_class = Google::Apis::Oauth2V2::Userinfo command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -129,18 +127,18 @@ module Google # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::Oauth2V2::Userinfoplus] parsed result object + # @yieldparam result [Google::Apis::Oauth2V2::Userinfo] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [Google::Apis::Oauth2V2::Userinfoplus] + # @return [Google::Apis::Oauth2V2::Userinfo] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def get_userinfo_v2(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userinfo/v2/me', options) - command.response_representation = Google::Apis::Oauth2V2::Userinfoplus::Representation - command.response_class = Google::Apis::Oauth2V2::Userinfoplus + command.response_representation = Google::Apis::Oauth2V2::Userinfo::Representation + command.response_class = Google::Apis::Oauth2V2::Userinfo command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? diff --git a/generated/google/apis/osconfig_v1.rb b/generated/google/apis/osconfig_v1.rb new file mode 100644 index 000000000..959d4a8fc --- /dev/null +++ b/generated/google/apis/osconfig_v1.rb @@ -0,0 +1,35 @@ +# Copyright 2015 Google Inc. +# +# 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 'google/apis/osconfig_v1/service.rb' +require 'google/apis/osconfig_v1/classes.rb' +require 'google/apis/osconfig_v1/representations.rb' + +module Google + module Apis + # Cloud OS Config API + # + # OS management tools that can be used for patch management, patch compliance, + # and configuration management on VM instances. + # + # @see https://cloud.google.com/ + module OsconfigV1 + VERSION = 'V1' + REVISION = '20200403' + + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' + end + end +end diff --git a/generated/google/apis/osconfig_v1/classes.rb b/generated/google/apis/osconfig_v1/classes.rb new file mode 100644 index 000000000..ceca2a0ed --- /dev/null +++ b/generated/google/apis/osconfig_v1/classes.rb @@ -0,0 +1,1223 @@ +# Copyright 2015 Google Inc. +# +# 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 OsconfigV1 + + # Apt patching is completed by executing `apt-get update && apt-get + # upgrade`. Additional options can be set to control how this is executed. + class AptSettings + include Google::Apis::Core::Hashable + + # List of packages to exclude from update. These packages will be excluded + # Corresponds to the JSON property `excludes` + # @return [Array] + attr_accessor :excludes + + # An exclusive list of packages to be updated. These are the only packages + # that will be updated. If these packages are not installed, they will be + # ignored. This field cannot be specified with any other patch configuration + # fields. + # Corresponds to the JSON property `exclusivePackages` + # @return [Array] + attr_accessor :exclusive_packages + + # By changing the type to DIST, the patching is performed + # using `apt-get dist-upgrade` instead. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @excludes = args[:excludes] if args.key?(:excludes) + @exclusive_packages = args[:exclusive_packages] if args.key?(:exclusive_packages) + @type = args[:type] if args.key?(:type) + end + end + + # Message for canceling a patch job. + class CancelPatchJobRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + 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 + + # A step that runs an executable for a PatchJob. + class ExecStep + include Google::Apis::Core::Hashable + + # Common configurations for an ExecStep. + # Corresponds to the JSON property `linuxExecStepConfig` + # @return [Google::Apis::OsconfigV1::ExecStepConfig] + attr_accessor :linux_exec_step_config + + # Common configurations for an ExecStep. + # Corresponds to the JSON property `windowsExecStepConfig` + # @return [Google::Apis::OsconfigV1::ExecStepConfig] + attr_accessor :windows_exec_step_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @linux_exec_step_config = args[:linux_exec_step_config] if args.key?(:linux_exec_step_config) + @windows_exec_step_config = args[:windows_exec_step_config] if args.key?(:windows_exec_step_config) + end + end + + # Common configurations for an ExecStep. + class ExecStepConfig + include Google::Apis::Core::Hashable + + # Defaults to [0]. A list of possible return values that the + # execution can return to indicate a success. + # Corresponds to the JSON property `allowedSuccessCodes` + # @return [Array] + attr_accessor :allowed_success_codes + + # Google Cloud Storage object representation. + # Corresponds to the JSON property `gcsObject` + # @return [Google::Apis::OsconfigV1::GcsObject] + attr_accessor :gcs_object + + # The script interpreter to use to run the script. If no interpreter is + # specified the script will be executed directly, which will likely + # only succeed for scripts with [shebang lines] + # (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). + # Corresponds to the JSON property `interpreter` + # @return [String] + attr_accessor :interpreter + + # An absolute path to the executable on the VM. + # Corresponds to the JSON property `localPath` + # @return [String] + attr_accessor :local_path + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allowed_success_codes = args[:allowed_success_codes] if args.key?(:allowed_success_codes) + @gcs_object = args[:gcs_object] if args.key?(:gcs_object) + @interpreter = args[:interpreter] if args.key?(:interpreter) + @local_path = args[:local_path] if args.key?(:local_path) + end + end + + # A request message to initiate patching across Google Compute Engine + # instances. + class ExecutePatchJobRequest + include Google::Apis::Core::Hashable + + # Description of the patch job. Length of the description is limited + # to 1024 characters. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Display name for this patch job. This does not have to be unique. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # If this patch is a dry-run only, instances are contacted but + # will do nothing. + # Corresponds to the JSON property `dryRun` + # @return [Boolean] + attr_accessor :dry_run + alias_method :dry_run?, :dry_run + + # Duration of the patch job. After the duration ends, the patch job + # times out. + # Corresponds to the JSON property `duration` + # @return [String] + attr_accessor :duration + + # A filter to target VM instances for patching. The targeted + # VMs must meet all criteria specified. So if both labels and zones are + # specified, the patch job targets only VMs with those labels and in those + # zones. + # Corresponds to the JSON property `instanceFilter` + # @return [Google::Apis::OsconfigV1::PatchInstanceFilter] + attr_accessor :instance_filter + + # Patch configuration specifications. Contains details on how to apply the + # patch(es) to a VM instance. + # Corresponds to the JSON property `patchConfig` + # @return [Google::Apis::OsconfigV1::PatchConfig] + attr_accessor :patch_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @dry_run = args[:dry_run] if args.key?(:dry_run) + @duration = args[:duration] if args.key?(:duration) + @instance_filter = args[:instance_filter] if args.key?(:instance_filter) + @patch_config = args[:patch_config] if args.key?(:patch_config) + end + end + + # Google Cloud Storage object representation. + class GcsObject + include Google::Apis::Core::Hashable + + # Required. Bucket of the Google Cloud Storage object. + # Corresponds to the JSON property `bucket` + # @return [String] + attr_accessor :bucket + + # Required. Generation number of the Google Cloud Storage object. This is used + # to + # ensure that the ExecStep specified by this PatchJob does not change. + # Corresponds to the JSON property `generationNumber` + # @return [Fixnum] + attr_accessor :generation_number + + # Required. Name of the Google Cloud Storage object. + # Corresponds to the JSON property `object` + # @return [String] + attr_accessor :object + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bucket = args[:bucket] if args.key?(:bucket) + @generation_number = args[:generation_number] if args.key?(:generation_number) + @object = args[:object] if args.key?(:object) + end + end + + # Googet patching is performed by running `googet update`. + class GooSettings + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # A response message for listing patch deployments. + class ListPatchDeploymentsResponse + include Google::Apis::Core::Hashable + + # A pagination token that can be used to get the next page of patch + # deployments. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The list of patch deployments. + # Corresponds to the JSON property `patchDeployments` + # @return [Array] + attr_accessor :patch_deployments + + 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) + @patch_deployments = args[:patch_deployments] if args.key?(:patch_deployments) + end + end + + # A response message for listing the instances details for a patch job. + class ListPatchJobInstanceDetailsResponse + include Google::Apis::Core::Hashable + + # A pagination token that can be used to get the next page of results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # A list of instance status. + # Corresponds to the JSON property `patchJobInstanceDetails` + # @return [Array] + attr_accessor :patch_job_instance_details + + 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) + @patch_job_instance_details = args[:patch_job_instance_details] if args.key?(:patch_job_instance_details) + end + end + + # A response message for listing patch jobs. + class ListPatchJobsResponse + include Google::Apis::Core::Hashable + + # A pagination token that can be used to get the next page of results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The list of patch jobs. + # Corresponds to the JSON property `patchJobs` + # @return [Array] + attr_accessor :patch_jobs + + 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) + @patch_jobs = args[:patch_jobs] if args.key?(:patch_jobs) + end + end + + # Represents a monthly schedule. An example of a valid monthly schedule is + # "on the third Tuesday of the month" or "on the 15th of the month". + class MonthlySchedule + include Google::Apis::Core::Hashable + + # Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 + # indicates the last day of the month. + # Months without the target day will be skipped. For example, a schedule to + # run "every month on the 31st" will not run in February, April, June, etc. + # Corresponds to the JSON property `monthDay` + # @return [Fixnum] + attr_accessor :month_day + + # Represents one week day in a month. An example is "the 4th Sunday". + # Corresponds to the JSON property `weekDayOfMonth` + # @return [Google::Apis::OsconfigV1::WeekDayOfMonth] + attr_accessor :week_day_of_month + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @month_day = args[:month_day] if args.key?(:month_day) + @week_day_of_month = args[:week_day_of_month] if args.key?(:week_day_of_month) + end + end + + # Sets the time for a one time patch deployment. Timestamp is in + # RFC3339 + # text format. + class OneTimeSchedule + include Google::Apis::Core::Hashable + + # Required. The desired patch job execution time. + # Corresponds to the JSON property `executeTime` + # @return [String] + attr_accessor :execute_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @execute_time = args[:execute_time] if args.key?(:execute_time) + end + end + + # Patch configuration specifications. Contains details on how to apply the + # patch(es) to a VM instance. + class PatchConfig + include Google::Apis::Core::Hashable + + # Apt patching is completed by executing `apt-get update && apt-get + # upgrade`. Additional options can be set to control how this is executed. + # Corresponds to the JSON property `apt` + # @return [Google::Apis::OsconfigV1::AptSettings] + attr_accessor :apt + + # Googet patching is performed by running `googet update`. + # Corresponds to the JSON property `goo` + # @return [Google::Apis::OsconfigV1::GooSettings] + attr_accessor :goo + + # A step that runs an executable for a PatchJob. + # Corresponds to the JSON property `postStep` + # @return [Google::Apis::OsconfigV1::ExecStep] + attr_accessor :post_step + + # A step that runs an executable for a PatchJob. + # Corresponds to the JSON property `preStep` + # @return [Google::Apis::OsconfigV1::ExecStep] + attr_accessor :pre_step + + # Post-patch reboot settings. + # Corresponds to the JSON property `rebootConfig` + # @return [String] + attr_accessor :reboot_config + + # Windows patching is performed using the Windows Update Agent. + # Corresponds to the JSON property `windowsUpdate` + # @return [Google::Apis::OsconfigV1::WindowsUpdateSettings] + attr_accessor :windows_update + + # Yum patching is performed by executing `yum update`. Additional options + # can be set to control how this is executed. + # Note that not all settings are supported on all platforms. + # Corresponds to the JSON property `yum` + # @return [Google::Apis::OsconfigV1::YumSettings] + attr_accessor :yum + + # Zypper patching is performed by running `zypper patch`. + # See also https://en.opensuse.org/SDB:Zypper_manual. + # Corresponds to the JSON property `zypper` + # @return [Google::Apis::OsconfigV1::ZypperSettings] + attr_accessor :zypper + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @apt = args[:apt] if args.key?(:apt) + @goo = args[:goo] if args.key?(:goo) + @post_step = args[:post_step] if args.key?(:post_step) + @pre_step = args[:pre_step] if args.key?(:pre_step) + @reboot_config = args[:reboot_config] if args.key?(:reboot_config) + @windows_update = args[:windows_update] if args.key?(:windows_update) + @yum = args[:yum] if args.key?(:yum) + @zypper = args[:zypper] if args.key?(:zypper) + end + end + + # Patch deployments are configurations that individual patch jobs use to + # complete a patch. These configurations include instance filter, package + # repository settings, and a schedule. For more information about creating and + # managing patch deployments, see [Scheduling patch + # jobs](/compute/docs/os-patch-management/schedule-patch-jobs). + class PatchDeployment + include Google::Apis::Core::Hashable + + # Output only. Time the patch deployment was created. Timestamp is in + # RFC3339 + # text format. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Optional. Description of the patch deployment. Length of the description is + # limited + # to 1024 characters. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Optional. Duration of the patch. After the duration ends, the patch times out. + # Corresponds to the JSON property `duration` + # @return [String] + attr_accessor :duration + + # A filter to target VM instances for patching. The targeted + # VMs must meet all criteria specified. So if both labels and zones are + # specified, the patch job targets only VMs with those labels and in those + # zones. + # Corresponds to the JSON property `instanceFilter` + # @return [Google::Apis::OsconfigV1::PatchInstanceFilter] + attr_accessor :instance_filter + + # Output only. The last time a patch job was started by this deployment. + # Timestamp is in + # RFC3339 + # text format. + # Corresponds to the JSON property `lastExecuteTime` + # @return [String] + attr_accessor :last_execute_time + + # Unique name for the patch deployment resource in a project. The patch + # deployment name is in the form: + # `projects/`project_id`/patchDeployments/`patch_deployment_id``. + # This field is ignored when you create a new patch deployment. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Sets the time for a one time patch deployment. Timestamp is in + # RFC3339 + # text format. + # Corresponds to the JSON property `oneTimeSchedule` + # @return [Google::Apis::OsconfigV1::OneTimeSchedule] + attr_accessor :one_time_schedule + + # Patch configuration specifications. Contains details on how to apply the + # patch(es) to a VM instance. + # Corresponds to the JSON property `patchConfig` + # @return [Google::Apis::OsconfigV1::PatchConfig] + attr_accessor :patch_config + + # Sets the time for recurring patch deployments. + # Corresponds to the JSON property `recurringSchedule` + # @return [Google::Apis::OsconfigV1::RecurringSchedule] + attr_accessor :recurring_schedule + + # Output only. Time the patch deployment was last updated. Timestamp is in + # RFC3339 + # text format. + # 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) + @description = args[:description] if args.key?(:description) + @duration = args[:duration] if args.key?(:duration) + @instance_filter = args[:instance_filter] if args.key?(:instance_filter) + @last_execute_time = args[:last_execute_time] if args.key?(:last_execute_time) + @name = args[:name] if args.key?(:name) + @one_time_schedule = args[:one_time_schedule] if args.key?(:one_time_schedule) + @patch_config = args[:patch_config] if args.key?(:patch_config) + @recurring_schedule = args[:recurring_schedule] if args.key?(:recurring_schedule) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # A filter to target VM instances for patching. The targeted + # VMs must meet all criteria specified. So if both labels and zones are + # specified, the patch job targets only VMs with those labels and in those + # zones. + class PatchInstanceFilter + include Google::Apis::Core::Hashable + + # Target all VM instances in the project. If true, no other criteria is + # permitted. + # Corresponds to the JSON property `all` + # @return [Boolean] + attr_accessor :all + alias_method :all?, :all + + # Targets VM instances matching at least one of these label sets. This allows + # targeting of disparate groups, for example "env=prod or env=staging". + # Corresponds to the JSON property `groupLabels` + # @return [Array] + attr_accessor :group_labels + + # Targets VMs whose name starts with one of these prefixes. Similar to + # labels, this is another way to group VMs when targeting configs, for + # example prefix="prod-". + # Corresponds to the JSON property `instanceNamePrefixes` + # @return [Array] + attr_accessor :instance_name_prefixes + + # Targets any of the VM instances specified. Instances are specified by their + # URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME], + # `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or + # `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/ + # instances/[INSTANCE_NAME]` + # Corresponds to the JSON property `instances` + # @return [Array] + attr_accessor :instances + + # Targets VM instances in ANY of these zones. Leave empty to target VM + # instances in any zone. + # Corresponds to the JSON property `zones` + # @return [Array] + attr_accessor :zones + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @all = args[:all] if args.key?(:all) + @group_labels = args[:group_labels] if args.key?(:group_labels) + @instance_name_prefixes = args[:instance_name_prefixes] if args.key?(:instance_name_prefixes) + @instances = args[:instances] if args.key?(:instances) + @zones = args[:zones] if args.key?(:zones) + end + end + + # Represents a group of VMs that can be identified as having all these + # labels, for example "env=prod and app=web". + class PatchInstanceFilterGroupLabel + include Google::Apis::Core::Hashable + + # Google Compute Engine instance labels that must be present for a VM + # instance to be targeted by this filter. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @labels = args[:labels] if args.key?(:labels) + end + end + + # A high level representation of a patch job that is either in progress + # or has completed. + # Instances details are not included in the job. To paginate through instance + # details, use ListPatchJobInstanceDetails. + # For more information about patch jobs, see + # [Creating patch jobs](/compute/docs/os-patch-management/create-patch-job). + class PatchJob + include Google::Apis::Core::Hashable + + # Time this patch job was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Description of the patch job. Length of the description is limited + # to 1024 characters. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Display name for this patch job. This is not a unique identifier. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # If this patch job is a dry run, the agent reports that it has + # finished without running any updates on the VM instance. + # Corresponds to the JSON property `dryRun` + # @return [Boolean] + attr_accessor :dry_run + alias_method :dry_run?, :dry_run + + # Duration of the patch job. After the duration ends, the + # patch job times out. + # Corresponds to the JSON property `duration` + # @return [String] + attr_accessor :duration + + # If this patch job failed, this message provides information about the + # failure. + # Corresponds to the JSON property `errorMessage` + # @return [String] + attr_accessor :error_message + + # A summary of the current patch state across all instances that this patch + # job affects. Contains counts of instances in different states. These states + # map to `InstancePatchState`. List patch job instance details to see the + # specific states of each instance. + # Corresponds to the JSON property `instanceDetailsSummary` + # @return [Google::Apis::OsconfigV1::PatchJobInstanceDetailsSummary] + attr_accessor :instance_details_summary + + # A filter to target VM instances for patching. The targeted + # VMs must meet all criteria specified. So if both labels and zones are + # specified, the patch job targets only VMs with those labels and in those + # zones. + # Corresponds to the JSON property `instanceFilter` + # @return [Google::Apis::OsconfigV1::PatchInstanceFilter] + attr_accessor :instance_filter + + # Unique identifier for this patch job in the form + # `projects/*/patchJobs/*` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Patch configuration specifications. Contains details on how to apply the + # patch(es) to a VM instance. + # Corresponds to the JSON property `patchConfig` + # @return [Google::Apis::OsconfigV1::PatchConfig] + attr_accessor :patch_config + + # Output only. Name of the patch deployment that created this patch job. + # Corresponds to the JSON property `patchDeployment` + # @return [String] + attr_accessor :patch_deployment + + # Reflects the overall progress of the patch job in the range of + # 0.0 being no progress to 100.0 being complete. + # Corresponds to the JSON property `percentComplete` + # @return [Float] + attr_accessor :percent_complete + + # The current state of the PatchJob . + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # Last time this patch job was updated. + # 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) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @dry_run = args[:dry_run] if args.key?(:dry_run) + @duration = args[:duration] if args.key?(:duration) + @error_message = args[:error_message] if args.key?(:error_message) + @instance_details_summary = args[:instance_details_summary] if args.key?(:instance_details_summary) + @instance_filter = args[:instance_filter] if args.key?(:instance_filter) + @name = args[:name] if args.key?(:name) + @patch_config = args[:patch_config] if args.key?(:patch_config) + @patch_deployment = args[:patch_deployment] if args.key?(:patch_deployment) + @percent_complete = args[:percent_complete] if args.key?(:percent_complete) + @state = args[:state] if args.key?(:state) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # Patch details for a VM instance. For more information about reviewing VM + # instance details, see + # [Listing all VM instance details for a specific patch + # job](/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details) + # . + class PatchJobInstanceDetails + include Google::Apis::Core::Hashable + + # The number of times the agent that the agent attempts to apply the patch. + # Corresponds to the JSON property `attemptCount` + # @return [Fixnum] + attr_accessor :attempt_count + + # If the patch fails, this field provides the reason. + # Corresponds to the JSON property `failureReason` + # @return [String] + attr_accessor :failure_reason + + # The unique identifier for the instance. This identifier is + # defined by the server. + # Corresponds to the JSON property `instanceSystemId` + # @return [String] + attr_accessor :instance_system_id + + # The instance name in the form `projects/*/zones/*/instances/*` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Current state of instance patch. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @attempt_count = args[:attempt_count] if args.key?(:attempt_count) + @failure_reason = args[:failure_reason] if args.key?(:failure_reason) + @instance_system_id = args[:instance_system_id] if args.key?(:instance_system_id) + @name = args[:name] if args.key?(:name) + @state = args[:state] if args.key?(:state) + end + end + + # A summary of the current patch state across all instances that this patch + # job affects. Contains counts of instances in different states. These states + # map to `InstancePatchState`. List patch job instance details to see the + # specific states of each instance. + class PatchJobInstanceDetailsSummary + include Google::Apis::Core::Hashable + + # Number of instances that have acked and will start shortly. + # Corresponds to the JSON property `ackedInstanceCount` + # @return [Fixnum] + attr_accessor :acked_instance_count + + # Number of instances that are applying patches. + # Corresponds to the JSON property `applyingPatchesInstanceCount` + # @return [Fixnum] + attr_accessor :applying_patches_instance_count + + # Number of instances that are downloading patches. + # Corresponds to the JSON property `downloadingPatchesInstanceCount` + # @return [Fixnum] + attr_accessor :downloading_patches_instance_count + + # Number of instances that failed. + # Corresponds to the JSON property `failedInstanceCount` + # @return [Fixnum] + attr_accessor :failed_instance_count + + # Number of instances that are inactive. + # Corresponds to the JSON property `inactiveInstanceCount` + # @return [Fixnum] + attr_accessor :inactive_instance_count + + # Number of instances that do not appear to be running the agent. Check to + # ensure that the agent is installed, running, and able to communicate with + # the service. + # Corresponds to the JSON property `noAgentDetectedInstanceCount` + # @return [Fixnum] + attr_accessor :no_agent_detected_instance_count + + # Number of instances notified about patch job. + # Corresponds to the JSON property `notifiedInstanceCount` + # @return [Fixnum] + attr_accessor :notified_instance_count + + # Number of instances pending patch job. + # Corresponds to the JSON property `pendingInstanceCount` + # @return [Fixnum] + attr_accessor :pending_instance_count + + # Number of instances that are running the post-patch step. + # Corresponds to the JSON property `postPatchStepInstanceCount` + # @return [Fixnum] + attr_accessor :post_patch_step_instance_count + + # Number of instances that are running the pre-patch step. + # Corresponds to the JSON property `prePatchStepInstanceCount` + # @return [Fixnum] + attr_accessor :pre_patch_step_instance_count + + # Number of instances rebooting. + # Corresponds to the JSON property `rebootingInstanceCount` + # @return [Fixnum] + attr_accessor :rebooting_instance_count + + # Number of instances that have started. + # Corresponds to the JSON property `startedInstanceCount` + # @return [Fixnum] + attr_accessor :started_instance_count + + # Number of instances that have completed successfully. + # Corresponds to the JSON property `succeededInstanceCount` + # @return [Fixnum] + attr_accessor :succeeded_instance_count + + # Number of instances that require reboot. + # Corresponds to the JSON property `succeededRebootRequiredInstanceCount` + # @return [Fixnum] + attr_accessor :succeeded_reboot_required_instance_count + + # Number of instances that exceeded the time out while applying the patch. + # Corresponds to the JSON property `timedOutInstanceCount` + # @return [Fixnum] + attr_accessor :timed_out_instance_count + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @acked_instance_count = args[:acked_instance_count] if args.key?(:acked_instance_count) + @applying_patches_instance_count = args[:applying_patches_instance_count] if args.key?(:applying_patches_instance_count) + @downloading_patches_instance_count = args[:downloading_patches_instance_count] if args.key?(:downloading_patches_instance_count) + @failed_instance_count = args[:failed_instance_count] if args.key?(:failed_instance_count) + @inactive_instance_count = args[:inactive_instance_count] if args.key?(:inactive_instance_count) + @no_agent_detected_instance_count = args[:no_agent_detected_instance_count] if args.key?(:no_agent_detected_instance_count) + @notified_instance_count = args[:notified_instance_count] if args.key?(:notified_instance_count) + @pending_instance_count = args[:pending_instance_count] if args.key?(:pending_instance_count) + @post_patch_step_instance_count = args[:post_patch_step_instance_count] if args.key?(:post_patch_step_instance_count) + @pre_patch_step_instance_count = args[:pre_patch_step_instance_count] if args.key?(:pre_patch_step_instance_count) + @rebooting_instance_count = args[:rebooting_instance_count] if args.key?(:rebooting_instance_count) + @started_instance_count = args[:started_instance_count] if args.key?(:started_instance_count) + @succeeded_instance_count = args[:succeeded_instance_count] if args.key?(:succeeded_instance_count) + @succeeded_reboot_required_instance_count = args[:succeeded_reboot_required_instance_count] if args.key?(:succeeded_reboot_required_instance_count) + @timed_out_instance_count = args[:timed_out_instance_count] if args.key?(:timed_out_instance_count) + end + end + + # Sets the time for recurring patch deployments. + class RecurringSchedule + include Google::Apis::Core::Hashable + + # Optional. The end time at which a recurring patch deployment schedule is no + # longer + # active. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Required. The frequency unit of this recurring schedule. + # Corresponds to the JSON property `frequency` + # @return [String] + attr_accessor :frequency + + # Output only. The time the last patch job ran successfully. + # Corresponds to the JSON property `lastExecuteTime` + # @return [String] + attr_accessor :last_execute_time + + # Represents a monthly schedule. An example of a valid monthly schedule is + # "on the third Tuesday of the month" or "on the 15th of the month". + # Corresponds to the JSON property `monthly` + # @return [Google::Apis::OsconfigV1::MonthlySchedule] + attr_accessor :monthly + + # Output only. The time the next patch job is scheduled to run. + # Corresponds to the JSON property `nextExecuteTime` + # @return [String] + attr_accessor :next_execute_time + + # Optional. The time that the recurring schedule becomes effective. + # Defaults to `create_time` of the patch deployment. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # Represents a time of day. The date and time zone are either not significant + # or are specified elsewhere. An API may choose to allow leap seconds. Related + # types are google.type.Date and `google.protobuf.Timestamp`. + # Corresponds to the JSON property `timeOfDay` + # @return [Google::Apis::OsconfigV1::TimeOfDay] + attr_accessor :time_of_day + + # Represents a time zone from the + # [IANA Time Zone Database](https://www.iana.org/time-zones). + # Corresponds to the JSON property `timeZone` + # @return [Google::Apis::OsconfigV1::TimeZone] + attr_accessor :time_zone + + # Represents a weekly schedule. + # Corresponds to the JSON property `weekly` + # @return [Google::Apis::OsconfigV1::WeeklySchedule] + attr_accessor :weekly + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_time = args[:end_time] if args.key?(:end_time) + @frequency = args[:frequency] if args.key?(:frequency) + @last_execute_time = args[:last_execute_time] if args.key?(:last_execute_time) + @monthly = args[:monthly] if args.key?(:monthly) + @next_execute_time = args[:next_execute_time] if args.key?(:next_execute_time) + @start_time = args[:start_time] if args.key?(:start_time) + @time_of_day = args[:time_of_day] if args.key?(:time_of_day) + @time_zone = args[:time_zone] if args.key?(:time_zone) + @weekly = args[:weekly] if args.key?(:weekly) + end + end + + # Represents a time of day. The date and time zone are either not significant + # or are specified elsewhere. An API may choose to allow leap seconds. Related + # types are google.type.Date and `google.protobuf.Timestamp`. + class TimeOfDay + include Google::Apis::Core::Hashable + + # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose + # to allow the value "24:00:00" for scenarios like business closing time. + # Corresponds to the JSON property `hours` + # @return [Fixnum] + attr_accessor :hours + + # Minutes of hour of day. Must be from 0 to 59. + # Corresponds to the JSON property `minutes` + # @return [Fixnum] + attr_accessor :minutes + + # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + # Corresponds to the JSON property `nanos` + # @return [Fixnum] + attr_accessor :nanos + + # Seconds of minutes of the time. Must normally be from 0 to 59. An API may + # allow the value 60 if it allows leap-seconds. + # Corresponds to the JSON property `seconds` + # @return [Fixnum] + attr_accessor :seconds + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @hours = args[:hours] if args.key?(:hours) + @minutes = args[:minutes] if args.key?(:minutes) + @nanos = args[:nanos] if args.key?(:nanos) + @seconds = args[:seconds] if args.key?(:seconds) + end + end + + # Represents a time zone from the + # [IANA Time Zone Database](https://www.iana.org/time-zones). + class TimeZone + include Google::Apis::Core::Hashable + + # IANA Time Zone Database time zone, e.g. "America/New_York". + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Optional. IANA Time Zone Database version number, e.g. "2019a". + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @version = args[:version] if args.key?(:version) + end + end + + # Represents one week day in a month. An example is "the 4th Sunday". + class WeekDayOfMonth + include Google::Apis::Core::Hashable + + # Required. A day of the week. + # Corresponds to the JSON property `dayOfWeek` + # @return [String] + attr_accessor :day_of_week + + # Required. Week number in a month. 1-4 indicates the 1st to 4th week of the + # month. -1 + # indicates the last week of the month. + # Corresponds to the JSON property `weekOrdinal` + # @return [Fixnum] + attr_accessor :week_ordinal + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @day_of_week = args[:day_of_week] if args.key?(:day_of_week) + @week_ordinal = args[:week_ordinal] if args.key?(:week_ordinal) + end + end + + # Represents a weekly schedule. + class WeeklySchedule + include Google::Apis::Core::Hashable + + # Required. Day of the week. + # Corresponds to the JSON property `dayOfWeek` + # @return [String] + attr_accessor :day_of_week + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @day_of_week = args[:day_of_week] if args.key?(:day_of_week) + end + end + + # Windows patching is performed using the Windows Update Agent. + class WindowsUpdateSettings + include Google::Apis::Core::Hashable + + # Only apply updates of these windows update classifications. If empty, all + # updates are applied. + # Corresponds to the JSON property `classifications` + # @return [Array] + attr_accessor :classifications + + # List of KBs to exclude from update. + # Corresponds to the JSON property `excludes` + # @return [Array] + attr_accessor :excludes + + # An exclusive list of kbs to be updated. These are the only patches + # that will be updated. This field must not be used with other + # patch configurations. + # Corresponds to the JSON property `exclusivePatches` + # @return [Array] + attr_accessor :exclusive_patches + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @classifications = args[:classifications] if args.key?(:classifications) + @excludes = args[:excludes] if args.key?(:excludes) + @exclusive_patches = args[:exclusive_patches] if args.key?(:exclusive_patches) + end + end + + # Yum patching is performed by executing `yum update`. Additional options + # can be set to control how this is executed. + # Note that not all settings are supported on all platforms. + class YumSettings + include Google::Apis::Core::Hashable + + # List of packages to exclude from update. These packages are excluded by + # using the yum `--exclude` flag. + # Corresponds to the JSON property `excludes` + # @return [Array] + attr_accessor :excludes + + # An exclusive list of packages to be updated. These are the only packages + # that will be updated. If these packages are not installed, they will be + # ignored. This field must not be specified with any other patch + # configuration fields. + # Corresponds to the JSON property `exclusivePackages` + # @return [Array] + attr_accessor :exclusive_packages + + # Will cause patch to run `yum update-minimal` instead. + # Corresponds to the JSON property `minimal` + # @return [Boolean] + attr_accessor :minimal + alias_method :minimal?, :minimal + + # Adds the `--security` flag to `yum update`. Not supported on + # all platforms. + # Corresponds to the JSON property `security` + # @return [Boolean] + attr_accessor :security + alias_method :security?, :security + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @excludes = args[:excludes] if args.key?(:excludes) + @exclusive_packages = args[:exclusive_packages] if args.key?(:exclusive_packages) + @minimal = args[:minimal] if args.key?(:minimal) + @security = args[:security] if args.key?(:security) + end + end + + # Zypper patching is performed by running `zypper patch`. + # See also https://en.opensuse.org/SDB:Zypper_manual. + class ZypperSettings + include Google::Apis::Core::Hashable + + # Install only patches with these categories. + # Common categories include security, recommended, and feature. + # Corresponds to the JSON property `categories` + # @return [Array] + attr_accessor :categories + + # List of patches to exclude from update. + # Corresponds to the JSON property `excludes` + # @return [Array] + attr_accessor :excludes + + # An exclusive list of patches to be updated. These are the only patches + # that will be installed using 'zypper patch patch:' command. + # This field must not be used with any other patch configuration fields. + # Corresponds to the JSON property `exclusivePatches` + # @return [Array] + attr_accessor :exclusive_patches + + # Install only patches with these severities. + # Common severities include critical, important, moderate, and low. + # Corresponds to the JSON property `severities` + # @return [Array] + attr_accessor :severities + + # Adds the `--with-optional` flag to `zypper patch`. + # Corresponds to the JSON property `withOptional` + # @return [Boolean] + attr_accessor :with_optional + alias_method :with_optional?, :with_optional + + # Adds the `--with-update` flag, to `zypper patch`. + # Corresponds to the JSON property `withUpdate` + # @return [Boolean] + attr_accessor :with_update + alias_method :with_update?, :with_update + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @categories = args[:categories] if args.key?(:categories) + @excludes = args[:excludes] if args.key?(:excludes) + @exclusive_patches = args[:exclusive_patches] if args.key?(:exclusive_patches) + @severities = args[:severities] if args.key?(:severities) + @with_optional = args[:with_optional] if args.key?(:with_optional) + @with_update = args[:with_update] if args.key?(:with_update) + end + end + end + end +end diff --git a/generated/google/apis/osconfig_v1/representations.rb b/generated/google/apis/osconfig_v1/representations.rb new file mode 100644 index 000000000..acf8fd42c --- /dev/null +++ b/generated/google/apis/osconfig_v1/representations.rb @@ -0,0 +1,506 @@ +# Copyright 2015 Google Inc. +# +# 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 OsconfigV1 + + class AptSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CancelPatchJobRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExecStep + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExecStepConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExecutePatchJobRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GcsObject + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GooSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListPatchDeploymentsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListPatchJobInstanceDetailsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListPatchJobsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MonthlySchedule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OneTimeSchedule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PatchConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PatchDeployment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PatchInstanceFilter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PatchInstanceFilterGroupLabel + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PatchJob + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PatchJobInstanceDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PatchJobInstanceDetailsSummary + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RecurringSchedule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TimeOfDay + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TimeZone + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class WeekDayOfMonth + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class WeeklySchedule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class WindowsUpdateSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class YumSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ZypperSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AptSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :excludes, as: 'excludes' + collection :exclusive_packages, as: 'exclusivePackages' + property :type, as: 'type' + end + end + + class CancelPatchJobRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class ExecStep + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :linux_exec_step_config, as: 'linuxExecStepConfig', class: Google::Apis::OsconfigV1::ExecStepConfig, decorator: Google::Apis::OsconfigV1::ExecStepConfig::Representation + + property :windows_exec_step_config, as: 'windowsExecStepConfig', class: Google::Apis::OsconfigV1::ExecStepConfig, decorator: Google::Apis::OsconfigV1::ExecStepConfig::Representation + + end + end + + class ExecStepConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :allowed_success_codes, as: 'allowedSuccessCodes' + property :gcs_object, as: 'gcsObject', class: Google::Apis::OsconfigV1::GcsObject, decorator: Google::Apis::OsconfigV1::GcsObject::Representation + + property :interpreter, as: 'interpreter' + property :local_path, as: 'localPath' + end + end + + class ExecutePatchJobRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + property :dry_run, as: 'dryRun' + property :duration, as: 'duration' + property :instance_filter, as: 'instanceFilter', class: Google::Apis::OsconfigV1::PatchInstanceFilter, decorator: Google::Apis::OsconfigV1::PatchInstanceFilter::Representation + + property :patch_config, as: 'patchConfig', class: Google::Apis::OsconfigV1::PatchConfig, decorator: Google::Apis::OsconfigV1::PatchConfig::Representation + + end + end + + class GcsObject + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bucket, as: 'bucket' + property :generation_number, :numeric_string => true, as: 'generationNumber' + property :object, as: 'object' + end + end + + class GooSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class ListPatchDeploymentsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :patch_deployments, as: 'patchDeployments', class: Google::Apis::OsconfigV1::PatchDeployment, decorator: Google::Apis::OsconfigV1::PatchDeployment::Representation + + end + end + + class ListPatchJobInstanceDetailsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :patch_job_instance_details, as: 'patchJobInstanceDetails', class: Google::Apis::OsconfigV1::PatchJobInstanceDetails, decorator: Google::Apis::OsconfigV1::PatchJobInstanceDetails::Representation + + end + end + + class ListPatchJobsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :patch_jobs, as: 'patchJobs', class: Google::Apis::OsconfigV1::PatchJob, decorator: Google::Apis::OsconfigV1::PatchJob::Representation + + end + end + + class MonthlySchedule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :month_day, as: 'monthDay' + property :week_day_of_month, as: 'weekDayOfMonth', class: Google::Apis::OsconfigV1::WeekDayOfMonth, decorator: Google::Apis::OsconfigV1::WeekDayOfMonth::Representation + + end + end + + class OneTimeSchedule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :execute_time, as: 'executeTime' + end + end + + class PatchConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :apt, as: 'apt', class: Google::Apis::OsconfigV1::AptSettings, decorator: Google::Apis::OsconfigV1::AptSettings::Representation + + property :goo, as: 'goo', class: Google::Apis::OsconfigV1::GooSettings, decorator: Google::Apis::OsconfigV1::GooSettings::Representation + + property :post_step, as: 'postStep', class: Google::Apis::OsconfigV1::ExecStep, decorator: Google::Apis::OsconfigV1::ExecStep::Representation + + property :pre_step, as: 'preStep', class: Google::Apis::OsconfigV1::ExecStep, decorator: Google::Apis::OsconfigV1::ExecStep::Representation + + property :reboot_config, as: 'rebootConfig' + property :windows_update, as: 'windowsUpdate', class: Google::Apis::OsconfigV1::WindowsUpdateSettings, decorator: Google::Apis::OsconfigV1::WindowsUpdateSettings::Representation + + property :yum, as: 'yum', class: Google::Apis::OsconfigV1::YumSettings, decorator: Google::Apis::OsconfigV1::YumSettings::Representation + + property :zypper, as: 'zypper', class: Google::Apis::OsconfigV1::ZypperSettings, decorator: Google::Apis::OsconfigV1::ZypperSettings::Representation + + end + end + + class PatchDeployment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :description, as: 'description' + property :duration, as: 'duration' + property :instance_filter, as: 'instanceFilter', class: Google::Apis::OsconfigV1::PatchInstanceFilter, decorator: Google::Apis::OsconfigV1::PatchInstanceFilter::Representation + + property :last_execute_time, as: 'lastExecuteTime' + property :name, as: 'name' + property :one_time_schedule, as: 'oneTimeSchedule', class: Google::Apis::OsconfigV1::OneTimeSchedule, decorator: Google::Apis::OsconfigV1::OneTimeSchedule::Representation + + property :patch_config, as: 'patchConfig', class: Google::Apis::OsconfigV1::PatchConfig, decorator: Google::Apis::OsconfigV1::PatchConfig::Representation + + property :recurring_schedule, as: 'recurringSchedule', class: Google::Apis::OsconfigV1::RecurringSchedule, decorator: Google::Apis::OsconfigV1::RecurringSchedule::Representation + + property :update_time, as: 'updateTime' + end + end + + class PatchInstanceFilter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :all, as: 'all' + collection :group_labels, as: 'groupLabels', class: Google::Apis::OsconfigV1::PatchInstanceFilterGroupLabel, decorator: Google::Apis::OsconfigV1::PatchInstanceFilterGroupLabel::Representation + + collection :instance_name_prefixes, as: 'instanceNamePrefixes' + collection :instances, as: 'instances' + collection :zones, as: 'zones' + end + end + + class PatchInstanceFilterGroupLabel + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :labels, as: 'labels' + end + end + + class PatchJob + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :description, as: 'description' + property :display_name, as: 'displayName' + property :dry_run, as: 'dryRun' + property :duration, as: 'duration' + property :error_message, as: 'errorMessage' + property :instance_details_summary, as: 'instanceDetailsSummary', class: Google::Apis::OsconfigV1::PatchJobInstanceDetailsSummary, decorator: Google::Apis::OsconfigV1::PatchJobInstanceDetailsSummary::Representation + + property :instance_filter, as: 'instanceFilter', class: Google::Apis::OsconfigV1::PatchInstanceFilter, decorator: Google::Apis::OsconfigV1::PatchInstanceFilter::Representation + + property :name, as: 'name' + property :patch_config, as: 'patchConfig', class: Google::Apis::OsconfigV1::PatchConfig, decorator: Google::Apis::OsconfigV1::PatchConfig::Representation + + property :patch_deployment, as: 'patchDeployment' + property :percent_complete, as: 'percentComplete' + property :state, as: 'state' + property :update_time, as: 'updateTime' + end + end + + class PatchJobInstanceDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :attempt_count, :numeric_string => true, as: 'attemptCount' + property :failure_reason, as: 'failureReason' + property :instance_system_id, as: 'instanceSystemId' + property :name, as: 'name' + property :state, as: 'state' + end + end + + class PatchJobInstanceDetailsSummary + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :acked_instance_count, :numeric_string => true, as: 'ackedInstanceCount' + property :applying_patches_instance_count, :numeric_string => true, as: 'applyingPatchesInstanceCount' + property :downloading_patches_instance_count, :numeric_string => true, as: 'downloadingPatchesInstanceCount' + property :failed_instance_count, :numeric_string => true, as: 'failedInstanceCount' + property :inactive_instance_count, :numeric_string => true, as: 'inactiveInstanceCount' + property :no_agent_detected_instance_count, :numeric_string => true, as: 'noAgentDetectedInstanceCount' + property :notified_instance_count, :numeric_string => true, as: 'notifiedInstanceCount' + property :pending_instance_count, :numeric_string => true, as: 'pendingInstanceCount' + property :post_patch_step_instance_count, :numeric_string => true, as: 'postPatchStepInstanceCount' + property :pre_patch_step_instance_count, :numeric_string => true, as: 'prePatchStepInstanceCount' + property :rebooting_instance_count, :numeric_string => true, as: 'rebootingInstanceCount' + property :started_instance_count, :numeric_string => true, as: 'startedInstanceCount' + property :succeeded_instance_count, :numeric_string => true, as: 'succeededInstanceCount' + property :succeeded_reboot_required_instance_count, :numeric_string => true, as: 'succeededRebootRequiredInstanceCount' + property :timed_out_instance_count, :numeric_string => true, as: 'timedOutInstanceCount' + end + end + + class RecurringSchedule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_time, as: 'endTime' + property :frequency, as: 'frequency' + property :last_execute_time, as: 'lastExecuteTime' + property :monthly, as: 'monthly', class: Google::Apis::OsconfigV1::MonthlySchedule, decorator: Google::Apis::OsconfigV1::MonthlySchedule::Representation + + property :next_execute_time, as: 'nextExecuteTime' + property :start_time, as: 'startTime' + property :time_of_day, as: 'timeOfDay', class: Google::Apis::OsconfigV1::TimeOfDay, decorator: Google::Apis::OsconfigV1::TimeOfDay::Representation + + property :time_zone, as: 'timeZone', class: Google::Apis::OsconfigV1::TimeZone, decorator: Google::Apis::OsconfigV1::TimeZone::Representation + + property :weekly, as: 'weekly', class: Google::Apis::OsconfigV1::WeeklySchedule, decorator: Google::Apis::OsconfigV1::WeeklySchedule::Representation + + end + end + + class TimeOfDay + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :hours, as: 'hours' + property :minutes, as: 'minutes' + property :nanos, as: 'nanos' + property :seconds, as: 'seconds' + end + end + + class TimeZone + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :version, as: 'version' + end + end + + class WeekDayOfMonth + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :day_of_week, as: 'dayOfWeek' + property :week_ordinal, as: 'weekOrdinal' + end + end + + class WeeklySchedule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :day_of_week, as: 'dayOfWeek' + end + end + + class WindowsUpdateSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :classifications, as: 'classifications' + collection :excludes, as: 'excludes' + collection :exclusive_patches, as: 'exclusivePatches' + end + end + + class YumSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :excludes, as: 'excludes' + collection :exclusive_packages, as: 'exclusivePackages' + property :minimal, as: 'minimal' + property :security, as: 'security' + end + end + + class ZypperSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :categories, as: 'categories' + collection :excludes, as: 'excludes' + collection :exclusive_patches, as: 'exclusivePatches' + collection :severities, as: 'severities' + property :with_optional, as: 'withOptional' + property :with_update, as: 'withUpdate' + end + end + end + end +end diff --git a/generated/google/apis/osconfig_v1/service.rb b/generated/google/apis/osconfig_v1/service.rb new file mode 100644 index 000000000..c0acbd1d8 --- /dev/null +++ b/generated/google/apis/osconfig_v1/service.rb @@ -0,0 +1,386 @@ +# Copyright 2015 Google Inc. +# +# 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 '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 OsconfigV1 + # Cloud OS Config API + # + # OS management tools that can be used for patch management, patch compliance, + # and configuration management on VM instances. + # + # @example + # require 'google/apis/osconfig_v1' + # + # Osconfig = Google::Apis::OsconfigV1 # Alias the module + # service = Osconfig::SystemsManagementService.new + # + # @see https://cloud.google.com/ + class SystemsManagementService < Google::Apis::Core::BaseService + # @return [String] + # API key. Your API key identifies your project and provides you with API access, + # quota, and reports. Required unless you provide an OAuth 2.0 token. + attr_accessor :key + + # @return [String] + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + attr_accessor :quota_user + + def initialize + super('https://osconfig.googleapis.com/', '') + @batch_path = 'batch' + end + + # Create an OS Config patch deployment. + # @param [String] parent + # Required. The project to apply this patch deployment to in the form `projects/* + # `. + # @param [Google::Apis::OsconfigV1::PatchDeployment] patch_deployment_object + # @param [String] patch_deployment_id + # Required. A name for the patch deployment in the project. When creating a name + # the following rules apply: + # * Must contain only lowercase letters, numbers, and hyphens. + # * Must start with a letter. + # * Must be between 1-63 characters. + # * Must end with a number or a letter. + # * Must be unique within the project. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::OsconfigV1::PatchDeployment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::OsconfigV1::PatchDeployment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_patch_deployment(parent, patch_deployment_object = nil, patch_deployment_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/patchDeployments', options) + command.request_representation = Google::Apis::OsconfigV1::PatchDeployment::Representation + command.request_object = patch_deployment_object + command.response_representation = Google::Apis::OsconfigV1::PatchDeployment::Representation + command.response_class = Google::Apis::OsconfigV1::PatchDeployment + command.params['parent'] = parent unless parent.nil? + command.query['patchDeploymentId'] = patch_deployment_id unless patch_deployment_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Delete an OS Config patch deployment. + # @param [String] name + # Required. The resource name of the patch deployment in the form + # `projects/*/patchDeployments/*`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::OsconfigV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::OsconfigV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_patch_deployment(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::OsconfigV1::Empty::Representation + command.response_class = Google::Apis::OsconfigV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Get an OS Config patch deployment. + # @param [String] name + # Required. The resource name of the patch deployment in the form + # `projects/*/patchDeployments/*`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::OsconfigV1::PatchDeployment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::OsconfigV1::PatchDeployment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_patch_deployment(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::OsconfigV1::PatchDeployment::Representation + command.response_class = Google::Apis::OsconfigV1::PatchDeployment + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Get a page of OS Config patch deployments. + # @param [String] parent + # Required. The resource name of the parent in the form `projects/*`. + # @param [Fixnum] page_size + # Optional. The maximum number of patch deployments to return. Default is 100. + # @param [String] page_token + # Optional. A pagination token returned from a previous call to + # ListPatchDeployments + # that indicates where this listing should continue from. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::OsconfigV1::ListPatchDeploymentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::OsconfigV1::ListPatchDeploymentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_patch_deployments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/patchDeployments', options) + command.response_representation = Google::Apis::OsconfigV1::ListPatchDeploymentsResponse::Representation + command.response_class = Google::Apis::OsconfigV1::ListPatchDeploymentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Cancel a patch job. The patch job must be active. Canceled patch jobs + # cannot be restarted. + # @param [String] name + # Required. Name of the patch in the form `projects/*/patchJobs/*` + # @param [Google::Apis::OsconfigV1::CancelPatchJobRequest] cancel_patch_job_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::OsconfigV1::PatchJob] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::OsconfigV1::PatchJob] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def cancel_patch_job(name, cancel_patch_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:cancel', options) + command.request_representation = Google::Apis::OsconfigV1::CancelPatchJobRequest::Representation + command.request_object = cancel_patch_job_request_object + command.response_representation = Google::Apis::OsconfigV1::PatchJob::Representation + command.response_class = Google::Apis::OsconfigV1::PatchJob + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Patch VM instances by creating and running a patch job. + # @param [String] parent + # Required. The project in which to run this patch in the form `projects/*` + # @param [Google::Apis::OsconfigV1::ExecutePatchJobRequest] execute_patch_job_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::OsconfigV1::PatchJob] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::OsconfigV1::PatchJob] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def execute_patch_job(parent, execute_patch_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/patchJobs:execute', options) + command.request_representation = Google::Apis::OsconfigV1::ExecutePatchJobRequest::Representation + command.request_object = execute_patch_job_request_object + command.response_representation = Google::Apis::OsconfigV1::PatchJob::Representation + command.response_class = Google::Apis::OsconfigV1::PatchJob + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Get the patch job. This can be used to track the progress of an + # ongoing patch job or review the details of completed jobs. + # @param [String] name + # Required. Name of the patch in the form `projects/*/patchJobs/*` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::OsconfigV1::PatchJob] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::OsconfigV1::PatchJob] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_patch_job(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::OsconfigV1::PatchJob::Representation + command.response_class = Google::Apis::OsconfigV1::PatchJob + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Get a list of patch jobs. + # @param [String] parent + # Required. In the form of `projects/*` + # @param [String] filter + # If provided, this field specifies the criteria that must be met by patch + # jobs to be included in the response. + # Currently, filtering is only available on the patch_deployment field. + # @param [Fixnum] page_size + # The maximum number of instance status to return. + # @param [String] page_token + # A pagination token returned from a previous call + # that indicates where this listing should continue from. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::OsconfigV1::ListPatchJobsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::OsconfigV1::ListPatchJobsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_patch_jobs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/patchJobs', options) + command.response_representation = Google::Apis::OsconfigV1::ListPatchJobsResponse::Representation + command.response_class = Google::Apis::OsconfigV1::ListPatchJobsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Get a list of instance details for a given patch job. + # @param [String] parent + # Required. The parent for the instances are in the form of `projects/*/ + # patchJobs/*`. + # @param [String] filter + # A filter expression that filters results listed in the response. This + # field supports filtering results by instance zone, name, state, or + # `failure_reason`. + # @param [Fixnum] page_size + # The maximum number of instance details records to return. Default is 100. + # @param [String] page_token + # A pagination token returned from a previous call + # that indicates where this listing should continue from. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::OsconfigV1::ListPatchJobInstanceDetailsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::OsconfigV1::ListPatchJobInstanceDetailsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_patch_job_instance_details(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/instanceDetails', options) + command.response_representation = Google::Apis::OsconfigV1::ListPatchJobInstanceDetailsResponse::Representation + command.response_class = Google::Apis::OsconfigV1::ListPatchJobInstanceDetailsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/osconfig_v1beta.rb b/generated/google/apis/osconfig_v1beta.rb index b6e99204a..de8b01ea1 100644 --- a/generated/google/apis/osconfig_v1beta.rb +++ b/generated/google/apis/osconfig_v1beta.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/ module OsconfigV1beta VERSION = 'V1beta' - REVISION = '20200226' + REVISION = '20200403' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/osconfig_v1beta/classes.rb b/generated/google/apis/osconfig_v1beta/classes.rb index 8c96fea37..06e18f66f 100644 --- a/generated/google/apis/osconfig_v1beta/classes.rb +++ b/generated/google/apis/osconfig_v1beta/classes.rb @@ -1032,7 +1032,9 @@ module Google # Patch deployments are configurations that individual patch jobs use to # complete a patch. These configurations include instance filter, package - # repository settings, and a schedule. + # repository settings, and a schedule. For more information about creating and + # managing patch deployments, see [Scheduling patch + # jobs](/compute/docs/os-patch-management/schedule-patch-jobs). class PatchDeployment include Google::Apis::Core::Hashable @@ -1204,6 +1206,8 @@ module Google # or has completed. # Instances details are not included in the job. To paginate through instance # details, use ListPatchJobInstanceDetails. + # For more information about patch jobs, see + # [Creating patch jobs](/compute/docs/os-patch-management/create-patch-job). class PatchJob include Google::Apis::Core::Hashable @@ -1314,7 +1318,11 @@ module Google end end - # Patch details for a VM instance. + # Patch details for a VM instance. For more information about reviewing VM + # instance details, see + # [Listing all VM instance details for a specific patch + # job](/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details) + # . class PatchJobInstanceDetails include Google::Apis::Core::Hashable diff --git a/generated/google/apis/people_v1.rb b/generated/google/apis/people_v1.rb index 4c8efb023..d8e5a8686 100644 --- a/generated/google/apis/people_v1.rb +++ b/generated/google/apis/people_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/people/ module PeopleV1 VERSION = 'V1' - REVISION = '20200215' + REVISION = '20200407' # See, edit, download, and permanently delete your contacts AUTH_CONTACTS = 'https://www.googleapis.com/auth/contacts' diff --git a/generated/google/apis/people_v1/classes.rb b/generated/google/apis/people_v1/classes.rb index e22d38c8f..77cd69c40 100644 --- a/generated/google/apis/people_v1/classes.rb +++ b/generated/google/apis/people_v1/classes.rb @@ -230,6 +230,7 @@ module Google end end + # **DEPRECATED**: No data will be returned # A person's bragging rights. class BraggingRights include Google::Apis::Core::Hashable @@ -716,8 +717,19 @@ module Google class Gender include Google::Apis::Core::Hashable + # The type of pronouns that should be used to address the person. The value + # can be custom or one of these predefined values: + # * `male` + # * `female` + # * `other` + # Corresponds to the JSON property `addressMeAs` + # @return [String] + attr_accessor :address_me_as + # Output only. The value of the gender translated and formatted in the viewer's - # account locale or the `Accept-Language` HTTP header locale. + # account + # locale or the `Accept-Language` HTTP header locale. Unspecified or custom + # value are not localized. # Corresponds to the JSON property `formattedValue` # @return [String] attr_accessor :formatted_value @@ -731,8 +743,7 @@ module Google # predefined values: # * `male` # * `female` - # * `other` - # * `unknown` + # * `unspecified` # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -743,6 +754,7 @@ module Google # Update properties of this object def update!(**args) + @address_me_as = args[:address_me_as] if args.key?(:address_me_as) @formatted_value = args[:formatted_value] if args.key?(:formatted_value) @metadata = args[:metadata] if args.key?(:metadata) @value = args[:value] if args.key?(:value) @@ -867,12 +879,15 @@ module Google # @return [Array] attr_accessor :connections - # The token that can be used to retrieve the next page of results. + # A token, which can be sent as `page_token` to retrieve the next page. + # If this field is omitted, there are no subsequent pages. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The token that can be used to retrieve changes since the last request. + # A token, which can be sent as `sync_token` to retrieve changes since the + # last request. Request must set `request_sync_token` to return the sync + # token. # Corresponds to the JSON property `nextSyncToken` # @return [String] attr_accessor :next_sync_token @@ -1363,6 +1378,7 @@ module Google # @return [Array] attr_accessor :birthdays + # **DEPRECATED**: No data will be returned # The person's bragging rights. # Corresponds to the JSON property `braggingRights` # @return [Array] @@ -1454,12 +1470,14 @@ module Google # @return [Array] attr_accessor :relations - # Output only. The person's relationship interests. + # Output only. **DEPRECATED**: No data will be returned + # The person's relationship interests. # Corresponds to the JSON property `relationshipInterests` # @return [Array] attr_accessor :relationship_interests - # Output only. The person's relationship statuses. + # Output only. **DEPRECATED**: No data will be returned + # The person's relationship statuses. # Corresponds to the JSON property `relationshipStatuses` # @return [Array] attr_accessor :relationship_statuses @@ -1486,7 +1504,8 @@ module Google # @return [Array] attr_accessor :skills - # Output only. The person's taglines. + # Output only. **DEPRECATED**: No data will be returned + # The person's taglines. # Corresponds to the JSON property `taglines` # @return [Array] attr_accessor :taglines @@ -1822,6 +1841,7 @@ module Google end end + # **DEPRECATED**: No data will be returned # A person's relationship interest . class RelationshipInterest include Google::Apis::Core::Hashable @@ -1860,6 +1880,7 @@ module Google end end + # **DEPRECATED**: No data will be returned # A person's relationship status. class RelationshipStatus include Google::Apis::Core::Hashable @@ -2091,6 +2112,7 @@ module Google end end + # **DEPRECATED**: No data will be returned # A brief one-line description of the person. class Tagline include Google::Apis::Core::Hashable @@ -2149,7 +2171,6 @@ module Google # * ageRanges # * biographies # * birthdays - # * braggingRights # * coverPhotos # * emailAddresses # * events @@ -2166,12 +2187,9 @@ module Google # * phoneNumbers # * photos # * relations - # * relationshipInterests - # * relationshipStatuses # * residences # * sipAddresses # * skills - # * taglines # * urls # * userDefined # Corresponds to the JSON property `personFields` diff --git a/generated/google/apis/people_v1/representations.rb b/generated/google/apis/people_v1/representations.rb index 4acfc29d4..0d0666b93 100644 --- a/generated/google/apis/people_v1/representations.rb +++ b/generated/google/apis/people_v1/representations.rb @@ -533,6 +533,7 @@ module Google class Gender # @private class Representation < Google::Apis::Core::JsonRepresentation + property :address_me_as, as: 'addressMeAs' property :formatted_value, as: 'formattedValue' property :metadata, as: 'metadata', class: Google::Apis::PeopleV1::FieldMetadata, decorator: Google::Apis::PeopleV1::FieldMetadata::Representation diff --git a/generated/google/apis/people_v1/service.rb b/generated/google/apis/people_v1/service.rb index cd0d7171a..08563346a 100644 --- a/generated/google/apis/people_v1/service.rb +++ b/generated/google/apis/people_v1/service.rb @@ -368,7 +368,6 @@ module Google # * ageRanges # * biographies # * birthdays - # * braggingRights # * coverPhotos # * emailAddresses # * events @@ -385,12 +384,9 @@ module Google # * phoneNumbers # * photos # * relations - # * relationshipInterests - # * relationshipStatuses # * residences # * sipAddresses # * skills - # * taglines # * urls # * userDefined # @param [String] fields @@ -440,7 +436,6 @@ module Google # * ageRanges # * biographies # * birthdays - # * braggingRights # * coverPhotos # * emailAddresses # * events @@ -457,12 +452,9 @@ module Google # * phoneNumbers # * photos # * relations - # * relationshipInterests - # * relationshipStatuses # * residences # * sipAddresses # * skills - # * taglines # * urls # * userDefined # @param [String] request_mask_include_field @@ -511,7 +503,6 @@ module Google # * ageRanges # * biographies # * birthdays - # * braggingRights # * coverPhotos # * emailAddresses # * events @@ -528,12 +519,9 @@ module Google # * phoneNumbers # * photos # * relations - # * relationshipInterests - # * relationshipStatuses # * residences # * sipAddresses # * skills - # * taglines # * urls # * userDefined # @param [String] request_mask_include_field @@ -693,7 +681,10 @@ module Google # are # between 1 and 2000, inclusive. Defaults to 100 if not set or set to 0. # @param [String] page_token - # Optional. The token of the page to be returned. + # Optional. A page token, received from a previous `ListConnections` call. + # Provide this to retrieve the subsequent page. + # When paginating, all other parameters provided to `ListConnections` + # must match the call that provided the page token. # @param [String] person_fields # Required. A field mask to restrict which fields on each person are returned. # Multiple @@ -702,7 +693,6 @@ module Google # * ageRanges # * biographies # * birthdays - # * braggingRights # * coverPhotos # * emailAddresses # * events @@ -719,12 +709,9 @@ module Google # * phoneNumbers # * photos # * relations - # * relationshipInterests - # * relationshipStatuses # * residences # * sipAddresses # * skills - # * taglines # * urls # * userDefined # @param [String] request_mask_include_field @@ -733,19 +720,20 @@ module Google # path should start with `person.`: for example, `person.names` or # `person.photos`. # @param [Boolean] request_sync_token - # Optional. Whether the response should include a sync token, which can be used - # to get - # all changes since the last request. For subsequent sync requests use the - # `sync_token` param instead. Initial sync requests that specify + # Optional. Whether the response should include `next_sync_token`, which can be + # used to + # get all changes since the last request. For subsequent sync requests use + # the `sync_token` param instead. Initial sync requests that specify # `request_sync_token` have an additional rate limit. # @param [String] sort_order # Optional. The order in which the connections should be sorted. Defaults to # `LAST_MODIFIED_ASCENDING`. # @param [String] sync_token - # Optional. A sync token returned by a previous call to `people.connections.list` - # . - # Only resources changed since the sync token was created will be returned. + # Optional. A sync token, received from a previous `ListConnections` call. + # Provide this to retrieve only the resources changed since the last request. # Sync requests that specify `sync_token` have an additional rate limit. + # When syncing, all other parameters provided to `ListConnections` + # must match the call that provided the sync token. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/prod_tt_sasportal_v1alpha1.rb b/generated/google/apis/prod_tt_sasportal_v1alpha1.rb index f9b3aa8b5..ea2625e7c 100644 --- a/generated/google/apis/prod_tt_sasportal_v1alpha1.rb +++ b/generated/google/apis/prod_tt_sasportal_v1alpha1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/spectrum-access-system/ module ProdTtSasportalV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200219' + REVISION = '20200405' # View your email address AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' diff --git a/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb b/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb index 7a3100c41..bd2663d81 100644 --- a/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb +++ b/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb @@ -96,7 +96,7 @@ module Google include Google::Apis::Core::Hashable # Required. JSON Web Token signed using a CPI private key. Payload - # must be the JSON encoding of the [Device]. + # must be the JSON encoding of the [Device]. The user_id field must be set. # Corresponds to the JSON property `encodedDevice` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -291,7 +291,7 @@ module Google # @return [String] attr_accessor :update_time - # Output only. The identifier of a device user. + # The identifier of a device user. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id @@ -946,6 +946,7 @@ module Google # Required. The device to sign. # The device fields name, fcc_id and serial_number must be set. + # The user_id field must be set. # Corresponds to the JSON property `device` # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] attr_accessor :device @@ -1049,7 +1050,7 @@ module Google # Required. The JSON Web Token signed using a CPI private key. Payload # must be the JSON encoding - # of the device. + # of the device. The user_id field must be set. # Corresponds to the JSON property `encodedDevice` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] diff --git a/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb b/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb index b0ff83a38..d6a857f10 100644 --- a/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb +++ b/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb @@ -686,6 +686,76 @@ module Google execute_or_queue_command(command, &block) end + # Creates a new node. + # @param [String] parent + # Required. The parent resource name where the node is to be created. + # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalNode] sas_portal_node_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalNode] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalNode] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_customer_node_node(parent, sas_portal_node_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+parent}/nodes', options) + command.request_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalNode::Representation + command.request_object = sas_portal_node_object + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalNode::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalNode + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists nodes. + # @param [String] parent + # Required. The parent resource name, for example, "nodes/1". + # @param [Fixnum] page_size + # The maximum number of nodes to return in the response. + # @param [String] page_token + # A pagination token returned from a previous call to ListNodes method + # that indicates where this listing should continue from. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalListNodesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalListNodesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_customer_node_nodes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+parent}/nodes', options) + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalListNodesResponse::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalListNodesResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Generates a secret to be used with the ValidateInstaller method # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalGenerateSecretRequest] sas_portal_generate_secret_request_object # @param [String] fields @@ -1283,6 +1353,218 @@ module Google execute_or_queue_command(command, &block) end + # Creates a device under a node or customer. Returned devices are unordered. + # @param [String] parent + # Required. The name of the parent resource. + # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalBulkCreateDeviceRequest] sas_portal_bulk_create_device_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalBulkCreateDeviceResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalBulkCreateDeviceResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def bulk_node_node_device(parent, sas_portal_bulk_create_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+parent}/devices:bulk', options) + command.request_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalBulkCreateDeviceRequest::Representation + command.request_object = sas_portal_bulk_create_device_request_object + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalBulkCreateDeviceResponse::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalBulkCreateDeviceResponse + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a device under a node or customer. + # @param [String] parent + # Required. The name of the parent resource. + # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] sas_portal_device_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_node_node_device(parent, sas_portal_device_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+parent}/devices', options) + command.request_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice::Representation + command.request_object = sas_portal_device_object + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a signed device under a + # node or customer. + # @param [String] parent + # Required. The name of the parent resource. + # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_node_node_device_signed(parent, sas_portal_create_signed_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+parent}/devices:createSigned', options) + command.request_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalCreateSignedDeviceRequest::Representation + command.request_object = sas_portal_create_signed_device_request_object + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists devices under a node or customer. + # @param [String] parent + # Required. The name of the parent resource. + # @param [String] filter + # The filter expression. The filter should have one of the following + # formats: "sn=123454" or "display_name=MyDevice". sn + # corresponds to serial_number of the device. The filter is case insensitive. + # @param [Fixnum] page_size + # The maximum number of devices to return in the response. + # @param [String] page_token + # A pagination token returned from a previous call to ListDevices + # that indicates where this listing should continue from. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalListDevicesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalListDevicesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_node_node_devices(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+parent}/devices', options) + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalListDevicesResponse::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalListDevicesResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new node. + # @param [String] parent + # Required. The parent resource name where the node is to be created. + # @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalNode] sas_portal_node_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalNode] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalNode] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_node_node_node(parent, sas_portal_node_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+parent}/nodes', options) + command.request_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalNode::Representation + command.request_object = sas_portal_node_object + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalNode::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalNode + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists nodes. + # @param [String] parent + # Required. The parent resource name, for example, "nodes/1". + # @param [Fixnum] page_size + # The maximum number of nodes to return in the response. + # @param [String] page_token + # A pagination token returned from a previous call to ListNodes method + # that indicates where this listing should continue from. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ProdTtSasportalV1alpha1::SasPortalListNodesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalListNodesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_node_node_nodes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+parent}/nodes', options) + command.response_representation = Google::Apis::ProdTtSasportalV1alpha1::SasPortalListNodesResponse::Representation + command.response_class = Google::Apis::ProdTtSasportalV1alpha1::SasPortalListNodesResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Gets the access control policy for a resource. # Returns an empty policy if the resource exists and does not have a policy # set. diff --git a/generated/google/apis/proximitybeacon_v1beta1/classes.rb b/generated/google/apis/proximitybeacon_v1beta1/classes.rb deleted file mode 100644 index 421cf4902..000000000 --- a/generated/google/apis/proximitybeacon_v1beta1/classes.rb +++ /dev/null @@ -1,845 +0,0 @@ -# Copyright 2015 Google Inc. -# -# 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 ProximitybeaconV1beta1 - - # Defines a unique identifier of a beacon as broadcast by the device. - class AdvertisedId - include Google::Apis::Core::Hashable - - # The actual beacon identifier, as broadcast by the beacon hardware. Must be - # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP - # requests, and will be so encoded (with padding) in responses. The base64 - # encoding should be of the binary byte-stream and not any textual (such as - # hex) representation thereof. - # Required. - # Corresponds to the JSON property `id` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :id - - # Specifies the identifier type. - # Required. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @id = args[:id] if args.key?(:id) - @type = args[:type] if args.key?(:type) - end - end - - # A subset of attachment information served via the - # `beaconinfo.getforobserved` method, used when your users encounter your - # beacons. - class AttachmentInfo - include Google::Apis::Core::Hashable - - # An opaque data container for client-provided data. - # Corresponds to the JSON property `data` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :data - - # The distance away from the beacon at which this attachment should be - # delivered to a mobile app. - # Setting this to a value greater than zero indicates that the app should - # behave as if the beacon is "seen" when the mobile device is less than this - # distance away from the beacon. - # Different attachments on the same beacon can have different max distances. - # Note that even though this value is expressed with fractional meter - # precision, real-world behavior is likley to be much less precise than one - # meter, due to the nature of current Bluetooth radio technology. - # Optional. When not set or zero, the attachment should be delivered at the - # beacon's outer limit of detection. - # Corresponds to the JSON property `maxDistanceMeters` - # @return [Float] - attr_accessor :max_distance_meters - - # Specifies what kind of attachment this is. Tells a client how to - # interpret the `data` field. Format is namespace/type, for - # example scrupulous-wombat-12345/welcome-message - # Corresponds to the JSON property `namespacedType` - # @return [String] - attr_accessor :namespaced_type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @data = args[:data] if args.key?(:data) - @max_distance_meters = args[:max_distance_meters] if args.key?(:max_distance_meters) - @namespaced_type = args[:namespaced_type] if args.key?(:namespaced_type) - end - end - - # Details of a beacon device. - class Beacon - include Google::Apis::Core::Hashable - - # Defines a unique identifier of a beacon as broadcast by the device. - # Corresponds to the JSON property `advertisedId` - # @return [Google::Apis::ProximitybeaconV1beta1::AdvertisedId] - attr_accessor :advertised_id - - # Resource name of this beacon. A beacon name has the format - # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by - # the beacon and N is a code for the beacon's type. Possible values are - # `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. - # This field must be left empty when registering. After reading a beacon, - # clients can use the name for future operations. - # Corresponds to the JSON property `beaconName` - # @return [String] - attr_accessor :beacon_name - - # Free text used to identify and describe the beacon. Maximum length 140 - # characters. - # Optional. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # Write-only registration parameters for beacons using Eddystone-EID format. - # Two ways of securely registering an Eddystone-EID beacon with the service - # are supported: - # 1. Perform an ECDH key exchange via this API, including a previous call - # to `GET /v1beta1/eidparams`. In this case the fields - # `beacon_ecdh_public_key` and `service_ecdh_public_key` should be - # populated and `beacon_identity_key` should not be populated. This - # method ensures that only the two parties in the ECDH key exchange can - # compute the identity key, which becomes a secret between them. - # 2. Derive or obtain the beacon's identity key via other secure means - # (perhaps an ECDH key exchange between the beacon and a mobile device - # or any other secure method), and then submit the resulting identity key - # to the service. In this case `beacon_identity_key` field should be - # populated, and neither of `beacon_ecdh_public_key` nor - # `service_ecdh_public_key` fields should be. The security of this method - # depends on how securely the parties involved (in particular the - # bluetooth client) handle the identity key, and obviously on how - # securely the identity key was generated. - # See [the Eddystone - # specification](https://github.com/google/eddystone/tree/master/eddystone-eid) - # at GitHub. - # Corresponds to the JSON property `ephemeralIdRegistration` - # @return [Google::Apis::ProximitybeaconV1beta1::EphemeralIdRegistration] - attr_accessor :ephemeral_id_registration - - # Expected location stability. This is set when the beacon is registered or - # updated, not automatically detected in any way. - # Optional. - # Corresponds to the JSON property `expectedStability` - # @return [String] - attr_accessor :expected_stability - - # Indoor level, a human-readable string as returned by Google Maps APIs, - # useful to indicate which floor of a building a beacon is located on. - # Corresponds to the JSON property `indoorLevel` - # @return [Google::Apis::ProximitybeaconV1beta1::IndoorLevel] - attr_accessor :indoor_level - - # An object representing a latitude/longitude pair. This is expressed as a pair - # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. - # Corresponds to the JSON property `latLng` - # @return [Google::Apis::ProximitybeaconV1beta1::LatLng] - attr_accessor :lat_lng - - # The [Google Places API](/places/place-id) Place ID of the place where - # the beacon is deployed. This is given when the beacon is registered or - # updated, not automatically detected in any way. - # Optional. - # Corresponds to the JSON property `placeId` - # @return [String] - attr_accessor :place_id - - # Properties of the beacon device, for example battery type or firmware - # version. - # Optional. - # Corresponds to the JSON property `properties` - # @return [Hash] - attr_accessor :properties - - # Some beacons may require a user to provide an authorization key before - # changing any of its configuration (e.g. broadcast frames, transmit power). - # This field provides a place to store and control access to that key. - # This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` - # from users with write access to the given beacon. That is to say: If the - # user is authorized to write the beacon's confidential data in the service, - # the service considers them authorized to configure the beacon. Note - # that this key grants nothing on the service, only on the beacon itself. - # Corresponds to the JSON property `provisioningKey` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :provisioning_key - - # Current status of the beacon. - # Required. - # Corresponds to the JSON property `status` - # @return [String] - attr_accessor :status - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @advertised_id = args[:advertised_id] if args.key?(:advertised_id) - @beacon_name = args[:beacon_name] if args.key?(:beacon_name) - @description = args[:description] if args.key?(:description) - @ephemeral_id_registration = args[:ephemeral_id_registration] if args.key?(:ephemeral_id_registration) - @expected_stability = args[:expected_stability] if args.key?(:expected_stability) - @indoor_level = args[:indoor_level] if args.key?(:indoor_level) - @lat_lng = args[:lat_lng] if args.key?(:lat_lng) - @place_id = args[:place_id] if args.key?(:place_id) - @properties = args[:properties] if args.key?(:properties) - @provisioning_key = args[:provisioning_key] if args.key?(:provisioning_key) - @status = args[:status] if args.key?(:status) - end - end - - # Project-specific data associated with a beacon. - class BeaconAttachment - include Google::Apis::Core::Hashable - - # Resource name of this attachment. Attachment names have the format: - # beacons/beacon_id/attachments/attachment_id. - # Leave this empty on creation. - # Corresponds to the JSON property `attachmentName` - # @return [String] - attr_accessor :attachment_name - - # The UTC time when this attachment was created, in milliseconds since the - # UNIX epoch. - # Corresponds to the JSON property `creationTimeMs` - # @return [String] - attr_accessor :creation_time_ms - - # An opaque data container for client-provided data. Must be - # [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP - # requests, and will be so encoded (with padding) in responses. - # Required. - # Corresponds to the JSON property `data` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :data - - # The distance away from the beacon at which this attachment should be - # delivered to a mobile app. - # Setting this to a value greater than zero indicates that the app should - # behave as if the beacon is "seen" when the mobile device is less than this - # distance away from the beacon. - # Different attachments on the same beacon can have different max distances. - # Note that even though this value is expressed with fractional meter - # precision, real-world behavior is likley to be much less precise than one - # meter, due to the nature of current Bluetooth radio technology. - # Optional. When not set or zero, the attachment should be delivered at the - # beacon's outer limit of detection. - # Negative values are invalid and return an error. - # Corresponds to the JSON property `maxDistanceMeters` - # @return [Float] - attr_accessor :max_distance_meters - - # Specifies what kind of attachment this is. Tells a client how to - # interpret the `data` field. Format is namespace/type. Namespace - # provides type separation between clients. Type describes the type of - # `data`, for use by the client when parsing the `data` field. - # Required. - # Corresponds to the JSON property `namespacedType` - # @return [String] - attr_accessor :namespaced_type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @attachment_name = args[:attachment_name] if args.key?(:attachment_name) - @creation_time_ms = args[:creation_time_ms] if args.key?(:creation_time_ms) - @data = args[:data] if args.key?(:data) - @max_distance_meters = args[:max_distance_meters] if args.key?(:max_distance_meters) - @namespaced_type = args[:namespaced_type] if args.key?(:namespaced_type) - end - end - - # A subset of beacon information served via the `beaconinfo.getforobserved` - # method, which you call when users of your app encounter your beacons. - class BeaconInfo - include Google::Apis::Core::Hashable - - # Defines a unique identifier of a beacon as broadcast by the device. - # Corresponds to the JSON property `advertisedId` - # @return [Google::Apis::ProximitybeaconV1beta1::AdvertisedId] - attr_accessor :advertised_id - - # Attachments matching the type(s) requested. - # May be empty if no attachment types were requested. - # Corresponds to the JSON property `attachments` - # @return [Array] - attr_accessor :attachments - - # The name under which the beacon is registered. - # Corresponds to the JSON property `beaconName` - # @return [String] - attr_accessor :beacon_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @advertised_id = args[:advertised_id] if args.key?(:advertised_id) - @attachments = args[:attachments] if args.key?(:attachments) - @beacon_name = args[:beacon_name] if args.key?(:beacon_name) - end - end - - # Represents a whole or partial calendar date, e.g. a birthday. The time of day - # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # * A full date, with non-zero year, month and day values - # * A month and day value, with a zero year, e.g. an anniversary - # * A year on its own, with zero month and day values - # * A year and month value, with a zero day, e.g. a credit card expiration date - # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. - class Date - include Google::Apis::Core::Hashable - - # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 - # if specifying a year by itself or a year and month where the day is not - # significant. - # Corresponds to the JSON property `day` - # @return [Fixnum] - attr_accessor :day - - # Month of year. Must be from 1 to 12, or 0 if specifying a year without a - # month and day. - # Corresponds to the JSON property `month` - # @return [Fixnum] - attr_accessor :month - - # Year of date. Must be from 1 to 9999, or 0 if specifying a date without - # a year. - # Corresponds to the JSON property `year` - # @return [Fixnum] - attr_accessor :year - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @day = args[:day] if args.key?(:day) - @month = args[:month] if args.key?(:month) - @year = args[:year] if args.key?(:year) - end - end - - # Response for a request to delete attachments. - class DeleteAttachmentsResponse - include Google::Apis::Core::Hashable - - # The number of attachments that were deleted. - # Corresponds to the JSON property `numDeleted` - # @return [Fixnum] - attr_accessor :num_deleted - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @num_deleted = args[:num_deleted] if args.key?(:num_deleted) - end - end - - # Diagnostics for a single beacon. - class Diagnostics - include Google::Apis::Core::Hashable - - # An unordered list of Alerts that the beacon has. - # Corresponds to the JSON property `alerts` - # @return [Array] - attr_accessor :alerts - - # Resource name of the beacon. For Eddystone-EID beacons, this may - # be the beacon's current EID, or the beacon's "stable" Eddystone-UID. - # Corresponds to the JSON property `beaconName` - # @return [String] - attr_accessor :beacon_name - - # Represents a whole or partial calendar date, e.g. a birthday. The time of day - # and time zone are either specified elsewhere or are not significant. The date - # is relative to the Proleptic Gregorian Calendar. This can represent: - # * A full date, with non-zero year, month and day values - # * A month and day value, with a zero year, e.g. an anniversary - # * A year on its own, with zero month and day values - # * A year and month value, with a zero day, e.g. a credit card expiration date - # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. - # Corresponds to the JSON property `estimatedLowBatteryDate` - # @return [Google::Apis::ProximitybeaconV1beta1::Date] - attr_accessor :estimated_low_battery_date - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @alerts = args[:alerts] if args.key?(:alerts) - @beacon_name = args[:beacon_name] if args.key?(:beacon_name) - @estimated_low_battery_date = args[:estimated_low_battery_date] if args.key?(:estimated_low_battery_date) - 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 - - # Write-only registration parameters for beacons using Eddystone-EID format. - # Two ways of securely registering an Eddystone-EID beacon with the service - # are supported: - # 1. Perform an ECDH key exchange via this API, including a previous call - # to `GET /v1beta1/eidparams`. In this case the fields - # `beacon_ecdh_public_key` and `service_ecdh_public_key` should be - # populated and `beacon_identity_key` should not be populated. This - # method ensures that only the two parties in the ECDH key exchange can - # compute the identity key, which becomes a secret between them. - # 2. Derive or obtain the beacon's identity key via other secure means - # (perhaps an ECDH key exchange between the beacon and a mobile device - # or any other secure method), and then submit the resulting identity key - # to the service. In this case `beacon_identity_key` field should be - # populated, and neither of `beacon_ecdh_public_key` nor - # `service_ecdh_public_key` fields should be. The security of this method - # depends on how securely the parties involved (in particular the - # bluetooth client) handle the identity key, and obviously on how - # securely the identity key was generated. - # See [the Eddystone - # specification](https://github.com/google/eddystone/tree/master/eddystone-eid) - # at GitHub. - class EphemeralIdRegistration - include Google::Apis::Core::Hashable - - # The beacon's public key used for the Elliptic curve Diffie-Hellman - # key exchange. When this field is populated, `service_ecdh_public_key` - # must also be populated, and `beacon_identity_key` must not be. - # Corresponds to the JSON property `beaconEcdhPublicKey` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :beacon_ecdh_public_key - - # The private key of the beacon. If this field is populated, - # `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be - # populated. - # Corresponds to the JSON property `beaconIdentityKey` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :beacon_identity_key - - # The initial clock value of the beacon. The beacon's clock must have - # begun counting at this value immediately prior to transmitting this - # value to the resolving service. Significant delay in transmitting this - # value to the service risks registration or resolution failures. If a - # value is not provided, the default is zero. - # Corresponds to the JSON property `initialClockValue` - # @return [Fixnum] - attr_accessor :initial_clock_value - - # An initial ephemeral ID calculated using the clock value submitted as - # `initial_clock_value`, and the secret key generated by the - # Diffie-Hellman key exchange using `service_ecdh_public_key` and - # `service_ecdh_public_key`. This initial EID value will be used by the - # service to confirm that the key exchange process was successful. - # Corresponds to the JSON property `initialEid` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :initial_eid - - # Indicates the nominal period between each rotation of the beacon's - # ephemeral ID. "Nominal" because the beacon should randomize the - # actual interval. See [the spec at - # github](https://github.com/google/eddystone/tree/master/eddystone-eid) - # for details. This value corresponds to a power-of-two scaler on the - # beacon's clock: when the scaler value is K, the beacon will begin - # broadcasting a new ephemeral ID on average every 2^K seconds. - # Corresponds to the JSON property `rotationPeriodExponent` - # @return [Fixnum] - attr_accessor :rotation_period_exponent - - # The service's public key used for the Elliptic curve Diffie-Hellman - # key exchange. When this field is populated, `beacon_ecdh_public_key` - # must also be populated, and `beacon_identity_key` must not be. - # Corresponds to the JSON property `serviceEcdhPublicKey` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :service_ecdh_public_key - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @beacon_ecdh_public_key = args[:beacon_ecdh_public_key] if args.key?(:beacon_ecdh_public_key) - @beacon_identity_key = args[:beacon_identity_key] if args.key?(:beacon_identity_key) - @initial_clock_value = args[:initial_clock_value] if args.key?(:initial_clock_value) - @initial_eid = args[:initial_eid] if args.key?(:initial_eid) - @rotation_period_exponent = args[:rotation_period_exponent] if args.key?(:rotation_period_exponent) - @service_ecdh_public_key = args[:service_ecdh_public_key] if args.key?(:service_ecdh_public_key) - end - end - - # Information a client needs to provision and register beacons that - # broadcast Eddystone-EID format beacon IDs, using Elliptic curve - # Diffie-Hellman key exchange. See - # [the Eddystone - # specification](https://github.com/google/eddystone/tree/master/eddystone-eid) - # at GitHub. - class EphemeralIdRegistrationParams - include Google::Apis::Core::Hashable - - # Indicates the maximum rotation period supported by the service. - # See - # EddystoneEidRegistration.rotation_period_exponent - # Corresponds to the JSON property `maxRotationPeriodExponent` - # @return [Fixnum] - attr_accessor :max_rotation_period_exponent - - # Indicates the minimum rotation period supported by the service. - # See - # EddystoneEidRegistration.rotation_period_exponent - # Corresponds to the JSON property `minRotationPeriodExponent` - # @return [Fixnum] - attr_accessor :min_rotation_period_exponent - - # The beacon service's public key for use by a beacon to derive its - # Identity Key using Elliptic Curve Diffie-Hellman key exchange. - # Corresponds to the JSON property `serviceEcdhPublicKey` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :service_ecdh_public_key - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @max_rotation_period_exponent = args[:max_rotation_period_exponent] if args.key?(:max_rotation_period_exponent) - @min_rotation_period_exponent = args[:min_rotation_period_exponent] if args.key?(:min_rotation_period_exponent) - @service_ecdh_public_key = args[:service_ecdh_public_key] if args.key?(:service_ecdh_public_key) - end - end - - # Request for beacon and attachment information about beacons that - # a mobile client has encountered "in the wild". - class GetInfoForObservedBeaconsRequest - include Google::Apis::Core::Hashable - - # Specifies what kind of attachments to include in the response. - # When given, the response will include only attachments of the given types. - # When empty, no attachments will be returned. Must be in the format - # namespace/type. Accepts `*` to specify all types in - # all namespaces owned by the client. - # Optional. - # Corresponds to the JSON property `namespacedTypes` - # @return [Array] - attr_accessor :namespaced_types - - # The beacons that the client has encountered. - # At least one must be given. - # Corresponds to the JSON property `observations` - # @return [Array] - attr_accessor :observations - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @namespaced_types = args[:namespaced_types] if args.key?(:namespaced_types) - @observations = args[:observations] if args.key?(:observations) - end - end - - # Information about the requested beacons, optionally including attachment - # data. - class GetInfoForObservedBeaconsResponse - include Google::Apis::Core::Hashable - - # Public information about beacons. - # May be empty if the request matched no beacons. - # Corresponds to the JSON property `beacons` - # @return [Array] - attr_accessor :beacons - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @beacons = args[:beacons] if args.key?(:beacons) - end - end - - # Indoor level, a human-readable string as returned by Google Maps APIs, - # useful to indicate which floor of a building a beacon is located on. - class IndoorLevel - include Google::Apis::Core::Hashable - - # The name of this level. - # 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) - @name = args[:name] if args.key?(:name) - end - end - - # An object representing a latitude/longitude pair. This is expressed as a pair - # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. - class LatLng - include Google::Apis::Core::Hashable - - # The latitude in degrees. It must be in the range [-90.0, +90.0]. - # Corresponds to the JSON property `latitude` - # @return [Float] - attr_accessor :latitude - - # The longitude in degrees. It must be in the range [-180.0, +180.0]. - # Corresponds to the JSON property `longitude` - # @return [Float] - attr_accessor :longitude - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @latitude = args[:latitude] if args.key?(:latitude) - @longitude = args[:longitude] if args.key?(:longitude) - end - end - - # Response to `ListBeaconAttachments` that contains the requested attachments. - class ListBeaconAttachmentsResponse - include Google::Apis::Core::Hashable - - # The attachments that corresponded to the request params. - # Corresponds to the JSON property `attachments` - # @return [Array] - attr_accessor :attachments - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @attachments = args[:attachments] if args.key?(:attachments) - end - end - - # Response that contains list beacon results and pagination help. - class ListBeaconsResponse - include Google::Apis::Core::Hashable - - # The beacons that matched the search criteria. - # Corresponds to the JSON property `beacons` - # @return [Array] - attr_accessor :beacons - - # An opaque pagination token that the client may provide in their next - # request to retrieve the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # Estimate of the total number of beacons matched by the query. Higher - # values may be less accurate. - # Corresponds to the JSON property `totalCount` - # @return [Fixnum] - attr_accessor :total_count - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @beacons = args[:beacons] if args.key?(:beacons) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @total_count = args[:total_count] if args.key?(:total_count) - end - end - - # Response that contains the requested diagnostics. - class ListDiagnosticsResponse - include Google::Apis::Core::Hashable - - # The diagnostics matching the given request. - # Corresponds to the JSON property `diagnostics` - # @return [Array] - attr_accessor :diagnostics - - # Token that can be used for pagination. Returned only if the - # request matches more beacons than can be returned in this response. - # 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) - @diagnostics = args[:diagnostics] if args.key?(:diagnostics) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # Response to ListNamespacesRequest that contains all the project's namespaces. - class ListNamespacesResponse - include Google::Apis::Core::Hashable - - # The attachments that corresponded to the request params. - # Corresponds to the JSON property `namespaces` - # @return [Array] - attr_accessor :namespaces - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @namespaces = args[:namespaces] if args.key?(:namespaces) - end - end - - # An attachment namespace defines read and write access for all the attachments - # created under it. Each namespace is globally unique, and owned by one - # project which is the only project that can create attachments under it. - class Namespace - include Google::Apis::Core::Hashable - - # Resource name of this namespace. Namespaces names have the format: - # namespaces/namespace. - # Corresponds to the JSON property `namespaceName` - # @return [String] - attr_accessor :namespace_name - - # Specifies what clients may receive attachments under this namespace - # via `beaconinfo.getforobserved`. - # Corresponds to the JSON property `servingVisibility` - # @return [String] - attr_accessor :serving_visibility - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @namespace_name = args[:namespace_name] if args.key?(:namespace_name) - @serving_visibility = args[:serving_visibility] if args.key?(:serving_visibility) - end - end - - # Represents one beacon observed once. - class Observation - include Google::Apis::Core::Hashable - - # Defines a unique identifier of a beacon as broadcast by the device. - # Corresponds to the JSON property `advertisedId` - # @return [Google::Apis::ProximitybeaconV1beta1::AdvertisedId] - attr_accessor :advertised_id - - # The array of telemetry bytes received from the beacon. The server is - # responsible for parsing it. This field may frequently be empty, as - # with a beacon that transmits telemetry only occasionally. - # Corresponds to the JSON property `telemetry` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :telemetry - - # Time when the beacon was observed. - # Corresponds to the JSON property `timestampMs` - # @return [String] - attr_accessor :timestamp_ms - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @advertised_id = args[:advertised_id] if args.key?(:advertised_id) - @telemetry = args[:telemetry] if args.key?(:telemetry) - @timestamp_ms = args[:timestamp_ms] if args.key?(:timestamp_ms) - end - end - end - end -end diff --git a/generated/google/apis/proximitybeacon_v1beta1/representations.rb b/generated/google/apis/proximitybeacon_v1beta1/representations.rb deleted file mode 100644 index 610519173..000000000 --- a/generated/google/apis/proximitybeacon_v1beta1/representations.rb +++ /dev/null @@ -1,350 +0,0 @@ -# Copyright 2015 Google Inc. -# -# 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 ProximitybeaconV1beta1 - - class AdvertisedId - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AttachmentInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Beacon - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BeaconAttachment - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BeaconInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Date - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeleteAttachmentsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Diagnostics - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Empty - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class EphemeralIdRegistration - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class EphemeralIdRegistrationParams - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GetInfoForObservedBeaconsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GetInfoForObservedBeaconsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class IndoorLevel - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class LatLng - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListBeaconAttachmentsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListBeaconsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListDiagnosticsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListNamespacesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Namespace - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Observation - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AdvertisedId - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :id, :base64 => true, as: 'id' - property :type, as: 'type' - end - end - - class AttachmentInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :data, :base64 => true, as: 'data' - property :max_distance_meters, as: 'maxDistanceMeters' - property :namespaced_type, as: 'namespacedType' - end - end - - class Beacon - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :advertised_id, as: 'advertisedId', class: Google::Apis::ProximitybeaconV1beta1::AdvertisedId, decorator: Google::Apis::ProximitybeaconV1beta1::AdvertisedId::Representation - - property :beacon_name, as: 'beaconName' - property :description, as: 'description' - property :ephemeral_id_registration, as: 'ephemeralIdRegistration', class: Google::Apis::ProximitybeaconV1beta1::EphemeralIdRegistration, decorator: Google::Apis::ProximitybeaconV1beta1::EphemeralIdRegistration::Representation - - property :expected_stability, as: 'expectedStability' - property :indoor_level, as: 'indoorLevel', class: Google::Apis::ProximitybeaconV1beta1::IndoorLevel, decorator: Google::Apis::ProximitybeaconV1beta1::IndoorLevel::Representation - - property :lat_lng, as: 'latLng', class: Google::Apis::ProximitybeaconV1beta1::LatLng, decorator: Google::Apis::ProximitybeaconV1beta1::LatLng::Representation - - property :place_id, as: 'placeId' - hash :properties, as: 'properties' - property :provisioning_key, :base64 => true, as: 'provisioningKey' - property :status, as: 'status' - end - end - - class BeaconAttachment - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :attachment_name, as: 'attachmentName' - property :creation_time_ms, as: 'creationTimeMs' - property :data, :base64 => true, as: 'data' - property :max_distance_meters, as: 'maxDistanceMeters' - property :namespaced_type, as: 'namespacedType' - end - end - - class BeaconInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :advertised_id, as: 'advertisedId', class: Google::Apis::ProximitybeaconV1beta1::AdvertisedId, decorator: Google::Apis::ProximitybeaconV1beta1::AdvertisedId::Representation - - collection :attachments, as: 'attachments', class: Google::Apis::ProximitybeaconV1beta1::AttachmentInfo, decorator: Google::Apis::ProximitybeaconV1beta1::AttachmentInfo::Representation - - property :beacon_name, as: 'beaconName' - end - end - - class Date - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :day, as: 'day' - property :month, as: 'month' - property :year, as: 'year' - end - end - - class DeleteAttachmentsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :num_deleted, as: 'numDeleted' - end - end - - class Diagnostics - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :alerts, as: 'alerts' - property :beacon_name, as: 'beaconName' - property :estimated_low_battery_date, as: 'estimatedLowBatteryDate', class: Google::Apis::ProximitybeaconV1beta1::Date, decorator: Google::Apis::ProximitybeaconV1beta1::Date::Representation - - end - end - - class Empty - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - - class EphemeralIdRegistration - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :beacon_ecdh_public_key, :base64 => true, as: 'beaconEcdhPublicKey' - property :beacon_identity_key, :base64 => true, as: 'beaconIdentityKey' - property :initial_clock_value, :numeric_string => true, as: 'initialClockValue' - property :initial_eid, :base64 => true, as: 'initialEid' - property :rotation_period_exponent, as: 'rotationPeriodExponent' - property :service_ecdh_public_key, :base64 => true, as: 'serviceEcdhPublicKey' - end - end - - class EphemeralIdRegistrationParams - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :max_rotation_period_exponent, as: 'maxRotationPeriodExponent' - property :min_rotation_period_exponent, as: 'minRotationPeriodExponent' - property :service_ecdh_public_key, :base64 => true, as: 'serviceEcdhPublicKey' - end - end - - class GetInfoForObservedBeaconsRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :namespaced_types, as: 'namespacedTypes' - collection :observations, as: 'observations', class: Google::Apis::ProximitybeaconV1beta1::Observation, decorator: Google::Apis::ProximitybeaconV1beta1::Observation::Representation - - end - end - - class GetInfoForObservedBeaconsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :beacons, as: 'beacons', class: Google::Apis::ProximitybeaconV1beta1::BeaconInfo, decorator: Google::Apis::ProximitybeaconV1beta1::BeaconInfo::Representation - - end - end - - class IndoorLevel - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - end - end - - class LatLng - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :latitude, as: 'latitude' - property :longitude, as: 'longitude' - end - end - - class ListBeaconAttachmentsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :attachments, as: 'attachments', class: Google::Apis::ProximitybeaconV1beta1::BeaconAttachment, decorator: Google::Apis::ProximitybeaconV1beta1::BeaconAttachment::Representation - - end - end - - class ListBeaconsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :beacons, as: 'beacons', class: Google::Apis::ProximitybeaconV1beta1::Beacon, decorator: Google::Apis::ProximitybeaconV1beta1::Beacon::Representation - - property :next_page_token, as: 'nextPageToken' - property :total_count, :numeric_string => true, as: 'totalCount' - end - end - - class ListDiagnosticsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :diagnostics, as: 'diagnostics', class: Google::Apis::ProximitybeaconV1beta1::Diagnostics, decorator: Google::Apis::ProximitybeaconV1beta1::Diagnostics::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class ListNamespacesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :namespaces, as: 'namespaces', class: Google::Apis::ProximitybeaconV1beta1::Namespace, decorator: Google::Apis::ProximitybeaconV1beta1::Namespace::Representation - - end - end - - class Namespace - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :namespace_name, as: 'namespaceName' - property :serving_visibility, as: 'servingVisibility' - end - end - - class Observation - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :advertised_id, as: 'advertisedId', class: Google::Apis::ProximitybeaconV1beta1::AdvertisedId, decorator: Google::Apis::ProximitybeaconV1beta1::AdvertisedId::Representation - - property :telemetry, :base64 => true, as: 'telemetry' - property :timestamp_ms, as: 'timestampMs' - end - end - end - end -end diff --git a/generated/google/apis/proximitybeacon_v1beta1/service.rb b/generated/google/apis/proximitybeacon_v1beta1/service.rb deleted file mode 100644 index ae4accd4c..000000000 --- a/generated/google/apis/proximitybeacon_v1beta1/service.rb +++ /dev/null @@ -1,933 +0,0 @@ -# Copyright 2015 Google Inc. -# -# 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 '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 ProximitybeaconV1beta1 - # Proximity Beacon API - # - # Registers, manages, indexes, and searches beacons. - # - # @example - # require 'google/apis/proximitybeacon_v1beta1' - # - # Proximitybeacon = Google::Apis::ProximitybeaconV1beta1 # Alias the module - # service = Proximitybeacon::ProximitybeaconService.new - # - # @see https://developers.google.com/beacons/proximity/ - class ProximitybeaconService < Google::Apis::Core::BaseService - # @return [String] - # API key. Your API key identifies your project and provides you with API access, - # quota, and reports. Required unless you provide an OAuth 2.0 token. - attr_accessor :key - - # @return [String] - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - attr_accessor :quota_user - - def initialize - super('https://proximitybeacon.googleapis.com/', '') - @batch_path = 'batch' - end - - # Given one or more beacon observations, returns any beacon information - # and attachments accessible to your application. Authorize by using the - # [API - # key](https://developers.google.com/beacons/proximity/get-started# - # request_a_browser_api_key) - # for the application. - # @param [Google::Apis::ProximitybeaconV1beta1::GetInfoForObservedBeaconsRequest] get_info_for_observed_beacons_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ProximitybeaconV1beta1::GetInfoForObservedBeaconsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ProximitybeaconV1beta1::GetInfoForObservedBeaconsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def getforobserved_beaconinfo(get_info_for_observed_beacons_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/beaconinfo:getforobserved', options) - command.request_representation = Google::Apis::ProximitybeaconV1beta1::GetInfoForObservedBeaconsRequest::Representation - command.request_object = get_info_for_observed_beacons_request_object - command.response_representation = Google::Apis::ProximitybeaconV1beta1::GetInfoForObservedBeaconsResponse::Representation - command.response_class = Google::Apis::ProximitybeaconV1beta1::GetInfoForObservedBeaconsResponse - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Activates a beacon. A beacon that is active will return information - # and attachment data when queried via `beaconinfo.getforobserved`. - # Calling this method on an already active beacon will do nothing (but - # will return a successful response code). - # Authenticate using an [OAuth access - # token](https://developers.google.com/identity/protocols/OAuth2) from a - # signed-in user with **Is owner** or **Can edit** permissions in the Google - # Developers Console project. - # @param [String] beacon_name - # Beacon that should be activated. A beacon name has the format - # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by - # the beacon and N is a code for the beacon's type. Possible values are - # `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` - # for AltBeacon. For Eddystone-EID beacons, you may use either the - # current EID or the beacon's "stable" UID. - # Required. - # @param [String] project_id - # The project id of the beacon to activate. If the project id is not - # specified then the project making the request is used. The project id - # must match the project that owns the beacon. - # Optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ProximitybeaconV1beta1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ProximitybeaconV1beta1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def activate_beacon(beacon_name, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/{+beaconName}:activate', options) - command.response_representation = Google::Apis::ProximitybeaconV1beta1::Empty::Representation - command.response_class = Google::Apis::ProximitybeaconV1beta1::Empty - command.params['beaconName'] = beacon_name unless beacon_name.nil? - command.query['projectId'] = project_id unless project_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deactivates a beacon. Once deactivated, the API will not return - # information nor attachment data for the beacon when queried via - # `beaconinfo.getforobserved`. Calling this method on an already inactive - # beacon will do nothing (but will return a successful response code). - # Authenticate using an [OAuth access - # token](https://developers.google.com/identity/protocols/OAuth2) from a - # signed-in user with **Is owner** or **Can edit** permissions in the Google - # Developers Console project. - # @param [String] beacon_name - # Beacon that should be deactivated. A beacon name has the format - # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by - # the beacon and N is a code for the beacon's type. Possible values are - # `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` - # for AltBeacon. For Eddystone-EID beacons, you may use either the - # current EID or the beacon's "stable" UID. - # Required. - # @param [String] project_id - # The project id of the beacon to deactivate. If the project id is not - # specified then the project making the request is used. The project id must - # match the project that owns the beacon. - # Optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ProximitybeaconV1beta1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ProximitybeaconV1beta1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def deactivate_beacon(beacon_name, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/{+beaconName}:deactivate', options) - command.response_representation = Google::Apis::ProximitybeaconV1beta1::Empty::Representation - command.response_class = Google::Apis::ProximitybeaconV1beta1::Empty - command.params['beaconName'] = beacon_name unless beacon_name.nil? - command.query['projectId'] = project_id unless project_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Decommissions the specified beacon in the service. This beacon will no - # longer be returned from `beaconinfo.getforobserved`. This operation is - # permanent -- you will not be able to re-register a beacon with this ID - # again. - # Authenticate using an [OAuth access - # token](https://developers.google.com/identity/protocols/OAuth2) from a - # signed-in user with **Is owner** or **Can edit** permissions in the Google - # Developers Console project. - # @param [String] beacon_name - # Beacon that should be decommissioned. A beacon name has the format - # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by - # the beacon and N is a code for the beacon's type. Possible values are - # `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` - # for AltBeacon. For Eddystone-EID beacons, you may use either the - # current EID of the beacon's "stable" UID. - # Required. - # @param [String] project_id - # The project id of the beacon to decommission. If the project id is not - # specified then the project making the request is used. The project id - # must match the project that owns the beacon. - # Optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ProximitybeaconV1beta1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ProximitybeaconV1beta1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def decommission_beacon(beacon_name, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/{+beaconName}:decommission', options) - command.response_representation = Google::Apis::ProximitybeaconV1beta1::Empty::Representation - command.response_class = Google::Apis::ProximitybeaconV1beta1::Empty - command.params['beaconName'] = beacon_name unless beacon_name.nil? - command.query['projectId'] = project_id unless project_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes the specified beacon including all diagnostics data for the beacon - # as well as any attachments on the beacon (including those belonging to - # other projects). This operation cannot be undone. - # Authenticate using an [OAuth access - # token](https://developers.google.com/identity/protocols/OAuth2) from a - # signed-in user with **Is owner** or **Can edit** permissions in the Google - # Developers Console project. - # @param [String] beacon_name - # Beacon that should be deleted. A beacon name has the format - # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by - # the beacon and N is a code for the beacon's type. Possible values are - # `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` - # for AltBeacon. For Eddystone-EID beacons, you may use either the - # current EID or the beacon's "stable" UID. - # Required. - # @param [String] project_id - # The project id of the beacon to delete. If not provided, the project - # that is making the request is used. - # Optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ProximitybeaconV1beta1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ProximitybeaconV1beta1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_beacon(beacon_name, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v1beta1/{+beaconName}', options) - command.response_representation = Google::Apis::ProximitybeaconV1beta1::Empty::Representation - command.response_class = Google::Apis::ProximitybeaconV1beta1::Empty - command.params['beaconName'] = beacon_name unless beacon_name.nil? - command.query['projectId'] = project_id unless project_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Returns detailed information about the specified beacon. - # Authenticate using an [OAuth access - # token](https://developers.google.com/identity/protocols/OAuth2) from a - # signed-in user with **viewer**, **Is owner** or **Can edit** permissions in - # the Google Developers Console project. - # Requests may supply an Eddystone-EID beacon name in the form: - # `beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID - # broadcast by the beacon. The returned `Beacon` object will contain the - # beacon's stable Eddystone-UID. Clients not authorized to resolve the - # beacon's ephemeral Eddystone-EID broadcast will receive an error. - # @param [String] beacon_name - # Resource name of this beacon. A beacon name has the format - # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by - # the beacon and N is a code for the beacon's type. Possible values are - # `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` - # for AltBeacon. For Eddystone-EID beacons, you may use either the - # current EID or the beacon's "stable" UID. - # Required. - # @param [String] project_id - # The project id of the beacon to request. If the project id is not specified - # then the project making the request is used. The project id must match the - # project that owns the beacon. - # Optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ProximitybeaconV1beta1::Beacon] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ProximitybeaconV1beta1::Beacon] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_beacon(beacon_name, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+beaconName}', options) - command.response_representation = Google::Apis::ProximitybeaconV1beta1::Beacon::Representation - command.response_class = Google::Apis::ProximitybeaconV1beta1::Beacon - command.params['beaconName'] = beacon_name unless beacon_name.nil? - command.query['projectId'] = project_id unless project_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Searches the beacon registry for beacons that match the given search - # criteria. Only those beacons that the client has permission to list - # will be returned. - # Authenticate using an [OAuth access - # token](https://developers.google.com/identity/protocols/OAuth2) from a - # signed-in user with **viewer**, **Is owner** or **Can edit** permissions in - # the Google Developers Console project. - # @param [Fixnum] page_size - # The maximum number of records to return for this request, up to a - # server-defined upper limit. - # @param [String] page_token - # A pagination token obtained from a previous request to list beacons. - # @param [String] project_id - # The project id to list beacons under. If not present then the project - # credential that made the request is used as the project. - # Optional. - # @param [String] q - # Filter query string that supports the following field filters: - # * **description:`""`** - # For example: **description:"Room 3"** - # Returns beacons whose description matches tokens in the string "Room 3" - # (not necessarily that exact string). - # The string must be double-quoted. - # * **status:``** - # For example: **status:active** - # Returns beacons whose status matches the given value. Values must be - # one of the Beacon.Status enum values (case insensitive). Accepts - # multiple filters which will be combined with OR logic. - # * **stability:``** - # For example: **stability:mobile** - # Returns beacons whose expected stability matches the given value. - # Values must be one of the Beacon.Stability enum values (case - # insensitive). Accepts multiple filters which will be combined with - # OR logic. - # * **place\_id:`""`** - # For example: **place\_id:"ChIJVSZzVR8FdkgRXGmmm6SslKw="** - # Returns beacons explicitly registered at the given place, expressed as - # a Place ID obtained from [Google Places API](/places/place-id). Does not - # match places inside the given place. Does not consider the beacon's - # actual location (which may be different from its registered place). - # Accepts multiple filters that will be combined with OR logic. The place - # ID must be double-quoted. - # * **registration\_time`[<|>|<=|>=]`** - # For example: **registration\_time>=1433116800** - # Returns beacons whose registration time matches the given filter. - # Supports the operators: <, >, <=, and >=. Timestamp must be expressed as - # an integer number of seconds since midnight January 1, 1970 UTC. Accepts - # at most two filters that will be combined with AND logic, to support - # "between" semantics. If more than two are supplied, the latter ones are - # ignored. - # * **lat:` lng: radius:`** - # For example: **lat:51.1232343 lng:-1.093852 radius:1000** - # Returns beacons whose registered location is within the given circle. - # When any of these fields are given, all are required. Latitude and - # longitude must be decimal degrees between -90.0 and 90.0 and between - # -180.0 and 180.0 respectively. Radius must be an integer number of - # meters between 10 and 1,000,000 (1000 km). - # * **property:`"="`** - # For example: **property:"battery-type=CR2032"** - # Returns beacons which have a property of the given name and value. - # Supports multiple filters which will be combined with OR logic. - # The entire name=value string must be double-quoted as one string. - # * **attachment\_type:`""`** - # For example: **attachment_type:"my-namespace/my-type"** - # Returns beacons having at least one attachment of the given namespaced - # type. Supports "any within this namespace" via the partial wildcard - # syntax: "my-namespace/*". Supports multiple filters which will be - # combined with OR logic. The string must be double-quoted. - # * **indoor\_level:`""`** - # For example: **indoor\_level:"1"** - # Returns beacons which are located on the given indoor level. Accepts - # multiple filters that will be combined with OR logic. - # Multiple filters on the same field are combined with OR logic (except - # registration_time which is combined with AND logic). - # Multiple filters on different fields are combined with AND logic. - # Filters should be separated by spaces. - # As with any HTTP query string parameter, the whole filter expression must - # be URL-encoded. - # Example REST request: - # `GET - # /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ProximitybeaconV1beta1::ListBeaconsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ProximitybeaconV1beta1::ListBeaconsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_beacons(page_size: nil, page_token: nil, project_id: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/beacons', options) - command.response_representation = Google::Apis::ProximitybeaconV1beta1::ListBeaconsResponse::Representation - command.response_class = Google::Apis::ProximitybeaconV1beta1::ListBeaconsResponse - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['projectId'] = project_id unless project_id.nil? - command.query['q'] = q unless q.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Registers a previously unregistered beacon given its `advertisedId`. - # These IDs are unique within the system. An ID can be registered only once. - # Authenticate using an [OAuth access - # token](https://developers.google.com/identity/protocols/OAuth2) from a - # signed-in user with **Is owner** or **Can edit** permissions in the Google - # Developers Console project. - # @param [Google::Apis::ProximitybeaconV1beta1::Beacon] beacon_object - # @param [String] project_id - # The project id of the project the beacon will be registered to. If - # the project id is not specified then the project making the request - # is used. - # Optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ProximitybeaconV1beta1::Beacon] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ProximitybeaconV1beta1::Beacon] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def register_beacon(beacon_object = nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/beacons:register', options) - command.request_representation = Google::Apis::ProximitybeaconV1beta1::Beacon::Representation - command.request_object = beacon_object - command.response_representation = Google::Apis::ProximitybeaconV1beta1::Beacon::Representation - command.response_class = Google::Apis::ProximitybeaconV1beta1::Beacon - command.query['projectId'] = project_id unless project_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates the information about the specified beacon. **Any field that you do - # not populate in the submitted beacon will be permanently erased**, so you - # should follow the "read, modify, write" pattern to avoid inadvertently - # destroying data. - # Changes to the beacon status via this method will be silently ignored. - # To update beacon status, use the separate methods on this API for - # activation, deactivation, and decommissioning. - # Authenticate using an [OAuth access - # token](https://developers.google.com/identity/protocols/OAuth2) from a - # signed-in user with **Is owner** or **Can edit** permissions in the Google - # Developers Console project. - # @param [String] beacon_name - # Resource name of this beacon. A beacon name has the format - # "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by - # the beacon and N is a code for the beacon's type. Possible values are - # `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. - # This field must be left empty when registering. After reading a beacon, - # clients can use the name for future operations. - # @param [Google::Apis::ProximitybeaconV1beta1::Beacon] beacon_object - # @param [String] project_id - # The project id of the beacon to update. If the project id is not - # specified then the project making the request is used. The project id - # must match the project that owns the beacon. - # Optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ProximitybeaconV1beta1::Beacon] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ProximitybeaconV1beta1::Beacon] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_beacon(beacon_name, beacon_object = nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'v1beta1/{+beaconName}', options) - command.request_representation = Google::Apis::ProximitybeaconV1beta1::Beacon::Representation - command.request_object = beacon_object - command.response_representation = Google::Apis::ProximitybeaconV1beta1::Beacon::Representation - command.response_class = Google::Apis::ProximitybeaconV1beta1::Beacon - command.params['beaconName'] = beacon_name unless beacon_name.nil? - command.query['projectId'] = project_id unless project_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes multiple attachments on a given beacon. This operation is - # permanent and cannot be undone. - # You can optionally specify `namespacedType` to choose which attachments - # should be deleted. If you do not specify `namespacedType`, all your - # attachments on the given beacon will be deleted. You also may explicitly - # specify `*/*` to delete all. - # Authenticate using an [OAuth access - # token](https://developers.google.com/identity/protocols/OAuth2) from a - # signed-in user with **Is owner** or **Can edit** permissions in the Google - # Developers Console project. - # @param [String] beacon_name - # The beacon whose attachments should be deleted. A beacon name has the - # format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast - # by the beacon and N is a code for the beacon's type. Possible values are - # `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` - # for AltBeacon. For Eddystone-EID beacons, you may use either the - # current EID or the beacon's "stable" UID. - # Required. - # @param [String] namespaced_type - # Specifies the namespace and type of attachments to delete in - # `namespace/type` format. Accepts `*/*` to specify - # "all types in all namespaces". - # Optional. - # @param [String] project_id - # The project id to delete beacon attachments under. This field can be - # used when "*" is specified to mean all attachment namespaces. Projects - # may have multiple attachments with multiple namespaces. If "*" is - # specified and the projectId string is empty, then the project - # making the request is used. - # Optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ProximitybeaconV1beta1::DeleteAttachmentsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ProximitybeaconV1beta1::DeleteAttachmentsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def batch_beacon_attachment_delete(beacon_name, namespaced_type: nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/{+beaconName}/attachments:batchDelete', options) - command.response_representation = Google::Apis::ProximitybeaconV1beta1::DeleteAttachmentsResponse::Representation - command.response_class = Google::Apis::ProximitybeaconV1beta1::DeleteAttachmentsResponse - command.params['beaconName'] = beacon_name unless beacon_name.nil? - command.query['namespacedType'] = namespaced_type unless namespaced_type.nil? - command.query['projectId'] = project_id unless project_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Associates the given data with the specified beacon. Attachment data must - # contain two parts: - #
      - #
    • A namespaced type.
    • - #
    • The actual attachment data itself.
    • - #
    - # The namespaced type consists of two parts, the namespace and the type. - # The namespace must be one of the values returned by the `namespaces` - # endpoint, while the type can be a string of any characters except for the - # forward slash (`/`) up to 100 characters in length. - # Attachment data can be up to 1024 bytes long. - # Authenticate using an [OAuth access - # token](https://developers.google.com/identity/protocols/OAuth2) from a - # signed-in user with **Is owner** or **Can edit** permissions in the Google - # Developers Console project. - # @param [String] beacon_name - # Beacon on which the attachment should be created. A beacon name has the - # format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast - # by the beacon and N is a code for the beacon's type. Possible values are - # `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` - # for AltBeacon. For Eddystone-EID beacons, you may use either the - # current EID or the beacon's "stable" UID. - # Required. - # @param [Google::Apis::ProximitybeaconV1beta1::BeaconAttachment] beacon_attachment_object - # @param [String] project_id - # The project id of the project the attachment will belong to. If - # the project id is not specified then the project making the request - # is used. - # Optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ProximitybeaconV1beta1::BeaconAttachment] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ProximitybeaconV1beta1::BeaconAttachment] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_beacon_attachment(beacon_name, beacon_attachment_object = nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1beta1/{+beaconName}/attachments', options) - command.request_representation = Google::Apis::ProximitybeaconV1beta1::BeaconAttachment::Representation - command.request_object = beacon_attachment_object - command.response_representation = Google::Apis::ProximitybeaconV1beta1::BeaconAttachment::Representation - command.response_class = Google::Apis::ProximitybeaconV1beta1::BeaconAttachment - command.params['beaconName'] = beacon_name unless beacon_name.nil? - command.query['projectId'] = project_id unless project_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes the specified attachment for the given beacon. Each attachment has - # a unique attachment name (`attachmentName`) which is returned when you - # fetch the attachment data via this API. You specify this with the delete - # request to control which attachment is removed. This operation cannot be - # undone. - # Authenticate using an [OAuth access - # token](https://developers.google.com/identity/protocols/OAuth2) from a - # signed-in user with **Is owner** or **Can edit** permissions in the Google - # Developers Console project. - # @param [String] attachment_name - # The attachment name (`attachmentName`) of - # the attachment to remove. For example: - # `beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For - # Eddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the - # beacon's current EID, or its "stable" Eddystone-UID. - # Required. - # @param [String] project_id - # The project id of the attachment to delete. If not provided, the project - # that is making the request is used. - # Optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ProximitybeaconV1beta1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ProximitybeaconV1beta1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_beacon_attachment(attachment_name, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v1beta1/{+attachmentName}', options) - command.response_representation = Google::Apis::ProximitybeaconV1beta1::Empty::Representation - command.response_class = Google::Apis::ProximitybeaconV1beta1::Empty - command.params['attachmentName'] = attachment_name unless attachment_name.nil? - command.query['projectId'] = project_id unless project_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Returns the attachments for the specified beacon that match the specified - # namespaced-type pattern. - # To control which namespaced types are returned, you add the - # `namespacedType` query parameter to the request. You must either use - # `*/*`, to return all attachments, or the namespace must be one of - # the ones returned from the `namespaces` endpoint. - # Authenticate using an [OAuth access - # token](https://developers.google.com/identity/protocols/OAuth2) from a - # signed-in user with **viewer**, **Is owner** or **Can edit** permissions in - # the Google Developers Console project. - # @param [String] beacon_name - # Beacon whose attachments should be fetched. A beacon name has the - # format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast - # by the beacon and N is a code for the beacon's type. Possible values are - # `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` - # for AltBeacon. For Eddystone-EID beacons, you may use either the - # current EID or the beacon's "stable" UID. - # Required. - # @param [String] namespaced_type - # Specifies the namespace and type of attachment to include in response in - # namespace/type format. Accepts `*/*` to specify - # "all types in all namespaces". - # @param [String] project_id - # The project id to list beacon attachments under. This field can be - # used when "*" is specified to mean all attachment namespaces. Projects - # may have multiple attachments with multiple namespaces. If "*" is - # specified and the projectId string is empty, then the project - # making the request is used. - # Optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ProximitybeaconV1beta1::ListBeaconAttachmentsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ProximitybeaconV1beta1::ListBeaconAttachmentsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_beacon_attachments(beacon_name, namespaced_type: nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+beaconName}/attachments', options) - command.response_representation = Google::Apis::ProximitybeaconV1beta1::ListBeaconAttachmentsResponse::Representation - command.response_class = Google::Apis::ProximitybeaconV1beta1::ListBeaconAttachmentsResponse - command.params['beaconName'] = beacon_name unless beacon_name.nil? - command.query['namespacedType'] = namespaced_type unless namespaced_type.nil? - command.query['projectId'] = project_id unless project_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # List the diagnostics for a single beacon. You can also list diagnostics for - # all the beacons owned by your Google Developers Console project by using - # the beacon name `beacons/-`. - # Authenticate using an [OAuth access - # token](https://developers.google.com/identity/protocols/OAuth2) from a - # signed-in user with **viewer**, **Is owner** or **Can edit** permissions in - # the Google Developers Console project. - # @param [String] beacon_name - # Beacon that the diagnostics are for. - # @param [String] alert_filter - # Requests only beacons that have the given alert. For example, to find - # beacons that have low batteries use `alert_filter=LOW_BATTERY`. - # @param [Fixnum] page_size - # Specifies the maximum number of results to return. Defaults to - # 10. Maximum 1000. Optional. - # @param [String] page_token - # Requests results that occur after the `page_token`, obtained from the - # response to a previous request. Optional. - # @param [String] project_id - # Requests only diagnostic records for the given project id. If not set, - # then the project making the request will be used for looking up - # diagnostic records. Optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ProximitybeaconV1beta1::ListDiagnosticsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ProximitybeaconV1beta1::ListDiagnosticsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_beacon_diagnostics(beacon_name, alert_filter: nil, page_size: nil, page_token: nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+beaconName}/diagnostics', options) - command.response_representation = Google::Apis::ProximitybeaconV1beta1::ListDiagnosticsResponse::Representation - command.response_class = Google::Apis::ProximitybeaconV1beta1::ListDiagnosticsResponse - command.params['beaconName'] = beacon_name unless beacon_name.nil? - command.query['alertFilter'] = alert_filter unless alert_filter.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['projectId'] = project_id unless project_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all attachment namespaces owned by your Google Developers Console - # project. Attachment data associated with a beacon must include a - # namespaced type, and the namespace must be owned by your project. - # Authenticate using an [OAuth access - # token](https://developers.google.com/identity/protocols/OAuth2) from a - # signed-in user with **viewer**, **Is owner** or **Can edit** permissions in - # the Google Developers Console project. - # @param [String] project_id - # The project id to list namespaces under. - # Optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ProximitybeaconV1beta1::ListNamespacesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ProximitybeaconV1beta1::ListNamespacesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_namespaces(project_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/namespaces', options) - command.response_representation = Google::Apis::ProximitybeaconV1beta1::ListNamespacesResponse::Representation - command.response_class = Google::Apis::ProximitybeaconV1beta1::ListNamespacesResponse - command.query['projectId'] = project_id unless project_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates the information about the specified namespace. Only the namespace - # visibility can be updated. - # @param [String] namespace_name - # Resource name of this namespace. Namespaces names have the format: - # namespaces/namespace. - # @param [Google::Apis::ProximitybeaconV1beta1::Namespace] namespace_object - # @param [String] project_id - # The project id of the namespace to update. If the project id is not - # specified then the project making the request is used. The project id - # must match the project that owns the beacon. - # Optional. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ProximitybeaconV1beta1::Namespace] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ProximitybeaconV1beta1::Namespace] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_namespace(namespace_name, namespace_object = nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'v1beta1/{+namespaceName}', options) - command.request_representation = Google::Apis::ProximitybeaconV1beta1::Namespace::Representation - command.request_object = namespace_object - command.response_representation = Google::Apis::ProximitybeaconV1beta1::Namespace::Representation - command.response_class = Google::Apis::ProximitybeaconV1beta1::Namespace - command.params['namespaceName'] = namespace_name unless namespace_name.nil? - command.query['projectId'] = project_id unless project_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets the Proximity Beacon API's current public key and associated - # parameters used to initiate the Diffie-Hellman key exchange required to - # register a beacon that broadcasts the Eddystone-EID format. This key - # changes periodically; clients may cache it and re-use the same public key - # to provision and register multiple beacons. However, clients should be - # prepared to refresh this key when they encounter an error registering an - # Eddystone-EID beacon. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ProximitybeaconV1beta1::EphemeralIdRegistrationParams] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ProximitybeaconV1beta1::EphemeralIdRegistrationParams] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_eidparams(fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/eidparams', options) - command.response_representation = Google::Apis::ProximitybeaconV1beta1::EphemeralIdRegistrationParams::Representation - command.response_class = Google::Apis::ProximitybeaconV1beta1::EphemeralIdRegistrationParams - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - protected - - def apply_command_defaults(command) - command.query['key'] = key unless key.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - end - end - end - end -end diff --git a/generated/google/apis/pubsub_v1.rb b/generated/google/apis/pubsub_v1.rb index 3a0b4c0da..0035150ab 100644 --- a/generated/google/apis/pubsub_v1.rb +++ b/generated/google/apis/pubsub_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/pubsub/docs module PubsubV1 VERSION = 'V1' - REVISION = '20200218' + REVISION = '20200312' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/pubsub_v1/classes.rb b/generated/google/apis/pubsub_v1/classes.rb index 8cc012fa0..01046ffc2 100644 --- a/generated/google/apis/pubsub_v1/classes.rb +++ b/generated/google/apis/pubsub_v1/classes.rb @@ -771,10 +771,14 @@ module Google # @return [Fixnum] attr_accessor :max_messages - # If this field set to true, the system will respond immediately even if + # Optional. If this field set to true, the system will respond immediately even + # if # it there are no messages available to return in the `Pull` response. # Otherwise, the system may wait (for a bounded amount of time) until at - # least one message is available, rather than returning no messages. + # least one message is available, rather than returning no messages. Warning: + # setting this field to `true` is discouraged because it adversely impacts + # the performance of `Pull` operations. We recommend that users do not set + # this field. # Corresponds to the JSON property `returnImmediately` # @return [Boolean] attr_accessor :return_immediately @@ -1355,9 +1359,9 @@ module Google # Required. Indicates which fields in the provided topic to update. Must be # specified # and non-empty. Note that if `update_mask` contains - # "message_storage_policy" then the new value will be determined based on the - # policy configured at the project or organization level. The - # `message_storage_policy` must not be set in the `topic` provided above. + # "message_storage_policy" but the `message_storage_policy` is not set in + # the `topic` provided above, then the updated value is determined by the + # policy configured at the project or organization level. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask diff --git a/generated/google/apis/pubsub_v1/service.rb b/generated/google/apis/pubsub_v1/service.rb index 3867bfb50..058595b71 100644 --- a/generated/google/apis/pubsub_v1/service.rb +++ b/generated/google/apis/pubsub_v1/service.rb @@ -1218,7 +1218,7 @@ module Google # acknowledgment state of messages in an existing subscription to the state # captured by a snapshot. # @param [String] topic - # The name of the topic that snapshots are attached to. + # Required. The name of the topic that snapshots are attached to. # Format is `projects/`project`/topics/`topic``. # @param [Fixnum] page_size # Maximum number of snapshot names to return. diff --git a/generated/google/apis/pubsub_v1beta2.rb b/generated/google/apis/pubsub_v1beta2.rb index 257df8862..2a1161e1e 100644 --- a/generated/google/apis/pubsub_v1beta2.rb +++ b/generated/google/apis/pubsub_v1beta2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/pubsub/docs module PubsubV1beta2 VERSION = 'V1beta2' - REVISION = '20200211' + REVISION = '20200303' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/pubsub_v1beta2/classes.rb b/generated/google/apis/pubsub_v1beta2/classes.rb index 4438c1603..693261335 100644 --- a/generated/google/apis/pubsub_v1beta2/classes.rb +++ b/generated/google/apis/pubsub_v1beta2/classes.rb @@ -587,11 +587,14 @@ module Google # @return [Fixnum] attr_accessor :max_messages - # If this is specified as true the system will respond immediately even if + # Optional. If this is specified as true the system will respond immediately + # even if # it is not able to return a message in the `Pull` response. Otherwise the # system is allowed to wait until at least one message is available rather # than returning no messages. The client may cancel the request if it does - # not wish to wait any longer for the response. + # not wish to wait any longer for the response. Warning: setting this field + # to `true` is discouraged because it adversely impacts the performance of + # `Pull` operations. We recommend that users do not set this field. # Corresponds to the JSON property `returnImmediately` # @return [Boolean] attr_accessor :return_immediately diff --git a/generated/google/apis/recommender_v1beta1.rb b/generated/google/apis/recommender_v1beta1.rb index 65f1f12dc..0e5f4fee7 100644 --- a/generated/google/apis/recommender_v1beta1.rb +++ b/generated/google/apis/recommender_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/recommender/docs/ module RecommenderV1beta1 VERSION = 'V1beta1' - REVISION = '20200308' + REVISION = '20200313' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/recommender_v1beta1/classes.rb b/generated/google/apis/recommender_v1beta1/classes.rb index 66699a8de..11ae8522b 100644 --- a/generated/google/apis/recommender_v1beta1/classes.rb +++ b/generated/google/apis/recommender_v1beta1/classes.rb @@ -116,9 +116,6 @@ module Google attr_accessor :last_refresh_time # Name of the insight. - # * A project insight is represented as - # projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] - # /insights/[insight_id] # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -317,7 +314,7 @@ module Google class GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest include Google::Apis::Core::Hashable - # Fingerprint of the Recommendation. Provides optimistic locking. + # Required. Fingerprint of the Recommendation. Provides optimistic locking. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag diff --git a/generated/google/apis/redis_v1.rb b/generated/google/apis/redis_v1.rb index 15bdcc7e5..838a84bea 100644 --- a/generated/google/apis/redis_v1.rb +++ b/generated/google/apis/redis_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/memorystore/docs/redis/ module RedisV1 VERSION = 'V1' - REVISION = '20200204' + REVISION = '20200402' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/redis_v1/classes.rb b/generated/google/apis/redis_v1/classes.rb index a68f04ff4..b34d44e12 100644 --- a/generated/google/apis/redis_v1/classes.rb +++ b/generated/google/apis/redis_v1/classes.rb @@ -271,9 +271,8 @@ module Google # @return [String] attr_accessor :authorized_network - # Optional. The connect mode of Redis instance. - # If not provided, default one will be used. - # Current default: DIRECT_PEERING. + # Optional. The network connect mode of the Redis instance. + # If not provided, the connect mode defaults to DIRECT_PEERING. # Corresponds to the JSON property `connectMode` # @return [String] attr_accessor :connect_mode @@ -351,13 +350,17 @@ module Google # Optional. Redis configuration parameters, according to # http://redis.io/topics/config. Currently, the only supported parameters # are: - # Redis 3.2 and above: + # Redis version 3.2 and newer: # * maxmemory-policy # * notify-keyspace-events - # Redis 4.0 and above: + # Redis version 4.0 and newer: # * activedefrag - # * lfu-log-factor # * lfu-decay-time + # * lfu-log-factor + # * maxmemory-gb + # Redis version 5.0 and newer: + # * stream-node-max-bytes + # * stream-node-max-entries # Corresponds to the JSON property `redisConfigs` # @return [Hash] attr_accessor :redis_configs @@ -365,8 +368,9 @@ module Google # Optional. The version of Redis software. # If not provided, latest supported version will be used. Currently, the # supported values are: - # * `REDIS_4_0` for Redis 4.0 compatibility (default) # * `REDIS_3_2` for Redis 3.2 compatibility + # * `REDIS_4_0` for Redis 4.0 compatibility (default) + # * `REDIS_5_0` for Redis 5.0 compatibility # Corresponds to the JSON property `redisVersion` # @return [String] attr_accessor :redis_version @@ -691,6 +695,25 @@ module Google @message = args[:message] if args.key?(:message) end end + + # Request for UpgradeInstance. + class UpgradeInstanceRequest + include Google::Apis::Core::Hashable + + # Required. Specifies the target version of Redis software to upgrade to. + # Corresponds to the JSON property `redisVersion` + # @return [String] + attr_accessor :redis_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @redis_version = args[:redis_version] if args.key?(:redis_version) + end + end end end end diff --git a/generated/google/apis/redis_v1/representations.rb b/generated/google/apis/redis_v1/representations.rb index 280bddf0e..56d7108eb 100644 --- a/generated/google/apis/redis_v1/representations.rb +++ b/generated/google/apis/redis_v1/representations.rb @@ -130,6 +130,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class UpgradeInstanceRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -300,6 +306,13 @@ module Google property :message, as: 'message' end end + + class UpgradeInstanceRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :redis_version, as: 'redisVersion' + end + end end end end diff --git a/generated/google/apis/redis_v1/service.rb b/generated/google/apis/redis_v1/service.rb index b2e4a2af6..63801934a 100644 --- a/generated/google/apis/redis_v1/service.rb +++ b/generated/google/apis/redis_v1/service.rb @@ -448,6 +448,42 @@ module Google execute_or_queue_command(command, &block) end + # Upgrades Redis instance to the newer Redis version specified in the + # request. + # @param [String] name + # Required. Redis instance resource name using the form: + # `projects/`project_id`/locations/`location_id`/instances/`instance_id`` + # where `location_id` refers to a GCP region. + # @param [Google::Apis::RedisV1::UpgradeInstanceRequest] upgrade_instance_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::RedisV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::RedisV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def upgrade_instance(name, upgrade_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:upgrade', options) + command.request_representation = Google::Apis::RedisV1::UpgradeInstanceRequest::Representation + command.request_object = upgrade_instance_request_object + command.response_representation = Google::Apis::RedisV1::Operation::Representation + command.response_class = Google::Apis::RedisV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Starts asynchronous cancellation on a long-running operation. The server # makes a best effort to cancel the operation, but success is not # guaranteed. If the server doesn't support this method, it returns diff --git a/generated/google/apis/redis_v1beta1.rb b/generated/google/apis/redis_v1beta1.rb index 747abb8b6..c565b1c72 100644 --- a/generated/google/apis/redis_v1beta1.rb +++ b/generated/google/apis/redis_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/memorystore/docs/redis/ module RedisV1beta1 VERSION = 'V1beta1' - REVISION = '20200204' + REVISION = '20200402' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/redis_v1beta1/classes.rb b/generated/google/apis/redis_v1beta1/classes.rb index d6e7dc06f..ceabcfb94 100644 --- a/generated/google/apis/redis_v1beta1/classes.rb +++ b/generated/google/apis/redis_v1beta1/classes.rb @@ -274,9 +274,8 @@ module Google # @return [String] attr_accessor :authorized_network - # Optional. The connect mode of Redis instance. - # If not provided, default one will be used. - # Current default: DIRECT_PEERING. + # Optional. The network connect mode of the Redis instance. + # If not provided, the connect mode defaults to DIRECT_PEERING. # Corresponds to the JSON property `connectMode` # @return [String] attr_accessor :connect_mode @@ -354,13 +353,17 @@ module Google # Optional. Redis configuration parameters, according to # http://redis.io/topics/config. Currently, the only supported parameters # are: - # Redis 3.2 and above: + # Redis version 3.2 and newer: # * maxmemory-policy # * notify-keyspace-events - # Redis 4.0 and above: + # Redis version 4.0 and newer: # * activedefrag - # * lfu-log-factor # * lfu-decay-time + # * lfu-log-factor + # * maxmemory-gb + # Redis version 5.0 and newer: + # * stream-node-max-bytes + # * stream-node-max-entries # Corresponds to the JSON property `redisConfigs` # @return [Hash] attr_accessor :redis_configs @@ -368,8 +371,9 @@ module Google # Optional. The version of Redis software. # If not provided, latest supported version will be used. Currently, the # supported values are: - # * `REDIS_4_0` for Redis 4.0 compatibility (default) # * `REDIS_3_2` for Redis 3.2 compatibility + # * `REDIS_4_0` for Redis 4.0 compatibility (default) + # * `REDIS_5_0` for Redis 5.0 compatibility # Corresponds to the JSON property `redisVersion` # @return [String] attr_accessor :redis_version diff --git a/generated/google/apis/remotebuildexecution_v1.rb b/generated/google/apis/remotebuildexecution_v1.rb index e13800d38..49cb4dab9 100644 --- a/generated/google/apis/remotebuildexecution_v1.rb +++ b/generated/google/apis/remotebuildexecution_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/remote-build-execution/docs/ module RemotebuildexecutionV1 VERSION = 'V1' - REVISION = '20200303' + REVISION = '20200324' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/remotebuildexecution_v1/classes.rb b/generated/google/apis/remotebuildexecution_v1/classes.rb index a3ae069c1..c358e0b62 100644 --- a/generated/google/apis/remotebuildexecution_v1/classes.rb +++ b/generated/google/apis/remotebuildexecution_v1/classes.rb @@ -45,8 +45,7 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -83,8 +82,7 @@ module Google alias_method :do_not_cache?, :do_not_cache # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -113,6 +111,17 @@ module Google # @return [Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest] attr_accessor :input_root_digest + # List of required supported NodeProperty + # keys. In order to ensure that equivalent `Action`s always hash to the same + # value, the supported node properties MUST be lexicographically sorted by name. + # Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. + # The interpretation of these properties is server-dependent. If a property is + # not recognized by the server, the server will return an `INVALID_ARGUMENT` + # error. + # Corresponds to the JSON property `outputNodeProperties` + # @return [Array] + attr_accessor :output_node_properties + # A timeout after which the execution should be killed. If the timeout is # absent, then the client is specifying that the execution should continue # as long as the server will let it. The server SHOULD impose a timeout if @@ -141,6 +150,7 @@ module Google @command_digest = args[:command_digest] if args.key?(:command_digest) @do_not_cache = args[:do_not_cache] if args.key?(:do_not_cache) @input_root_digest = args[:input_root_digest] if args.key?(:input_root_digest) + @output_node_properties = args[:output_node_properties] if args.key?(:output_node_properties) @timeout = args[:timeout] if args.key?(:timeout) end end @@ -161,9 +171,9 @@ module Google attr_accessor :exit_code # The output directories of the action. For each output directory requested - # in the `output_directories` field of the Action, if the corresponding - # directory existed after the action completed, a single entry will be - # present in the output list, which will contain the digest of a + # in the `output_directories` or `output_paths` field of the Action, if the + # corresponding directory existed after the action completed, a single entry + # will be present in the output list, which will contain the digest of a # Tree message containing the # directory tree, and the path equal exactly to the corresponding Action # output_directories member. @@ -217,7 +227,8 @@ module Google # ` # ` # ``` - # If an output of the same name was found, but was not a directory, the + # If an output of the same name as listed in `output_files` of + # the Command was found in `output_directories`, but was not a directory, the # server will return a FAILED_PRECONDITION. # Corresponds to the JSON property `outputDirectories` # @return [Array] @@ -237,6 +248,8 @@ module Google # If the action does not produce the requested output, then that output # will be omitted from the list. The server is free to arrange the output # list as desired; clients MUST NOT assume that the output list is sorted. + # DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API + # should still populate this field in addition to `output_symlinks`. # Corresponds to the JSON property `outputDirectorySymlinks` # @return [Array] attr_accessor :output_directory_symlinks @@ -245,25 +258,28 @@ module Google # may be links to other output files, or input files, or even absolute paths # outside of the working directory, if the server supports # SymlinkAbsolutePathStrategy.ALLOWED. - # For each output file requested in the `output_files` field of the Action, - # if the corresponding file existed after + # For each output file requested in the `output_files` or `output_paths` + # field of the Action, if the corresponding file existed after # the action completed, a single entry will be present either in this field, # or in the `output_files` field, if the file was not a symbolic link. - # If an output symbolic link of the same name was found, but its target - # type was not a regular file, the server will return a FAILED_PRECONDITION. + # If an output symbolic link of the same name as listed in `output_files` of + # the Command was found, but its target type was not a regular file, the + # server will return a FAILED_PRECONDITION. # If the action does not produce the requested output, then that output # will be omitted from the list. The server is free to arrange the output # list as desired; clients MUST NOT assume that the output list is sorted. + # DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API + # should still populate this field in addition to `output_symlinks`. # Corresponds to the JSON property `outputFileSymlinks` # @return [Array] attr_accessor :output_file_symlinks # The output files of the action. For each output file requested in the - # `output_files` field of the Action, if the corresponding file existed after - # the action completed, a single entry will be present either in this field, - # or the `output_file_symlinks` field if the file was a symbolic link to - # another file. - # If an output of the same name was found, but was a directory rather + # `output_files` or `output_paths` field of the Action, if the corresponding + # file existed after the action completed, a single entry will be present + # either in this field, or the `output_file_symlinks` field if the file was + # a symbolic link to another file (`output_symlinks` field after v2.1). + # If an output listed in `output_files` was found, but was a directory rather # than a regular file, the server will return a FAILED_PRECONDITION. # If the action does not produce the requested output, then that output # will be omitted from the list. The server is free to arrange the output @@ -272,9 +288,25 @@ module Google # @return [Array] attr_accessor :output_files + # New in v2.1: this field will only be populated if the command + # `output_paths` field was used, and not the pre v2.1 `output_files` or + # `output_directories` fields. + # The output paths of the action that are symbolic links to other paths. Those + # may be links to other outputs, or inputs, or even absolute paths + # outside of the working directory, if the server supports + # SymlinkAbsolutePathStrategy.ALLOWED. + # A single entry for each output requested in `output_paths` + # field of the Action, if the corresponding path existed after + # the action completed and was a symbolic link. + # If the action does not produce a requested output, then that output + # will be omitted from the list. The server is free to arrange the output + # list as desired; clients MUST NOT assume that the output list is sorted. + # Corresponds to the JSON property `outputSymlinks` + # @return [Array] + attr_accessor :output_symlinks + # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -315,8 +347,7 @@ module Google attr_accessor :stderr_raw # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -368,6 +399,7 @@ module Google @output_directory_symlinks = args[:output_directory_symlinks] if args.key?(:output_directory_symlinks) @output_file_symlinks = args[:output_file_symlinks] if args.key?(:output_file_symlinks) @output_files = args[:output_files] if args.key?(:output_files) + @output_symlinks = args[:output_symlinks] if args.key?(:output_symlinks) @stderr_digest = args[:stderr_digest] if args.key?(:stderr_digest) @stderr_raw = args[:stderr_raw] if args.key?(:stderr_raw) @stdout_digest = args[:stdout_digest] if args.key?(:stdout_digest) @@ -425,6 +457,7 @@ module Google # Directories leading up to the output directories (but not the output # directories themselves) are created by the worker prior to execution, even # if they are not explicitly part of the input root. + # DEPRECATED since 2.1: Use `output_paths` instead. # Corresponds to the JSON property `outputDirectories` # @return [Array] attr_accessor :output_directories @@ -446,10 +479,39 @@ module Google # have the same path as any of the listed output directories. # Directories leading up to the output files are created by the worker prior # to execution, even if they are not explicitly part of the input root. + # DEPRECATED since v2.1: Use `output_paths` instead. # Corresponds to the JSON property `outputFiles` # @return [Array] attr_accessor :output_files + # A list of the output paths that the client expects to retrieve from the + # action. Only the listed paths will be returned to the client as output. + # The type of the output (file or directory) is not specified, and will be + # determined by the server after action execution. If the resulting path is + # a file, it will be returned in an + # OutputFile) typed field. + # If the path is a directory, the entire directory structure will be returned + # as a Tree message digest, see + # OutputDirectory) + # Other files or directories that may be created during command execution + # are discarded. + # The paths are relative to the working directory of the action execution. + # The paths are specified using a single forward slash (`/`) as a path + # separator, even if the execution platform natively uses a different + # separator. The path MUST NOT include a trailing slash, nor a leading slash, + # being a relative path. + # In order to ensure consistent hashing of the same Action, the output paths + # MUST be deduplicated and sorted lexicographically by code point (or, + # equivalently, by UTF-8 bytes). + # Directories leading up to the output paths are created by the worker prior + # to execution, even if they are not explicitly part of the input root. + # New in v2.1: this field supersedes the DEPRECATED `output_files` and + # `output_directories` fields. If `output_paths` is used, `output_files` and + # `output_directories` will be ignored! + # Corresponds to the JSON property `outputPaths` + # @return [Array] + attr_accessor :output_paths + # A `Platform` is a set of requirements, such as hardware, operating system, or # compiler toolchain, for an # Action's execution @@ -476,6 +538,7 @@ module Google @environment_variables = args[:environment_variables] if args.key?(:environment_variables) @output_directories = args[:output_directories] if args.key?(:output_directories) @output_files = args[:output_files] if args.key?(:output_files) + @output_paths = args[:output_paths] if args.key?(:output_paths) @platform = args[:platform] if args.key?(:platform) @working_directory = args[:working_directory] if args.key?(:working_directory) end @@ -508,8 +571,7 @@ module Google end # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -580,6 +642,9 @@ module Google # * The files, directories and symlinks in the directory must each be sorted # in lexicographical order by path. The path strings must be sorted by code # point, equivalently, by UTF-8 bytes. + # * The NodeProperties of files, + # directories, and symlinks must be sorted in lexicographical order by + # property name. # A `Directory` that obeys the restrictions is said to be in canonical form. # As an example, the following could be used for a file named `bar` and a # directory named `foo` with an executable file named `baz` (hashes shortened @@ -593,7 +658,13 @@ module Google # digest: ` # hash: "4a73bc9d03...", # size: 65534 + # `, + # node_properties: [ # ` + # "name": "MTime", + # "value": "2017-01-15T01:30:15.01Z" + # ` + # ] # ` # ], # directories: [ @@ -633,6 +704,11 @@ module Google # @return [Array] attr_accessor :files + # The node properties of the Directory. + # Corresponds to the JSON property `nodeProperties` + # @return [Array] + attr_accessor :node_properties + # The symlinks in the directory. # Corresponds to the JSON property `symlinks` # @return [Array] @@ -646,6 +722,7 @@ module Google def update!(**args) @directories = args[:directories] if args.key?(:directories) @files = args[:files] if args.key?(:files) + @node_properties = args[:node_properties] if args.key?(:node_properties) @symlinks = args[:symlinks] if args.key?(:symlinks) end end @@ -657,8 +734,7 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -712,8 +788,7 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -913,8 +988,7 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -954,6 +1028,11 @@ module Google # @return [String] attr_accessor :name + # The node properties of the FileNode. + # Corresponds to the JSON property `nodeProperties` + # @return [Array] + attr_accessor :node_properties + def initialize(**args) update!(**args) end @@ -963,6 +1042,7 @@ module Google @digest = args[:digest] if args.key?(:digest) @is_executable = args[:is_executable] if args.key?(:is_executable) @name = args[:name] if args.key?(:name) + @node_properties = args[:node_properties] if args.key?(:node_properties) end end @@ -971,8 +1051,7 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -1022,6 +1101,35 @@ module Google end end + # A single property for FileNodes, + # DirectoryNodes, and + # SymlinkNodes. The server is + # responsible for specifying the property `name`s that it accepts. If + # permitted by the server, the same `name` may occur multiple times. + class BuildBazelRemoteExecutionV2NodeProperty + include Google::Apis::Core::Hashable + + # The property name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The property value. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @value = args[:value] if args.key?(:value) + end + end + # An `OutputDirectory` is the output in an `ActionResult` corresponding to a # directory's full contents rather than a single file. class BuildBazelRemoteExecutionV2OutputDirectory @@ -1036,8 +1144,7 @@ module Google attr_accessor :path # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -1097,8 +1204,7 @@ module Google attr_accessor :contents # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -1133,6 +1239,11 @@ module Google attr_accessor :is_executable alias_method :is_executable?, :is_executable + # The supported node properties of the OutputFile, if requested by the Action. + # Corresponds to the JSON property `nodeProperties` + # @return [Array] + attr_accessor :node_properties + # The full path of the file relative to the working directory, including the # filename. The path separator is a forward slash `/`. Since this is a # relative path, it MUST NOT begin with a leading forward slash. @@ -1149,6 +1260,7 @@ module Google @contents = args[:contents] if args.key?(:contents) @digest = args[:digest] if args.key?(:digest) @is_executable = args[:is_executable] if args.key?(:is_executable) + @node_properties = args[:node_properties] if args.key?(:node_properties) @path = args[:path] if args.key?(:path) end end @@ -1160,6 +1272,12 @@ module Google class BuildBazelRemoteExecutionV2OutputSymlink include Google::Apis::Core::Hashable + # The supported node properties of the OutputSymlink, if requested by the + # Action. + # Corresponds to the JSON property `nodeProperties` + # @return [Array] + attr_accessor :node_properties + # The full path of the symlink relative to the working directory, including the # filename. The path separator is a forward slash `/`. Since this is a # relative path, it MUST NOT begin with a leading forward slash. @@ -1183,6 +1301,7 @@ module Google # Update properties of this object def update!(**args) + @node_properties = args[:node_properties] if args.key?(:node_properties) @path = args[:path] if args.key?(:path) @target = args[:target] if args.key?(:target) end @@ -1314,6 +1433,11 @@ module Google # @return [String] attr_accessor :name + # The node properties of the SymlinkNode. + # Corresponds to the JSON property `nodeProperties` + # @return [Array] + attr_accessor :node_properties + # The target path of the symlink. The path separator is a forward slash `/`. # The target path can be relative to the parent directory of the symlink or # it can be an absolute path starting with `/`. Support for absolute paths @@ -1331,6 +1455,7 @@ module Google # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) + @node_properties = args[:node_properties] if args.key?(:node_properties) @target = args[:target] if args.key?(:target) end end @@ -1395,6 +1520,9 @@ module Google # * The files, directories and symlinks in the directory must each be sorted # in lexicographical order by path. The path strings must be sorted by code # point, equivalently, by UTF-8 bytes. + # * The NodeProperties of files, + # directories, and symlinks must be sorted in lexicographical order by + # property name. # A `Directory` that obeys the restrictions is said to be in canonical form. # As an example, the following could be used for a file named `bar` and a # directory named `foo` with an executable file named `baz` (hashes shortened @@ -1408,7 +1536,13 @@ module Google # digest: ` # hash: "4a73bc9d03...", # size: 65534 + # `, + # node_properties: [ # ` + # "name": "MTime", + # "value": "2017-01-15T01:30:15.01Z" + # ` + # ] # ` # ], # directories: [ @@ -1480,7 +1614,7 @@ module Google # @return [String] attr_accessor :docker_prep - # The timestamp when docker prepartion begins. + # The timestamp when docker preparation begins. # Corresponds to the JSON property `dockerPrepStartTime` # @return [String] attr_accessor :docker_prep_start_time @@ -2186,7 +2320,7 @@ module Google attr_accessor :worker_config # The desired number of workers in the worker pool. Must be a value between - # 0 and 1000. + # 0 and 15000. # Corresponds to the JSON property `workerCount` # @return [Fixnum] attr_accessor :worker_count diff --git a/generated/google/apis/remotebuildexecution_v1/representations.rb b/generated/google/apis/remotebuildexecution_v1/representations.rb index d055a3627..280035184 100644 --- a/generated/google/apis/remotebuildexecution_v1/representations.rb +++ b/generated/google/apis/remotebuildexecution_v1/representations.rb @@ -94,6 +94,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class BuildBazelRemoteExecutionV2NodeProperty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class BuildBazelRemoteExecutionV2OutputDirectory class Representation < Google::Apis::Core::JsonRepresentation; end @@ -402,6 +408,7 @@ module Google property :do_not_cache, as: 'doNotCache' property :input_root_digest, as: 'inputRootDigest', class: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest, decorator: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest::Representation + collection :output_node_properties, as: 'outputNodeProperties' property :timeout, as: 'timeout' end end @@ -420,6 +427,8 @@ module Google collection :output_files, as: 'outputFiles', class: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2OutputFile, decorator: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2OutputFile::Representation + collection :output_symlinks, as: 'outputSymlinks', class: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2OutputSymlink, decorator: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2OutputSymlink::Representation + property :stderr_digest, as: 'stderrDigest', class: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest, decorator: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest::Representation property :stderr_raw, :base64 => true, as: 'stderrRaw' @@ -437,6 +446,7 @@ module Google collection :output_directories, as: 'outputDirectories' collection :output_files, as: 'outputFiles' + collection :output_paths, as: 'outputPaths' property :platform, as: 'platform', class: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Platform, decorator: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Platform::Representation property :working_directory, as: 'workingDirectory' @@ -466,6 +476,8 @@ module Google collection :files, as: 'files', class: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2FileNode, decorator: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2FileNode::Representation + collection :node_properties, as: 'nodeProperties', class: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2NodeProperty, decorator: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2NodeProperty::Representation + collection :symlinks, as: 'symlinks', class: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2SymlinkNode, decorator: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2SymlinkNode::Representation end @@ -528,6 +540,8 @@ module Google property :is_executable, as: 'isExecutable' property :name, as: 'name' + collection :node_properties, as: 'nodeProperties', class: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2NodeProperty, decorator: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2NodeProperty::Representation + end end @@ -540,6 +554,14 @@ module Google end end + class BuildBazelRemoteExecutionV2NodeProperty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :value, as: 'value' + end + end + class BuildBazelRemoteExecutionV2OutputDirectory # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -556,6 +578,8 @@ module Google property :digest, as: 'digest', class: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest, decorator: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2Digest::Representation property :is_executable, as: 'isExecutable' + collection :node_properties, as: 'nodeProperties', class: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2NodeProperty, decorator: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2NodeProperty::Representation + property :path, as: 'path' end end @@ -563,6 +587,8 @@ module Google class BuildBazelRemoteExecutionV2OutputSymlink # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :node_properties, as: 'nodeProperties', class: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2NodeProperty, decorator: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2NodeProperty::Representation + property :path, as: 'path' property :target, as: 'target' end @@ -599,6 +625,8 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' + collection :node_properties, as: 'nodeProperties', class: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2NodeProperty, decorator: Google::Apis::RemotebuildexecutionV1::BuildBazelRemoteExecutionV2NodeProperty::Representation + property :target, as: 'target' end end diff --git a/generated/google/apis/remotebuildexecution_v1alpha.rb b/generated/google/apis/remotebuildexecution_v1alpha.rb index e1b7f6926..38d906d7d 100644 --- a/generated/google/apis/remotebuildexecution_v1alpha.rb +++ b/generated/google/apis/remotebuildexecution_v1alpha.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/remote-build-execution/docs/ module RemotebuildexecutionV1alpha VERSION = 'V1alpha' - REVISION = '20200303' + REVISION = '20200324' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/remotebuildexecution_v1alpha/classes.rb b/generated/google/apis/remotebuildexecution_v1alpha/classes.rb index ecab3087c..3bcb37eec 100644 --- a/generated/google/apis/remotebuildexecution_v1alpha/classes.rb +++ b/generated/google/apis/remotebuildexecution_v1alpha/classes.rb @@ -45,8 +45,7 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -83,8 +82,7 @@ module Google alias_method :do_not_cache?, :do_not_cache # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -113,6 +111,17 @@ module Google # @return [Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Digest] attr_accessor :input_root_digest + # List of required supported NodeProperty + # keys. In order to ensure that equivalent `Action`s always hash to the same + # value, the supported node properties MUST be lexicographically sorted by name. + # Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. + # The interpretation of these properties is server-dependent. If a property is + # not recognized by the server, the server will return an `INVALID_ARGUMENT` + # error. + # Corresponds to the JSON property `outputNodeProperties` + # @return [Array] + attr_accessor :output_node_properties + # A timeout after which the execution should be killed. If the timeout is # absent, then the client is specifying that the execution should continue # as long as the server will let it. The server SHOULD impose a timeout if @@ -141,6 +150,7 @@ module Google @command_digest = args[:command_digest] if args.key?(:command_digest) @do_not_cache = args[:do_not_cache] if args.key?(:do_not_cache) @input_root_digest = args[:input_root_digest] if args.key?(:input_root_digest) + @output_node_properties = args[:output_node_properties] if args.key?(:output_node_properties) @timeout = args[:timeout] if args.key?(:timeout) end end @@ -161,9 +171,9 @@ module Google attr_accessor :exit_code # The output directories of the action. For each output directory requested - # in the `output_directories` field of the Action, if the corresponding - # directory existed after the action completed, a single entry will be - # present in the output list, which will contain the digest of a + # in the `output_directories` or `output_paths` field of the Action, if the + # corresponding directory existed after the action completed, a single entry + # will be present in the output list, which will contain the digest of a # Tree message containing the # directory tree, and the path equal exactly to the corresponding Action # output_directories member. @@ -217,7 +227,8 @@ module Google # ` # ` # ``` - # If an output of the same name was found, but was not a directory, the + # If an output of the same name as listed in `output_files` of + # the Command was found in `output_directories`, but was not a directory, the # server will return a FAILED_PRECONDITION. # Corresponds to the JSON property `outputDirectories` # @return [Array] @@ -237,6 +248,8 @@ module Google # If the action does not produce the requested output, then that output # will be omitted from the list. The server is free to arrange the output # list as desired; clients MUST NOT assume that the output list is sorted. + # DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API + # should still populate this field in addition to `output_symlinks`. # Corresponds to the JSON property `outputDirectorySymlinks` # @return [Array] attr_accessor :output_directory_symlinks @@ -245,25 +258,28 @@ module Google # may be links to other output files, or input files, or even absolute paths # outside of the working directory, if the server supports # SymlinkAbsolutePathStrategy.ALLOWED. - # For each output file requested in the `output_files` field of the Action, - # if the corresponding file existed after + # For each output file requested in the `output_files` or `output_paths` + # field of the Action, if the corresponding file existed after # the action completed, a single entry will be present either in this field, # or in the `output_files` field, if the file was not a symbolic link. - # If an output symbolic link of the same name was found, but its target - # type was not a regular file, the server will return a FAILED_PRECONDITION. + # If an output symbolic link of the same name as listed in `output_files` of + # the Command was found, but its target type was not a regular file, the + # server will return a FAILED_PRECONDITION. # If the action does not produce the requested output, then that output # will be omitted from the list. The server is free to arrange the output # list as desired; clients MUST NOT assume that the output list is sorted. + # DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API + # should still populate this field in addition to `output_symlinks`. # Corresponds to the JSON property `outputFileSymlinks` # @return [Array] attr_accessor :output_file_symlinks # The output files of the action. For each output file requested in the - # `output_files` field of the Action, if the corresponding file existed after - # the action completed, a single entry will be present either in this field, - # or the `output_file_symlinks` field if the file was a symbolic link to - # another file. - # If an output of the same name was found, but was a directory rather + # `output_files` or `output_paths` field of the Action, if the corresponding + # file existed after the action completed, a single entry will be present + # either in this field, or the `output_file_symlinks` field if the file was + # a symbolic link to another file (`output_symlinks` field after v2.1). + # If an output listed in `output_files` was found, but was a directory rather # than a regular file, the server will return a FAILED_PRECONDITION. # If the action does not produce the requested output, then that output # will be omitted from the list. The server is free to arrange the output @@ -272,9 +288,25 @@ module Google # @return [Array] attr_accessor :output_files + # New in v2.1: this field will only be populated if the command + # `output_paths` field was used, and not the pre v2.1 `output_files` or + # `output_directories` fields. + # The output paths of the action that are symbolic links to other paths. Those + # may be links to other outputs, or inputs, or even absolute paths + # outside of the working directory, if the server supports + # SymlinkAbsolutePathStrategy.ALLOWED. + # A single entry for each output requested in `output_paths` + # field of the Action, if the corresponding path existed after + # the action completed and was a symbolic link. + # If the action does not produce a requested output, then that output + # will be omitted from the list. The server is free to arrange the output + # list as desired; clients MUST NOT assume that the output list is sorted. + # Corresponds to the JSON property `outputSymlinks` + # @return [Array] + attr_accessor :output_symlinks + # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -315,8 +347,7 @@ module Google attr_accessor :stderr_raw # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -368,6 +399,7 @@ module Google @output_directory_symlinks = args[:output_directory_symlinks] if args.key?(:output_directory_symlinks) @output_file_symlinks = args[:output_file_symlinks] if args.key?(:output_file_symlinks) @output_files = args[:output_files] if args.key?(:output_files) + @output_symlinks = args[:output_symlinks] if args.key?(:output_symlinks) @stderr_digest = args[:stderr_digest] if args.key?(:stderr_digest) @stderr_raw = args[:stderr_raw] if args.key?(:stderr_raw) @stdout_digest = args[:stdout_digest] if args.key?(:stdout_digest) @@ -425,6 +457,7 @@ module Google # Directories leading up to the output directories (but not the output # directories themselves) are created by the worker prior to execution, even # if they are not explicitly part of the input root. + # DEPRECATED since 2.1: Use `output_paths` instead. # Corresponds to the JSON property `outputDirectories` # @return [Array] attr_accessor :output_directories @@ -446,10 +479,39 @@ module Google # have the same path as any of the listed output directories. # Directories leading up to the output files are created by the worker prior # to execution, even if they are not explicitly part of the input root. + # DEPRECATED since v2.1: Use `output_paths` instead. # Corresponds to the JSON property `outputFiles` # @return [Array] attr_accessor :output_files + # A list of the output paths that the client expects to retrieve from the + # action. Only the listed paths will be returned to the client as output. + # The type of the output (file or directory) is not specified, and will be + # determined by the server after action execution. If the resulting path is + # a file, it will be returned in an + # OutputFile) typed field. + # If the path is a directory, the entire directory structure will be returned + # as a Tree message digest, see + # OutputDirectory) + # Other files or directories that may be created during command execution + # are discarded. + # The paths are relative to the working directory of the action execution. + # The paths are specified using a single forward slash (`/`) as a path + # separator, even if the execution platform natively uses a different + # separator. The path MUST NOT include a trailing slash, nor a leading slash, + # being a relative path. + # In order to ensure consistent hashing of the same Action, the output paths + # MUST be deduplicated and sorted lexicographically by code point (or, + # equivalently, by UTF-8 bytes). + # Directories leading up to the output paths are created by the worker prior + # to execution, even if they are not explicitly part of the input root. + # New in v2.1: this field supersedes the DEPRECATED `output_files` and + # `output_directories` fields. If `output_paths` is used, `output_files` and + # `output_directories` will be ignored! + # Corresponds to the JSON property `outputPaths` + # @return [Array] + attr_accessor :output_paths + # A `Platform` is a set of requirements, such as hardware, operating system, or # compiler toolchain, for an # Action's execution @@ -476,6 +538,7 @@ module Google @environment_variables = args[:environment_variables] if args.key?(:environment_variables) @output_directories = args[:output_directories] if args.key?(:output_directories) @output_files = args[:output_files] if args.key?(:output_files) + @output_paths = args[:output_paths] if args.key?(:output_paths) @platform = args[:platform] if args.key?(:platform) @working_directory = args[:working_directory] if args.key?(:working_directory) end @@ -508,8 +571,7 @@ module Google end # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -580,6 +642,9 @@ module Google # * The files, directories and symlinks in the directory must each be sorted # in lexicographical order by path. The path strings must be sorted by code # point, equivalently, by UTF-8 bytes. + # * The NodeProperties of files, + # directories, and symlinks must be sorted in lexicographical order by + # property name. # A `Directory` that obeys the restrictions is said to be in canonical form. # As an example, the following could be used for a file named `bar` and a # directory named `foo` with an executable file named `baz` (hashes shortened @@ -593,7 +658,13 @@ module Google # digest: ` # hash: "4a73bc9d03...", # size: 65534 + # `, + # node_properties: [ # ` + # "name": "MTime", + # "value": "2017-01-15T01:30:15.01Z" + # ` + # ] # ` # ], # directories: [ @@ -633,6 +704,11 @@ module Google # @return [Array] attr_accessor :files + # The node properties of the Directory. + # Corresponds to the JSON property `nodeProperties` + # @return [Array] + attr_accessor :node_properties + # The symlinks in the directory. # Corresponds to the JSON property `symlinks` # @return [Array] @@ -646,6 +722,7 @@ module Google def update!(**args) @directories = args[:directories] if args.key?(:directories) @files = args[:files] if args.key?(:files) + @node_properties = args[:node_properties] if args.key?(:node_properties) @symlinks = args[:symlinks] if args.key?(:symlinks) end end @@ -657,8 +734,7 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -712,8 +788,7 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -913,8 +988,7 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -954,6 +1028,11 @@ module Google # @return [String] attr_accessor :name + # The node properties of the FileNode. + # Corresponds to the JSON property `nodeProperties` + # @return [Array] + attr_accessor :node_properties + def initialize(**args) update!(**args) end @@ -963,6 +1042,7 @@ module Google @digest = args[:digest] if args.key?(:digest) @is_executable = args[:is_executable] if args.key?(:is_executable) @name = args[:name] if args.key?(:name) + @node_properties = args[:node_properties] if args.key?(:node_properties) end end @@ -971,8 +1051,7 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -1022,6 +1101,35 @@ module Google end end + # A single property for FileNodes, + # DirectoryNodes, and + # SymlinkNodes. The server is + # responsible for specifying the property `name`s that it accepts. If + # permitted by the server, the same `name` may occur multiple times. + class BuildBazelRemoteExecutionV2NodeProperty + include Google::Apis::Core::Hashable + + # The property name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The property value. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @value = args[:value] if args.key?(:value) + end + end + # An `OutputDirectory` is the output in an `ActionResult` corresponding to a # directory's full contents rather than a single file. class BuildBazelRemoteExecutionV2OutputDirectory @@ -1036,8 +1144,7 @@ module Google attr_accessor :path # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -1097,8 +1204,7 @@ module Google attr_accessor :contents # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -1133,6 +1239,11 @@ module Google attr_accessor :is_executable alias_method :is_executable?, :is_executable + # The supported node properties of the OutputFile, if requested by the Action. + # Corresponds to the JSON property `nodeProperties` + # @return [Array] + attr_accessor :node_properties + # The full path of the file relative to the working directory, including the # filename. The path separator is a forward slash `/`. Since this is a # relative path, it MUST NOT begin with a leading forward slash. @@ -1149,6 +1260,7 @@ module Google @contents = args[:contents] if args.key?(:contents) @digest = args[:digest] if args.key?(:digest) @is_executable = args[:is_executable] if args.key?(:is_executable) + @node_properties = args[:node_properties] if args.key?(:node_properties) @path = args[:path] if args.key?(:path) end end @@ -1160,6 +1272,12 @@ module Google class BuildBazelRemoteExecutionV2OutputSymlink include Google::Apis::Core::Hashable + # The supported node properties of the OutputSymlink, if requested by the + # Action. + # Corresponds to the JSON property `nodeProperties` + # @return [Array] + attr_accessor :node_properties + # The full path of the symlink relative to the working directory, including the # filename. The path separator is a forward slash `/`. Since this is a # relative path, it MUST NOT begin with a leading forward slash. @@ -1183,6 +1301,7 @@ module Google # Update properties of this object def update!(**args) + @node_properties = args[:node_properties] if args.key?(:node_properties) @path = args[:path] if args.key?(:path) @target = args[:target] if args.key?(:target) end @@ -1314,6 +1433,11 @@ module Google # @return [String] attr_accessor :name + # The node properties of the SymlinkNode. + # Corresponds to the JSON property `nodeProperties` + # @return [Array] + attr_accessor :node_properties + # The target path of the symlink. The path separator is a forward slash `/`. # The target path can be relative to the parent directory of the symlink or # it can be an absolute path starting with `/`. Support for absolute paths @@ -1331,6 +1455,7 @@ module Google # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) + @node_properties = args[:node_properties] if args.key?(:node_properties) @target = args[:target] if args.key?(:target) end end @@ -1395,6 +1520,9 @@ module Google # * The files, directories and symlinks in the directory must each be sorted # in lexicographical order by path. The path strings must be sorted by code # point, equivalently, by UTF-8 bytes. + # * The NodeProperties of files, + # directories, and symlinks must be sorted in lexicographical order by + # property name. # A `Directory` that obeys the restrictions is said to be in canonical form. # As an example, the following could be used for a file named `bar` and a # directory named `foo` with an executable file named `baz` (hashes shortened @@ -1408,7 +1536,13 @@ module Google # digest: ` # hash: "4a73bc9d03...", # size: 65534 + # `, + # node_properties: [ # ` + # "name": "MTime", + # "value": "2017-01-15T01:30:15.01Z" + # ` + # ] # ` # ], # directories: [ @@ -1461,7 +1595,7 @@ module Google # @return [String] attr_accessor :docker_prep - # The timestamp when docker prepartion begins. + # The timestamp when docker preparation begins. # Corresponds to the JSON property `dockerPrepStartTime` # @return [String] attr_accessor :docker_prep_start_time @@ -2167,7 +2301,7 @@ module Google attr_accessor :worker_config # The desired number of workers in the worker pool. Must be a value between - # 0 and 1000. + # 0 and 15000. # Corresponds to the JSON property `workerCount` # @return [Fixnum] attr_accessor :worker_count diff --git a/generated/google/apis/remotebuildexecution_v1alpha/representations.rb b/generated/google/apis/remotebuildexecution_v1alpha/representations.rb index 4a39daffb..f7bc9561b 100644 --- a/generated/google/apis/remotebuildexecution_v1alpha/representations.rb +++ b/generated/google/apis/remotebuildexecution_v1alpha/representations.rb @@ -94,6 +94,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class BuildBazelRemoteExecutionV2NodeProperty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class BuildBazelRemoteExecutionV2OutputDirectory class Representation < Google::Apis::Core::JsonRepresentation; end @@ -378,6 +384,7 @@ module Google property :do_not_cache, as: 'doNotCache' property :input_root_digest, as: 'inputRootDigest', class: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Digest, decorator: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Digest::Representation + collection :output_node_properties, as: 'outputNodeProperties' property :timeout, as: 'timeout' end end @@ -396,6 +403,8 @@ module Google collection :output_files, as: 'outputFiles', class: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2OutputFile, decorator: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2OutputFile::Representation + collection :output_symlinks, as: 'outputSymlinks', class: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2OutputSymlink, decorator: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2OutputSymlink::Representation + property :stderr_digest, as: 'stderrDigest', class: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Digest, decorator: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Digest::Representation property :stderr_raw, :base64 => true, as: 'stderrRaw' @@ -413,6 +422,7 @@ module Google collection :output_directories, as: 'outputDirectories' collection :output_files, as: 'outputFiles' + collection :output_paths, as: 'outputPaths' property :platform, as: 'platform', class: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Platform, decorator: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Platform::Representation property :working_directory, as: 'workingDirectory' @@ -442,6 +452,8 @@ module Google collection :files, as: 'files', class: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2FileNode, decorator: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2FileNode::Representation + collection :node_properties, as: 'nodeProperties', class: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2NodeProperty, decorator: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2NodeProperty::Representation + collection :symlinks, as: 'symlinks', class: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2SymlinkNode, decorator: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2SymlinkNode::Representation end @@ -504,6 +516,8 @@ module Google property :is_executable, as: 'isExecutable' property :name, as: 'name' + collection :node_properties, as: 'nodeProperties', class: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2NodeProperty, decorator: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2NodeProperty::Representation + end end @@ -516,6 +530,14 @@ module Google end end + class BuildBazelRemoteExecutionV2NodeProperty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :value, as: 'value' + end + end + class BuildBazelRemoteExecutionV2OutputDirectory # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -532,6 +554,8 @@ module Google property :digest, as: 'digest', class: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Digest, decorator: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2Digest::Representation property :is_executable, as: 'isExecutable' + collection :node_properties, as: 'nodeProperties', class: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2NodeProperty, decorator: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2NodeProperty::Representation + property :path, as: 'path' end end @@ -539,6 +563,8 @@ module Google class BuildBazelRemoteExecutionV2OutputSymlink # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :node_properties, as: 'nodeProperties', class: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2NodeProperty, decorator: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2NodeProperty::Representation + property :path, as: 'path' property :target, as: 'target' end @@ -575,6 +601,8 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' + collection :node_properties, as: 'nodeProperties', class: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2NodeProperty, decorator: Google::Apis::RemotebuildexecutionV1alpha::BuildBazelRemoteExecutionV2NodeProperty::Representation + property :target, as: 'target' end end diff --git a/generated/google/apis/remotebuildexecution_v2.rb b/generated/google/apis/remotebuildexecution_v2.rb index 45a7b3d14..4cd7e315e 100644 --- a/generated/google/apis/remotebuildexecution_v2.rb +++ b/generated/google/apis/remotebuildexecution_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/remote-build-execution/docs/ module RemotebuildexecutionV2 VERSION = 'V2' - REVISION = '20200303' + REVISION = '20200324' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/remotebuildexecution_v2/classes.rb b/generated/google/apis/remotebuildexecution_v2/classes.rb index 4ff5859c6..ac0be9434 100644 --- a/generated/google/apis/remotebuildexecution_v2/classes.rb +++ b/generated/google/apis/remotebuildexecution_v2/classes.rb @@ -45,8 +45,7 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -83,8 +82,7 @@ module Google alias_method :do_not_cache?, :do_not_cache # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -113,6 +111,17 @@ module Google # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest] attr_accessor :input_root_digest + # List of required supported NodeProperty + # keys. In order to ensure that equivalent `Action`s always hash to the same + # value, the supported node properties MUST be lexicographically sorted by name. + # Sorting of strings is done by code point, equivalently, by the UTF-8 bytes. + # The interpretation of these properties is server-dependent. If a property is + # not recognized by the server, the server will return an `INVALID_ARGUMENT` + # error. + # Corresponds to the JSON property `outputNodeProperties` + # @return [Array] + attr_accessor :output_node_properties + # A timeout after which the execution should be killed. If the timeout is # absent, then the client is specifying that the execution should continue # as long as the server will let it. The server SHOULD impose a timeout if @@ -141,6 +150,7 @@ module Google @command_digest = args[:command_digest] if args.key?(:command_digest) @do_not_cache = args[:do_not_cache] if args.key?(:do_not_cache) @input_root_digest = args[:input_root_digest] if args.key?(:input_root_digest) + @output_node_properties = args[:output_node_properties] if args.key?(:output_node_properties) @timeout = args[:timeout] if args.key?(:timeout) end end @@ -181,9 +191,9 @@ module Google attr_accessor :exit_code # The output directories of the action. For each output directory requested - # in the `output_directories` field of the Action, if the corresponding - # directory existed after the action completed, a single entry will be - # present in the output list, which will contain the digest of a + # in the `output_directories` or `output_paths` field of the Action, if the + # corresponding directory existed after the action completed, a single entry + # will be present in the output list, which will contain the digest of a # Tree message containing the # directory tree, and the path equal exactly to the corresponding Action # output_directories member. @@ -237,7 +247,8 @@ module Google # ` # ` # ``` - # If an output of the same name was found, but was not a directory, the + # If an output of the same name as listed in `output_files` of + # the Command was found in `output_directories`, but was not a directory, the # server will return a FAILED_PRECONDITION. # Corresponds to the JSON property `outputDirectories` # @return [Array] @@ -257,6 +268,8 @@ module Google # If the action does not produce the requested output, then that output # will be omitted from the list. The server is free to arrange the output # list as desired; clients MUST NOT assume that the output list is sorted. + # DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API + # should still populate this field in addition to `output_symlinks`. # Corresponds to the JSON property `outputDirectorySymlinks` # @return [Array] attr_accessor :output_directory_symlinks @@ -265,25 +278,28 @@ module Google # may be links to other output files, or input files, or even absolute paths # outside of the working directory, if the server supports # SymlinkAbsolutePathStrategy.ALLOWED. - # For each output file requested in the `output_files` field of the Action, - # if the corresponding file existed after + # For each output file requested in the `output_files` or `output_paths` + # field of the Action, if the corresponding file existed after # the action completed, a single entry will be present either in this field, # or in the `output_files` field, if the file was not a symbolic link. - # If an output symbolic link of the same name was found, but its target - # type was not a regular file, the server will return a FAILED_PRECONDITION. + # If an output symbolic link of the same name as listed in `output_files` of + # the Command was found, but its target type was not a regular file, the + # server will return a FAILED_PRECONDITION. # If the action does not produce the requested output, then that output # will be omitted from the list. The server is free to arrange the output # list as desired; clients MUST NOT assume that the output list is sorted. + # DEPRECATED as of v2.1. Servers that wish to be compatible with v2.0 API + # should still populate this field in addition to `output_symlinks`. # Corresponds to the JSON property `outputFileSymlinks` # @return [Array] attr_accessor :output_file_symlinks # The output files of the action. For each output file requested in the - # `output_files` field of the Action, if the corresponding file existed after - # the action completed, a single entry will be present either in this field, - # or the `output_file_symlinks` field if the file was a symbolic link to - # another file. - # If an output of the same name was found, but was a directory rather + # `output_files` or `output_paths` field of the Action, if the corresponding + # file existed after the action completed, a single entry will be present + # either in this field, or the `output_file_symlinks` field if the file was + # a symbolic link to another file (`output_symlinks` field after v2.1). + # If an output listed in `output_files` was found, but was a directory rather # than a regular file, the server will return a FAILED_PRECONDITION. # If the action does not produce the requested output, then that output # will be omitted from the list. The server is free to arrange the output @@ -292,9 +308,25 @@ module Google # @return [Array] attr_accessor :output_files + # New in v2.1: this field will only be populated if the command + # `output_paths` field was used, and not the pre v2.1 `output_files` or + # `output_directories` fields. + # The output paths of the action that are symbolic links to other paths. Those + # may be links to other outputs, or inputs, or even absolute paths + # outside of the working directory, if the server supports + # SymlinkAbsolutePathStrategy.ALLOWED. + # A single entry for each output requested in `output_paths` + # field of the Action, if the corresponding path existed after + # the action completed and was a symbolic link. + # If the action does not produce a requested output, then that output + # will be omitted from the list. The server is free to arrange the output + # list as desired; clients MUST NOT assume that the output list is sorted. + # Corresponds to the JSON property `outputSymlinks` + # @return [Array] + attr_accessor :output_symlinks + # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -335,8 +367,7 @@ module Google attr_accessor :stderr_raw # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -388,6 +419,7 @@ module Google @output_directory_symlinks = args[:output_directory_symlinks] if args.key?(:output_directory_symlinks) @output_file_symlinks = args[:output_file_symlinks] if args.key?(:output_file_symlinks) @output_files = args[:output_files] if args.key?(:output_files) + @output_symlinks = args[:output_symlinks] if args.key?(:output_symlinks) @stderr_digest = args[:stderr_digest] if args.key?(:stderr_digest) @stderr_raw = args[:stderr_raw] if args.key?(:stderr_raw) @stdout_digest = args[:stdout_digest] if args.key?(:stdout_digest) @@ -446,8 +478,7 @@ module Google attr_accessor :data # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -529,8 +560,7 @@ module Google attr_accessor :data # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -595,8 +625,7 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -745,6 +774,7 @@ module Google # Directories leading up to the output directories (but not the output # directories themselves) are created by the worker prior to execution, even # if they are not explicitly part of the input root. + # DEPRECATED since 2.1: Use `output_paths` instead. # Corresponds to the JSON property `outputDirectories` # @return [Array] attr_accessor :output_directories @@ -766,10 +796,39 @@ module Google # have the same path as any of the listed output directories. # Directories leading up to the output files are created by the worker prior # to execution, even if they are not explicitly part of the input root. + # DEPRECATED since v2.1: Use `output_paths` instead. # Corresponds to the JSON property `outputFiles` # @return [Array] attr_accessor :output_files + # A list of the output paths that the client expects to retrieve from the + # action. Only the listed paths will be returned to the client as output. + # The type of the output (file or directory) is not specified, and will be + # determined by the server after action execution. If the resulting path is + # a file, it will be returned in an + # OutputFile) typed field. + # If the path is a directory, the entire directory structure will be returned + # as a Tree message digest, see + # OutputDirectory) + # Other files or directories that may be created during command execution + # are discarded. + # The paths are relative to the working directory of the action execution. + # The paths are specified using a single forward slash (`/`) as a path + # separator, even if the execution platform natively uses a different + # separator. The path MUST NOT include a trailing slash, nor a leading slash, + # being a relative path. + # In order to ensure consistent hashing of the same Action, the output paths + # MUST be deduplicated and sorted lexicographically by code point (or, + # equivalently, by UTF-8 bytes). + # Directories leading up to the output paths are created by the worker prior + # to execution, even if they are not explicitly part of the input root. + # New in v2.1: this field supersedes the DEPRECATED `output_files` and + # `output_directories` fields. If `output_paths` is used, `output_files` and + # `output_directories` will be ignored! + # Corresponds to the JSON property `outputPaths` + # @return [Array] + attr_accessor :output_paths + # A `Platform` is a set of requirements, such as hardware, operating system, or # compiler toolchain, for an # Action's execution @@ -796,6 +855,7 @@ module Google @environment_variables = args[:environment_variables] if args.key?(:environment_variables) @output_directories = args[:output_directories] if args.key?(:output_directories) @output_files = args[:output_files] if args.key?(:output_files) + @output_paths = args[:output_paths] if args.key?(:output_paths) @platform = args[:platform] if args.key?(:platform) @working_directory = args[:working_directory] if args.key?(:working_directory) end @@ -828,8 +888,7 @@ module Google end # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -900,6 +959,9 @@ module Google # * The files, directories and symlinks in the directory must each be sorted # in lexicographical order by path. The path strings must be sorted by code # point, equivalently, by UTF-8 bytes. + # * The NodeProperties of files, + # directories, and symlinks must be sorted in lexicographical order by + # property name. # A `Directory` that obeys the restrictions is said to be in canonical form. # As an example, the following could be used for a file named `bar` and a # directory named `foo` with an executable file named `baz` (hashes shortened @@ -913,7 +975,13 @@ module Google # digest: ` # hash: "4a73bc9d03...", # size: 65534 + # `, + # node_properties: [ # ` + # "name": "MTime", + # "value": "2017-01-15T01:30:15.01Z" + # ` + # ] # ` # ], # directories: [ @@ -953,6 +1021,11 @@ module Google # @return [Array] attr_accessor :files + # The node properties of the Directory. + # Corresponds to the JSON property `nodeProperties` + # @return [Array] + attr_accessor :node_properties + # The symlinks in the directory. # Corresponds to the JSON property `symlinks` # @return [Array] @@ -966,6 +1039,7 @@ module Google def update!(**args) @directories = args[:directories] if args.key?(:directories) @files = args[:files] if args.key?(:files) + @node_properties = args[:node_properties] if args.key?(:node_properties) @symlinks = args[:symlinks] if args.key?(:symlinks) end end @@ -977,8 +1051,7 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -1032,8 +1105,7 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -1100,8 +1172,7 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -1328,6 +1399,11 @@ module Google # @return [Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2PriorityCapabilities] attr_accessor :execution_priority_capabilities + # Supported node properties. + # Corresponds to the JSON property `supportedNodeProperties` + # @return [Array] + attr_accessor :supported_node_properties + def initialize(**args) update!(**args) end @@ -1337,6 +1413,7 @@ module Google @digest_function = args[:digest_function] if args.key?(:digest_function) @exec_enabled = args[:exec_enabled] if args.key?(:exec_enabled) @execution_priority_capabilities = args[:execution_priority_capabilities] if args.key?(:execution_priority_capabilities) + @supported_node_properties = args[:supported_node_properties] if args.key?(:supported_node_properties) end end @@ -1372,8 +1449,7 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -1413,6 +1489,11 @@ module Google # @return [String] attr_accessor :name + # The node properties of the FileNode. + # Corresponds to the JSON property `nodeProperties` + # @return [Array] + attr_accessor :node_properties + def initialize(**args) update!(**args) end @@ -1422,6 +1503,7 @@ module Google @digest = args[:digest] if args.key?(:digest) @is_executable = args[:is_executable] if args.key?(:is_executable) @name = args[:name] if args.key?(:name) + @node_properties = args[:node_properties] if args.key?(:node_properties) end end @@ -1499,8 +1581,7 @@ module Google include Google::Apis::Core::Hashable # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -1550,6 +1631,35 @@ module Google end end + # A single property for FileNodes, + # DirectoryNodes, and + # SymlinkNodes. The server is + # responsible for specifying the property `name`s that it accepts. If + # permitted by the server, the same `name` may occur multiple times. + class BuildBazelRemoteExecutionV2NodeProperty + include Google::Apis::Core::Hashable + + # The property name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The property value. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @value = args[:value] if args.key?(:value) + end + end + # An `OutputDirectory` is the output in an `ActionResult` corresponding to a # directory's full contents rather than a single file. class BuildBazelRemoteExecutionV2OutputDirectory @@ -1564,8 +1674,7 @@ module Google attr_accessor :path # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -1625,8 +1734,7 @@ module Google attr_accessor :contents # A content digest. A digest for a given blob consists of the size of the blob - # and its hash. The hash algorithm to use is defined by the server, but servers - # SHOULD use SHA-256. + # and its hash. The hash algorithm to use is defined by the server. # The size is considered to be an integral part of the digest and cannot be # separated. That is, even if the `hash` field is correctly specified but # `size_bytes` is not, the server MUST reject the request. @@ -1661,6 +1769,11 @@ module Google attr_accessor :is_executable alias_method :is_executable?, :is_executable + # The supported node properties of the OutputFile, if requested by the Action. + # Corresponds to the JSON property `nodeProperties` + # @return [Array] + attr_accessor :node_properties + # The full path of the file relative to the working directory, including the # filename. The path separator is a forward slash `/`. Since this is a # relative path, it MUST NOT begin with a leading forward slash. @@ -1677,6 +1790,7 @@ module Google @contents = args[:contents] if args.key?(:contents) @digest = args[:digest] if args.key?(:digest) @is_executable = args[:is_executable] if args.key?(:is_executable) + @node_properties = args[:node_properties] if args.key?(:node_properties) @path = args[:path] if args.key?(:path) end end @@ -1688,6 +1802,12 @@ module Google class BuildBazelRemoteExecutionV2OutputSymlink include Google::Apis::Core::Hashable + # The supported node properties of the OutputSymlink, if requested by the + # Action. + # Corresponds to the JSON property `nodeProperties` + # @return [Array] + attr_accessor :node_properties + # The full path of the symlink relative to the working directory, including the # filename. The path separator is a forward slash `/`. Since this is a # relative path, it MUST NOT begin with a leading forward slash. @@ -1711,6 +1831,7 @@ module Google # Update properties of this object def update!(**args) + @node_properties = args[:node_properties] if args.key?(:node_properties) @path = args[:path] if args.key?(:path) @target = args[:target] if args.key?(:target) end @@ -1958,6 +2079,11 @@ module Google # @return [String] attr_accessor :name + # The node properties of the SymlinkNode. + # Corresponds to the JSON property `nodeProperties` + # @return [Array] + attr_accessor :node_properties + # The target path of the symlink. The path separator is a forward slash `/`. # The target path can be relative to the parent directory of the symlink or # it can be an absolute path starting with `/`. Support for absolute paths @@ -1975,6 +2101,7 @@ module Google # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) + @node_properties = args[:node_properties] if args.key?(:node_properties) @target = args[:target] if args.key?(:target) end end @@ -2039,6 +2166,9 @@ module Google # * The files, directories and symlinks in the directory must each be sorted # in lexicographical order by path. The path strings must be sorted by code # point, equivalently, by UTF-8 bytes. + # * The NodeProperties of files, + # directories, and symlinks must be sorted in lexicographical order by + # property name. # A `Directory` that obeys the restrictions is said to be in canonical form. # As an example, the following could be used for a file named `bar` and a # directory named `foo` with an executable file named `baz` (hashes shortened @@ -2052,7 +2182,13 @@ module Google # digest: ` # hash: "4a73bc9d03...", # size: 65534 + # `, + # node_properties: [ # ` + # "name": "MTime", + # "value": "2017-01-15T01:30:15.01Z" + # ` + # ] # ` # ], # directories: [ @@ -2158,7 +2294,7 @@ module Google # @return [String] attr_accessor :docker_prep - # The timestamp when docker prepartion begins. + # The timestamp when docker preparation begins. # Corresponds to the JSON property `dockerPrepStartTime` # @return [String] attr_accessor :docker_prep_start_time @@ -2864,7 +3000,7 @@ module Google attr_accessor :worker_config # The desired number of workers in the worker pool. Must be a value between - # 0 and 1000. + # 0 and 15000. # Corresponds to the JSON property `workerCount` # @return [Fixnum] attr_accessor :worker_count diff --git a/generated/google/apis/remotebuildexecution_v2/representations.rb b/generated/google/apis/remotebuildexecution_v2/representations.rb index 34706dc55..d9e156d6f 100644 --- a/generated/google/apis/remotebuildexecution_v2/representations.rb +++ b/generated/google/apis/remotebuildexecution_v2/representations.rb @@ -184,6 +184,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class BuildBazelRemoteExecutionV2NodeProperty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class BuildBazelRemoteExecutionV2OutputDirectory class Representation < Google::Apis::Core::JsonRepresentation; end @@ -504,6 +510,7 @@ module Google property :do_not_cache, as: 'doNotCache' property :input_root_digest, as: 'inputRootDigest', class: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest, decorator: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest::Representation + collection :output_node_properties, as: 'outputNodeProperties' property :timeout, as: 'timeout' end end @@ -529,6 +536,8 @@ module Google collection :output_files, as: 'outputFiles', class: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2OutputFile, decorator: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2OutputFile::Representation + collection :output_symlinks, as: 'outputSymlinks', class: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2OutputSymlink, decorator: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2OutputSymlink::Representation + property :stderr_digest, as: 'stderrDigest', class: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest, decorator: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest::Representation property :stderr_raw, :base64 => true, as: 'stderrRaw' @@ -621,6 +630,7 @@ module Google collection :output_directories, as: 'outputDirectories' collection :output_files, as: 'outputFiles' + collection :output_paths, as: 'outputPaths' property :platform, as: 'platform', class: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Platform, decorator: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Platform::Representation property :working_directory, as: 'workingDirectory' @@ -650,6 +660,8 @@ module Google collection :files, as: 'files', class: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2FileNode, decorator: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2FileNode::Representation + collection :node_properties, as: 'nodeProperties', class: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2NodeProperty, decorator: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2NodeProperty::Representation + collection :symlinks, as: 'symlinks', class: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2SymlinkNode, decorator: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2SymlinkNode::Representation end @@ -725,6 +737,7 @@ module Google property :exec_enabled, as: 'execEnabled' property :execution_priority_capabilities, as: 'executionPriorityCapabilities', class: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2PriorityCapabilities, decorator: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2PriorityCapabilities::Representation + collection :supported_node_properties, as: 'supportedNodeProperties' end end @@ -742,6 +755,8 @@ module Google property :is_executable, as: 'isExecutable' property :name, as: 'name' + collection :node_properties, as: 'nodeProperties', class: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2NodeProperty, decorator: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2NodeProperty::Representation + end end @@ -779,6 +794,14 @@ module Google end end + class BuildBazelRemoteExecutionV2NodeProperty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :value, as: 'value' + end + end + class BuildBazelRemoteExecutionV2OutputDirectory # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -795,6 +818,8 @@ module Google property :digest, as: 'digest', class: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest, decorator: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2Digest::Representation property :is_executable, as: 'isExecutable' + collection :node_properties, as: 'nodeProperties', class: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2NodeProperty, decorator: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2NodeProperty::Representation + property :path, as: 'path' end end @@ -802,6 +827,8 @@ module Google class BuildBazelRemoteExecutionV2OutputSymlink # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :node_properties, as: 'nodeProperties', class: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2NodeProperty, decorator: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2NodeProperty::Representation + property :path, as: 'path' property :target, as: 'target' end @@ -877,6 +904,8 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' + collection :node_properties, as: 'nodeProperties', class: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2NodeProperty, decorator: Google::Apis::RemotebuildexecutionV2::BuildBazelRemoteExecutionV2NodeProperty::Representation + property :target, as: 'target' end end diff --git a/generated/google/apis/remotebuildexecution_v2/service.rb b/generated/google/apis/remotebuildexecution_v2/service.rb index ba261d9ec..f96a46bc7 100644 --- a/generated/google/apis/remotebuildexecution_v2/service.rb +++ b/generated/google/apis/remotebuildexecution_v2/service.rb @@ -374,6 +374,8 @@ module Google # Determine if blobs are present in the CAS. # Clients can use this API before uploading blobs to determine which ones are # already present in the CAS and do not need to be uploaded again. + # Servers SHOULD increase the TTLs of the referenced blobs if necessary and + # applicable. # There are no method-specific errors. # @param [String] instance_name # The instance of the execution system to operate against. A server may @@ -426,6 +428,7 @@ module Google # multiple invocations of `GetTree`. # If part of the tree is missing from the CAS, the server will return the # portion present and omit the rest. + # Errors: # * `NOT_FOUND`: The requested tree root is not present in the CAS. # @param [String] instance_name # The instance of the execution system to operate against. A server may @@ -446,7 +449,8 @@ module Google # @param [String] page_token # A page token, which must be a value received in a previous # GetTreeResponse. - # If present, the server will use it to return the following page of results. + # If present, the server will use that token as an offset, returning only + # that page and the ones that succeed it. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/run_v1.rb b/generated/google/apis/run_v1.rb index 0f647be52..042ee9cd3 100644 --- a/generated/google/apis/run_v1.rb +++ b/generated/google/apis/run_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/run/ module RunV1 VERSION = 'V1' - REVISION = '20200302' + REVISION = '20200327' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/run_v1/classes.rb b/generated/google/apis/run_v1/classes.rb index 0213cf26e..9e5dad964 100644 --- a/generated/google/apis/run_v1/classes.rb +++ b/generated/google/apis/run_v1/classes.rb @@ -634,14 +634,11 @@ module Google attr_accessor :name # (Optional) - # Cloud Run fully managed: not supported - # Cloud Run for Anthos: supported - # List of ports to expose from the container. Exposing a port here gives - # the system additional information about the network connections a - # container uses, but is primarily informational. Not specifying a port here - # DOES NOT prevent that port from being exposed. Any port which is - # listening on the default "0.0.0.0" address inside a container will be - # accessible from the network. + # List of ports to expose from the container. Only a single port can be + # specified. The specified ports must be listening on all interfaces + # (0.0.0.0) within the container to be accessible. + # If omitted, a port number will be chosen and passed to the container + # through the PORT environment variable for the container to listen on. # Corresponds to the JSON property `ports` # @return [Array] attr_accessor :ports @@ -738,15 +735,11 @@ module Google end end - # Cloud Run fully managed: not supported - # Cloud Run for Anthos: supported # ContainerPort represents a network port in a single container. class ContainerPort include Google::Apis::Core::Hashable # (Optional) - # Cloud Run fully managed: supported - # Cloud Run for Anthos: supported # Port number the container listens on. # This must be a valid port number, 0 < x < 65536. # Corresponds to the JSON property `containerPort` @@ -765,7 +758,7 @@ module Google # (Optional) # Cloud Run fully managed: not supported # Cloud Run for Anthos: supported - # Protocol for port. Must be TCP. + # Protocol for port. Must be "TCP". # Defaults to "TCP". # Corresponds to the JSON property `protocol` # @return [String] diff --git a/generated/google/apis/sasportal_v1alpha1.rb b/generated/google/apis/sasportal_v1alpha1.rb index 4c7716a33..0c43c3afe 100644 --- a/generated/google/apis/sasportal_v1alpha1.rb +++ b/generated/google/apis/sasportal_v1alpha1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/spectrum-access-system/ module SasportalV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200220' + REVISION = '20200405' # View your email address AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' diff --git a/generated/google/apis/sasportal_v1alpha1/classes.rb b/generated/google/apis/sasportal_v1alpha1/classes.rb index 934d1b311..5bb72cce6 100644 --- a/generated/google/apis/sasportal_v1alpha1/classes.rb +++ b/generated/google/apis/sasportal_v1alpha1/classes.rb @@ -96,7 +96,7 @@ module Google include Google::Apis::Core::Hashable # Required. JSON Web Token signed using a CPI private key. Payload - # must be the JSON encoding of the [Device]. + # must be the JSON encoding of the [Device]. The user_id field must be set. # Corresponds to the JSON property `encodedDevice` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -291,7 +291,7 @@ module Google # @return [String] attr_accessor :update_time - # Output only. The identifier of a device user. + # The identifier of a device user. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id @@ -946,6 +946,7 @@ module Google # Required. The device to sign. # The device fields name, fcc_id and serial_number must be set. + # The user_id field must be set. # Corresponds to the JSON property `device` # @return [Google::Apis::SasportalV1alpha1::SasPortalDevice] attr_accessor :device @@ -1049,7 +1050,7 @@ module Google # Required. The JSON Web Token signed using a CPI private key. Payload # must be the JSON encoding - # of the device. + # of the device. The user_id field must be set. # Corresponds to the JSON property `encodedDevice` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] diff --git a/generated/google/apis/sasportal_v1alpha1/service.rb b/generated/google/apis/sasportal_v1alpha1/service.rb index 059291fd0..9c12aaa48 100644 --- a/generated/google/apis/sasportal_v1alpha1/service.rb +++ b/generated/google/apis/sasportal_v1alpha1/service.rb @@ -686,6 +686,76 @@ module Google execute_or_queue_command(command, &block) end + # Creates a new node. + # @param [String] parent + # Required. The parent resource name where the node is to be created. + # @param [Google::Apis::SasportalV1alpha1::SasPortalNode] sas_portal_node_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SasportalV1alpha1::SasPortalNode] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SasportalV1alpha1::SasPortalNode] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_customer_node_node(parent, sas_portal_node_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+parent}/nodes', options) + command.request_representation = Google::Apis::SasportalV1alpha1::SasPortalNode::Representation + command.request_object = sas_portal_node_object + command.response_representation = Google::Apis::SasportalV1alpha1::SasPortalNode::Representation + command.response_class = Google::Apis::SasportalV1alpha1::SasPortalNode + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists nodes. + # @param [String] parent + # Required. The parent resource name, for example, "nodes/1". + # @param [Fixnum] page_size + # The maximum number of nodes to return in the response. + # @param [String] page_token + # A pagination token returned from a previous call to ListNodes method + # that indicates where this listing should continue from. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SasportalV1alpha1::SasPortalListNodesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SasportalV1alpha1::SasPortalListNodesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_customer_node_nodes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+parent}/nodes', options) + command.response_representation = Google::Apis::SasportalV1alpha1::SasPortalListNodesResponse::Representation + command.response_class = Google::Apis::SasportalV1alpha1::SasPortalListNodesResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Generates a secret to be used with the ValidateInstaller method # @param [Google::Apis::SasportalV1alpha1::SasPortalGenerateSecretRequest] sas_portal_generate_secret_request_object # @param [String] fields @@ -1283,6 +1353,218 @@ module Google execute_or_queue_command(command, &block) end + # Creates a device under a node or customer. Returned devices are unordered. + # @param [String] parent + # Required. The name of the parent resource. + # @param [Google::Apis::SasportalV1alpha1::SasPortalBulkCreateDeviceRequest] sas_portal_bulk_create_device_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SasportalV1alpha1::SasPortalBulkCreateDeviceResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SasportalV1alpha1::SasPortalBulkCreateDeviceResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def bulk_node_node_device(parent, sas_portal_bulk_create_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+parent}/devices:bulk', options) + command.request_representation = Google::Apis::SasportalV1alpha1::SasPortalBulkCreateDeviceRequest::Representation + command.request_object = sas_portal_bulk_create_device_request_object + command.response_representation = Google::Apis::SasportalV1alpha1::SasPortalBulkCreateDeviceResponse::Representation + command.response_class = Google::Apis::SasportalV1alpha1::SasPortalBulkCreateDeviceResponse + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a device under a node or customer. + # @param [String] parent + # Required. The name of the parent resource. + # @param [Google::Apis::SasportalV1alpha1::SasPortalDevice] sas_portal_device_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SasportalV1alpha1::SasPortalDevice] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SasportalV1alpha1::SasPortalDevice] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_node_node_device(parent, sas_portal_device_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+parent}/devices', options) + command.request_representation = Google::Apis::SasportalV1alpha1::SasPortalDevice::Representation + command.request_object = sas_portal_device_object + command.response_representation = Google::Apis::SasportalV1alpha1::SasPortalDevice::Representation + command.response_class = Google::Apis::SasportalV1alpha1::SasPortalDevice + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a signed device under a + # node or customer. + # @param [String] parent + # Required. The name of the parent resource. + # @param [Google::Apis::SasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SasportalV1alpha1::SasPortalDevice] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SasportalV1alpha1::SasPortalDevice] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_node_node_device_signed(parent, sas_portal_create_signed_device_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+parent}/devices:createSigned', options) + command.request_representation = Google::Apis::SasportalV1alpha1::SasPortalCreateSignedDeviceRequest::Representation + command.request_object = sas_portal_create_signed_device_request_object + command.response_representation = Google::Apis::SasportalV1alpha1::SasPortalDevice::Representation + command.response_class = Google::Apis::SasportalV1alpha1::SasPortalDevice + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists devices under a node or customer. + # @param [String] parent + # Required. The name of the parent resource. + # @param [String] filter + # The filter expression. The filter should have one of the following + # formats: "sn=123454" or "display_name=MyDevice". sn + # corresponds to serial_number of the device. The filter is case insensitive. + # @param [Fixnum] page_size + # The maximum number of devices to return in the response. + # @param [String] page_token + # A pagination token returned from a previous call to ListDevices + # that indicates where this listing should continue from. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SasportalV1alpha1::SasPortalListDevicesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SasportalV1alpha1::SasPortalListDevicesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_node_node_devices(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+parent}/devices', options) + command.response_representation = Google::Apis::SasportalV1alpha1::SasPortalListDevicesResponse::Representation + command.response_class = Google::Apis::SasportalV1alpha1::SasPortalListDevicesResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new node. + # @param [String] parent + # Required. The parent resource name where the node is to be created. + # @param [Google::Apis::SasportalV1alpha1::SasPortalNode] sas_portal_node_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SasportalV1alpha1::SasPortalNode] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SasportalV1alpha1::SasPortalNode] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_node_node_node(parent, sas_portal_node_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+parent}/nodes', options) + command.request_representation = Google::Apis::SasportalV1alpha1::SasPortalNode::Representation + command.request_object = sas_portal_node_object + command.response_representation = Google::Apis::SasportalV1alpha1::SasPortalNode::Representation + command.response_class = Google::Apis::SasportalV1alpha1::SasPortalNode + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists nodes. + # @param [String] parent + # Required. The parent resource name, for example, "nodes/1". + # @param [Fixnum] page_size + # The maximum number of nodes to return in the response. + # @param [String] page_token + # A pagination token returned from a previous call to ListNodes method + # that indicates where this listing should continue from. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SasportalV1alpha1::SasPortalListNodesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SasportalV1alpha1::SasPortalListNodesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_node_node_nodes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+parent}/nodes', options) + command.response_representation = Google::Apis::SasportalV1alpha1::SasPortalListNodesResponse::Representation + command.response_class = Google::Apis::SasportalV1alpha1::SasPortalListNodesResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Gets the access control policy for a resource. # Returns an empty policy if the resource exists and does not have a policy # set. diff --git a/generated/google/apis/secretmanager_v1.rb b/generated/google/apis/secretmanager_v1.rb index f02216812..0ff6d7ad9 100644 --- a/generated/google/apis/secretmanager_v1.rb +++ b/generated/google/apis/secretmanager_v1.rb @@ -20,13 +20,13 @@ module Google module Apis # Secret Manager API # - # Stores API keys, passwords, certificates, and other sensitive data. Provides + # Stores sensitive data such as API keys, passwords, and certificates. Provides # convenience while improving security. # # @see https://cloud.google.com/secret-manager/ module SecretmanagerV1 VERSION = 'V1' - REVISION = '20200222' + REVISION = '20200403' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/secretmanager_v1/service.rb b/generated/google/apis/secretmanager_v1/service.rb index 1560724af..8cd442881 100644 --- a/generated/google/apis/secretmanager_v1/service.rb +++ b/generated/google/apis/secretmanager_v1/service.rb @@ -22,7 +22,7 @@ module Google module SecretmanagerV1 # Secret Manager API # - # Stores API keys, passwords, certificates, and other sensitive data. Provides + # Stores sensitive data such as API keys, passwords, and certificates. Provides # convenience while improving security. # # @example @@ -159,6 +159,9 @@ module Google # @param [Google::Apis::SecretmanagerV1::Secret] secret_object # @param [String] secret_id # Required. This must be unique within the project. + # A secret ID is a string with a maximum length of 255 characters and can + # contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and + # underscore (`_`) characters. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/secretmanager_v1beta1.rb b/generated/google/apis/secretmanager_v1beta1.rb index 4c3bf993e..80fae46e7 100644 --- a/generated/google/apis/secretmanager_v1beta1.rb +++ b/generated/google/apis/secretmanager_v1beta1.rb @@ -20,13 +20,13 @@ module Google module Apis # Secret Manager API # - # Stores API keys, passwords, certificates, and other sensitive data. Provides + # Stores sensitive data such as API keys, passwords, and certificates. Provides # convenience while improving security. # # @see https://cloud.google.com/secret-manager/ module SecretmanagerV1beta1 VERSION = 'V1beta1' - REVISION = '20200222' + REVISION = '20200403' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/secretmanager_v1beta1/service.rb b/generated/google/apis/secretmanager_v1beta1/service.rb index d674e9c23..0bd6a33a7 100644 --- a/generated/google/apis/secretmanager_v1beta1/service.rb +++ b/generated/google/apis/secretmanager_v1beta1/service.rb @@ -22,7 +22,7 @@ module Google module SecretmanagerV1beta1 # Secret Manager API # - # Stores API keys, passwords, certificates, and other sensitive data. Provides + # Stores sensitive data such as API keys, passwords, and certificates. Provides # convenience while improving security. # # @example @@ -159,6 +159,9 @@ module Google # @param [Google::Apis::SecretmanagerV1beta1::Secret] secret_object # @param [String] secret_id # Required. This must be unique within the project. + # A secret ID is a string with a maximum length of 255 characters and can + # contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and + # underscore (`_`) characters. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/securitycenter_v1.rb b/generated/google/apis/securitycenter_v1.rb index 843ab9c67..141b2c0e4 100644 --- a/generated/google/apis/securitycenter_v1.rb +++ b/generated/google/apis/securitycenter_v1.rb @@ -18,15 +18,15 @@ require 'google/apis/securitycenter_v1/representations.rb' module Google module Apis - # Cloud Security Command Center API + # Security Command Center API # - # Cloud Security Command Center API provides access to temporal views of assets - # and findings within an organization. + # Security Command Center API provides access to temporal views of assets and + # findings within an organization. # # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview module SecuritycenterV1 VERSION = 'V1' - REVISION = '20200306' + REVISION = '20200406' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/securitycenter_v1/classes.rb b/generated/google/apis/securitycenter_v1/classes.rb index 59c8a1ebc..b060e1cd9 100644 --- a/generated/google/apis/securitycenter_v1/classes.rb +++ b/generated/google/apis/securitycenter_v1/classes.rb @@ -22,22 +22,24 @@ module Google module Apis module SecuritycenterV1 - # Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud - # Platform (GCP) resource. - # The Asset is a Cloud SCC resource that captures information about a single - # GCP resource. All modifications to an Asset are only within the context of - # Cloud SCC and don't affect the referenced GCP resource. + # Security Command Center representation of a Google Cloud + # resource. + # The Asset is a Security Command Center resource that captures information + # about a single Google Cloud resource. All modifications to an Asset are only + # within the context of Security Command Center and don't affect the referenced + # Google Cloud resource. class Asset include Google::Apis::Core::Hashable - # The time at which the asset was created in Cloud SCC. + # The time at which the asset was created in Security Command Center. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time - # IAM Policy information associated with the GCP resource described by the - # Cloud SCC asset. This information is managed and defined by the GCP - # resource and cannot be modified by the user. + # Cloud IAM Policy information associated with the Google Cloud resource + # described by the Security Command Center asset. This information is managed + # and defined by the Google Cloud resource and cannot be modified by the + # user. # Corresponds to the JSON property `iamPolicy` # @return [Google::Apis::SecuritycenterV1::IamPolicy] attr_accessor :iam_policy @@ -51,27 +53,27 @@ module Google attr_accessor :name # Resource managed properties. These properties are managed and defined by - # the GCP resource and cannot be modified by the user. + # the Google Cloud resource and cannot be modified by the user. # Corresponds to the JSON property `resourceProperties` # @return [Hash] attr_accessor :resource_properties - # Cloud SCC managed properties. These properties are managed by Cloud SCC and - # cannot be modified by the user. + # Security Command Center managed properties. These properties are managed by + # Security Command Center and cannot be modified by the user. # Corresponds to the JSON property `securityCenterProperties` # @return [Google::Apis::SecuritycenterV1::SecurityCenterProperties] attr_accessor :security_center_properties - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1::SecurityMarks] attr_accessor :security_marks - # The time at which the asset was last updated, added, or deleted in Cloud - # SCC. + # The time at which the asset was last updated, added, or deleted in Security + # Command Center. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -398,12 +400,16 @@ module Google end end - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Cloud SCC for presentation, notification, - # analysis, policy testing, and enforcement. For example, a + # privacy, that is ingested into Security Command Center for presentation, + # notification, analysis, policy testing, and enforcement. For example, a # cross-site scripting (XSS) vulnerability in an App Engine application is a # finding. + # When adding a new field hidden behind a visibility label, ensure it is also + # hidden from Notifications: + # http://google3/java/com/google/cloud/security/riskdashboard/notification/ + # actions/streaming/FindingTranslator.java?l=26 class Finding include Google::Apis::Core::Hashable @@ -414,7 +420,7 @@ module Google # @return [String] attr_accessor :category - # The time at which the finding was created in Cloud SCC. + # The time at which the finding was created in Security Command Center. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -426,9 +432,9 @@ module Google # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Cloud SCC - # where additional information about the finding can be found. This field is - # guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security + # Command Center where additional information about the finding can be found. + # This field is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri @@ -450,19 +456,19 @@ module Google # @return [String] attr_accessor :parent - # For findings on Google Cloud Platform (GCP) resources, the full resource - # name of the GCP resource this finding is for. See: + # For findings on Google Cloud resources, the full resource + # name of the Google Cloud resource this finding is for. See: # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-GCP resource, the resourceName can be a - # customer or partner defined string. - # This field is immutable after creation time. + # When the finding is for a non-Google Cloud resource, the resourceName can + # be a customer or partner defined string. This field is immutable after + # creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1::SecurityMarks] @@ -547,12 +553,16 @@ module Google class GoogleCloudSecuritycenterV1NotificationMessage include Google::Apis::Core::Hashable - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Cloud SCC for presentation, notification, - # analysis, policy testing, and enforcement. For example, a + # privacy, that is ingested into Security Command Center for presentation, + # notification, analysis, policy testing, and enforcement. For example, a # cross-site scripting (XSS) vulnerability in an App Engine application is a # finding. + # When adding a new field hidden behind a visibility label, ensure it is also + # hidden from Notifications: + # http://google3/java/com/google/cloud/security/riskdashboard/notification/ + # actions/streaming/FindingTranslator.java?l=26 # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1::Finding] attr_accessor :finding @@ -623,22 +633,24 @@ module Google end end - # Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud - # Platform (GCP) resource. - # The Asset is a Cloud SCC resource that captures information about a single - # GCP resource. All modifications to an Asset are only within the context of - # Cloud SCC and don't affect the referenced GCP resource. + # Security Command Center representation of a Google Cloud + # resource. + # The Asset is a Security Command Center resource that captures information + # about a single Google Cloud resource. All modifications to an Asset are only + # within the context of Security Command Center and don't affect the referenced + # Google Cloud resource. class GoogleCloudSecuritycenterV1p1beta1Asset include Google::Apis::Core::Hashable - # The time at which the asset was created in Cloud SCC. + # The time at which the asset was created in Security Command Center. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time - # IAM Policy information associated with the GCP resource described by the - # Cloud SCC asset. This information is managed and defined by the GCP - # resource and cannot be modified by the user. + # Cloud IAM Policy information associated with the Google Cloud resource + # described by the Security Command Center asset. This information is managed + # and defined by the Google Cloud resource and cannot be modified by the + # user. # Corresponds to the JSON property `iamPolicy` # @return [Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1IamPolicy] attr_accessor :iam_policy @@ -652,20 +664,20 @@ module Google attr_accessor :name # Resource managed properties. These properties are managed and defined by - # the GCP resource and cannot be modified by the user. + # the Google Cloud resource and cannot be modified by the user. # Corresponds to the JSON property `resourceProperties` # @return [Hash] attr_accessor :resource_properties - # Cloud SCC managed properties. These properties are managed by Cloud SCC and - # cannot be modified by the user. + # Security Command Center managed properties. These properties are managed by + # Security Command Center and cannot be modified by the user. # Corresponds to the JSON property `securityCenterProperties` # @return [Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties] attr_accessor :security_center_properties - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] @@ -693,11 +705,11 @@ module Google end end - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Cloud SCC for presentation, notification, analysis, - # policy testing, and enforcement. For example, an XSS vulnerability in an - # App Engine application is a finding. + # ingested into Security Command Center for presentation, notification, + # analysis, policy testing, and enforcement. For example, an XSS vulnerability + # in an App Engine application is a finding. class GoogleCloudSecuritycenterV1p1beta1Finding include Google::Apis::Core::Hashable @@ -708,7 +720,7 @@ module Google # @return [String] attr_accessor :category - # The time at which the finding was created in Cloud SCC. + # The time at which the finding was created in Security Command Center. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -720,9 +732,9 @@ module Google # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Cloud SCC - # where additional information about the finding can be found. This field is - # guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security + # Command Center where additional information about the finding can be found. + # This field is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri @@ -744,19 +756,19 @@ module Google # @return [String] attr_accessor :parent - # For findings on Google Cloud Platform (GCP) resources, the full resource - # name of the GCP resource this finding is for. See: + # For findings on Google Cloud resources, the full resource + # name of the Google Cloud resource this finding is for. See: # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-GCP resource, the resourceName can be a - # customer or partner defined string. - # This field is immutable after creation time. + # When the finding is for a non-Google Cloud resource, the resourceName can + # be a customer or partner defined string. This field is immutable after + # creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] @@ -794,14 +806,15 @@ module Google end end - # IAM Policy information associated with the GCP resource described by the - # Cloud SCC asset. This information is managed and defined by the GCP - # resource and cannot be modified by the user. + # Cloud IAM Policy information associated with the Google Cloud resource + # described by the Security Command Center asset. This information is managed + # and defined by the Google Cloud resource and cannot be modified by the + # user. class GoogleCloudSecuritycenterV1p1beta1IamPolicy include Google::Apis::Core::Hashable # The JSON representation of the Policy associated with the asset. - # See https://cloud.google.com/iam/reference/rest/v1p1beta1/Policy for + # See https://cloud.google.com/iam/docs/reference/rest/v1/Policy for # format details. # Corresponds to the JSON property `policyBlob` # @return [String] @@ -817,15 +830,15 @@ module Google end end - # Cloud SCC's Notification + # Security Command Center's Notification class GoogleCloudSecuritycenterV1p1beta1NotificationMessage include Google::Apis::Core::Hashable - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Cloud SCC for presentation, notification, analysis, - # policy testing, and enforcement. For example, an XSS vulnerability in an - # App Engine application is a finding. + # ingested into Security Command Center for presentation, notification, + # analysis, policy testing, and enforcement. For example, an XSS vulnerability + # in an App Engine application is a finding. # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1Finding] attr_accessor :finding @@ -878,8 +891,8 @@ module Google end end - # Cloud SCC managed properties. These properties are managed by Cloud SCC and - # cannot be modified by the user. + # Security Command Center managed properties. These properties are managed by + # Security Command Center and cannot be modified by the user. class GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties include Google::Apis::Core::Hashable @@ -888,7 +901,7 @@ module Google # @return [String] attr_accessor :resource_display_name - # The full resource name of the GCP resource this asset + # The full resource name of the Google Cloud resource this asset # represents. This field is immutable after create time. See: # https://cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceName` @@ -922,10 +935,10 @@ module Google # @return [String] attr_accessor :resource_project_display_name - # The type of the GCP resource. Examples include: APPLICATION, + # The type of the Google Cloud resource. Examples include: APPLICATION, # PROJECT, and ORGANIZATION. This is a case insensitive field defined by - # Cloud SCC and/or the producer of the resource and is immutable - # after create time. + # Security Command Center and/or the producer of the resource and is + # immutable after create time. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -947,9 +960,9 @@ module Google end end - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. class GoogleCloudSecuritycenterV1p1beta1SecurityMarks include Google::Apis::Core::Hashable @@ -991,11 +1004,12 @@ module Google class GoogleCloudSecuritycenterV1p1beta1TemporalAsset include Google::Apis::Core::Hashable - # Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud - # Platform (GCP) resource. - # The Asset is a Cloud SCC resource that captures information about a single - # GCP resource. All modifications to an Asset are only within the context of - # Cloud SCC and don't affect the referenced GCP resource. + # Security Command Center representation of a Google Cloud + # resource. + # The Asset is a Security Command Center resource that captures information + # about a single Google Cloud resource. All modifications to an Asset are only + # within the context of Security Command Center and don't affect the referenced + # Google Cloud resource. # Corresponds to the JSON property `asset` # @return [Google::Apis::SecuritycenterV1::GoogleCloudSecuritycenterV1p1beta1Asset] attr_accessor :asset @@ -1089,6 +1103,10 @@ module Google # * security_center_properties.resource_project_display_name: `=`, `:` # * security_center_properties.resource_owners: `=`, `:` # For example, `resource_properties.size = 100` is a valid filter string. + # Use a partial match on the empty string to filter based on a property + # existing: "resource_properties.my_property : \"\"" + # Use a negated partial match on the empty string to filter based on a + # property not existing: "-resource_properties.my_property : \"\"" # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter @@ -1256,6 +1274,10 @@ module Google # * security_marks.marks: `=`, `:` # * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` # For example, `source_properties.size = 100` is a valid filter string. + # Use a partial match on the empty string to filter based on a property + # existing: "source_properties.my_property : \"\"" + # Use a negated partial match on the empty string to filter based on a + # property not existing: "-source_properties.my_property : \"\"" # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter @@ -1376,9 +1398,10 @@ module Google end end - # IAM Policy information associated with the GCP resource described by the - # Cloud SCC asset. This information is managed and defined by the GCP - # resource and cannot be modified by the user. + # Cloud IAM Policy information associated with the Google Cloud resource + # described by the Security Command Center asset. This information is managed + # and defined by the Google Cloud resource and cannot be modified by the + # user. class IamPolicy include Google::Apis::Core::Hashable @@ -1441,11 +1464,12 @@ module Google class ListAssetsResult include Google::Apis::Core::Hashable - # Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud - # Platform (GCP) resource. - # The Asset is a Cloud SCC resource that captures information about a single - # GCP resource. All modifications to an Asset are only within the context of - # Cloud SCC and don't affect the referenced GCP resource. + # Security Command Center representation of a Google Cloud + # resource. + # The Asset is a Security Command Center resource that captures information + # about a single Google Cloud resource. All modifications to an Asset are only + # within the context of Security Command Center and don't affect the referenced + # Google Cloud resource. # Corresponds to the JSON property `asset` # @return [Google::Apis::SecuritycenterV1::Asset] attr_accessor :asset @@ -1508,17 +1532,21 @@ module Google class ListFindingsResult include Google::Apis::Core::Hashable - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Cloud SCC for presentation, notification, - # analysis, policy testing, and enforcement. For example, a + # privacy, that is ingested into Security Command Center for presentation, + # notification, analysis, policy testing, and enforcement. For example, a # cross-site scripting (XSS) vulnerability in an App Engine application is a # finding. + # When adding a new field hidden behind a visibility label, ensure it is also + # hidden from Notifications: + # http://google3/java/com/google/cloud/security/riskdashboard/notification/ + # actions/streaming/FindingTranslator.java?l=26 # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1::Finding] attr_accessor :finding - # Information related to the Google Cloud Platform (GCP) resource that is + # Information related to the Google Cloud resource that is # associated with this finding. # Corresponds to the JSON property `resource` # @return [Google::Apis::SecuritycenterV1::Resource] @@ -1733,8 +1761,8 @@ module Google end end - # User specified settings that are attached to the Cloud Security Command - # Center (Cloud SCC) organization. + # User specified settings that are attached to the Security Command + # Center organization. class OrganizationSettings include Google::Apis::Core::Hashable @@ -1892,7 +1920,7 @@ module Google end end - # Information related to the Google Cloud Platform (GCP) resource that is + # Information related to the Google Cloud resource that is # associated with this finding. class Resource include Google::Apis::Core::Hashable @@ -1950,8 +1978,8 @@ module Google end end - # Cloud SCC managed properties. These properties are managed by Cloud SCC and - # cannot be modified by the user. + # Security Command Center managed properties. These properties are managed by + # Security Command Center and cannot be modified by the user. class SecurityCenterProperties include Google::Apis::Core::Hashable @@ -1960,7 +1988,7 @@ module Google # @return [String] attr_accessor :resource_display_name - # The full resource name of the GCP resource this asset + # The full resource name of the Google Cloud resource this asset # represents. This field is immutable after create time. See: # https://cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceName` @@ -1994,10 +2022,10 @@ module Google # @return [String] attr_accessor :resource_project_display_name - # The type of the GCP resource. Examples include: APPLICATION, + # The type of the Google Cloud resource. Examples include: APPLICATION, # PROJECT, and ORGANIZATION. This is a case insensitive field defined by - # Cloud SCC and/or the producer of the resource and is immutable - # after create time. + # Security Command Center and/or the producer of the resource and is + # immutable after create time. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -2019,9 +2047,9 @@ module Google end end - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. class SecurityMarks include Google::Apis::Core::Hashable @@ -2167,7 +2195,7 @@ module Google end end - # Cloud Security Command Center's (Cloud SCC) finding source. A finding source + # Security Command Center finding source. A finding source # is an entity or a mechanism that can produce a finding. A source is like a # container of findings that come from the same scanner, logger, monitor, and # other tools. diff --git a/generated/google/apis/securitycenter_v1/service.rb b/generated/google/apis/securitycenter_v1/service.rb index 6b80ccbbf..9c696ee47 100644 --- a/generated/google/apis/securitycenter_v1/service.rb +++ b/generated/google/apis/securitycenter_v1/service.rb @@ -20,10 +20,10 @@ require 'google/apis/errors' module Google module Apis module SecuritycenterV1 - # Cloud Security Command Center API + # Security Command Center API # - # Cloud Security Command Center API provides access to temporal views of assets - # and findings within an organization. + # Security Command Center API provides access to temporal views of assets and + # findings within an organization. # # @example # require 'google/apis/securitycenter_v1' @@ -229,6 +229,10 @@ module Google # * security_center_properties.resource_project_display_name: `=`, `:` # * security_center_properties.resource_owners: `=`, `:` # For example, `resource_properties.size = 100` is a valid filter string. + # Use a partial match on the empty string to filter based on a property + # existing: "resource_properties.my_property : \"\"" + # Use a negated partial match on the empty string to filter based on a + # property not existing: "-resource_properties.my_property : \"\"" # @param [String] order_by # Expression that defines what fields and order to use for sorting. The # string value should follow SQL syntax: comma separated list of fields. For @@ -1114,6 +1118,10 @@ module Google # security_marks.marks: `=`, `:` # source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` # For example, `source_properties.size = 100` is a valid filter string. + # Use a partial match on the empty string to filter based on a property + # existing: "source_properties.my_property : \"\"" + # Use a negated partial match on the empty string to filter based on a + # property not existing: "-source_properties.my_property : \"\"" # @param [String] order_by # Expression that defines what fields and order to use for sorting. The # string value should follow SQL syntax: comma separated list of fields. For diff --git a/generated/google/apis/securitycenter_v1beta1.rb b/generated/google/apis/securitycenter_v1beta1.rb index 4ab9e2d26..8e481aabb 100644 --- a/generated/google/apis/securitycenter_v1beta1.rb +++ b/generated/google/apis/securitycenter_v1beta1.rb @@ -18,15 +18,15 @@ require 'google/apis/securitycenter_v1beta1/representations.rb' module Google module Apis - # Cloud Security Command Center API + # Security Command Center API # - # Cloud Security Command Center API provides access to temporal views of assets - # and findings within an organization. + # Security Command Center API provides access to temporal views of assets and + # findings within an organization. # # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview module SecuritycenterV1beta1 VERSION = 'V1beta1' - REVISION = '20200306' + REVISION = '20200406' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/securitycenter_v1beta1/classes.rb b/generated/google/apis/securitycenter_v1beta1/classes.rb index bbd07647a..03b4cec24 100644 --- a/generated/google/apis/securitycenter_v1beta1/classes.rb +++ b/generated/google/apis/securitycenter_v1beta1/classes.rb @@ -22,15 +22,16 @@ module Google module Apis module SecuritycenterV1beta1 - # Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud - # Platform (GCP) resource. - # The Asset is a Cloud SCC resource that captures information about a single - # GCP resource. All modifications to an Asset are only within the context of - # Cloud SCC and don't affect the referenced GCP resource. + # Security Command Center representation of a Google Cloud + # resource. + # The Asset is a Security Command Center resource that captures information + # about a single Google Cloud resource. All modifications to an Asset are only + # within the context of Security Command Center and don't affect the referenced + # Google Cloud resource. class Asset include Google::Apis::Core::Hashable - # The time at which the asset was created in Cloud SCC. + # The time at which the asset was created in Security Command Center. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -44,27 +45,27 @@ module Google attr_accessor :name # Resource managed properties. These properties are managed and defined by - # the GCP resource and cannot be modified by the user. + # the Google Cloud resource and cannot be modified by the user. # Corresponds to the JSON property `resourceProperties` # @return [Hash] attr_accessor :resource_properties - # Cloud SCC managed properties. These properties are managed by Cloud SCC and - # cannot be modified by the user. + # Security Command Center managed properties. These properties are managed by + # Security Command Center and cannot be modified by the user. # Corresponds to the JSON property `securityCenterProperties` # @return [Google::Apis::SecuritycenterV1beta1::SecurityCenterProperties] attr_accessor :security_center_properties - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1SecurityMarks] attr_accessor :security_marks - # The time at which the asset was last updated, added, or deleted in Cloud - # SCC. + # The time at which the asset was last updated, added, or deleted in Security + # Command Center. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -403,12 +404,16 @@ module Google end end - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Cloud SCC for presentation, notification, - # analysis, policy testing, and enforcement. For example, a + # privacy, that is ingested into Security Command Center for presentation, + # notification, analysis, policy testing, and enforcement. For example, a # cross-site scripting (XSS) vulnerability in an App Engine application is a # finding. + # When adding a new field hidden behind a visibility label, ensure it is also + # hidden from Notifications: + # http://google3/java/com/google/cloud/security/riskdashboard/notification/ + # actions/streaming/FindingTranslator.java?l=26 class Finding include Google::Apis::Core::Hashable @@ -419,7 +424,7 @@ module Google # @return [String] attr_accessor :category - # The time at which the finding was created in Cloud SCC. + # The time at which the finding was created in Security Command Center. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -431,9 +436,9 @@ module Google # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Cloud SCC - # where additional information about the finding can be found. This field is - # guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security + # Command Center where additional information about the finding can be found. + # This field is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri @@ -455,19 +460,19 @@ module Google # @return [String] attr_accessor :parent - # For findings on Google Cloud Platform (GCP) resources, the full resource - # name of the GCP resource this finding is for. See: + # For findings on Google Cloud resources, the full resource + # name of the Google Cloud resource this finding is for. See: # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-GCP resource, the resourceName can be a - # customer or partner defined string. - # This field is immutable after creation time. + # When the finding is for a non-Google Cloud resource, the resourceName can + # be a customer or partner defined string. This field is immutable after + # creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1beta1::SecurityMarks] @@ -552,12 +557,16 @@ module Google class GoogleCloudSecuritycenterV1NotificationMessage include Google::Apis::Core::Hashable - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Cloud SCC for presentation, notification, - # analysis, policy testing, and enforcement. For example, a + # privacy, that is ingested into Security Command Center for presentation, + # notification, analysis, policy testing, and enforcement. For example, a # cross-site scripting (XSS) vulnerability in an App Engine application is a # finding. + # When adding a new field hidden behind a visibility label, ensure it is also + # hidden from Notifications: + # http://google3/java/com/google/cloud/security/riskdashboard/notification/ + # actions/streaming/FindingTranslator.java?l=26 # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1beta1::Finding] attr_accessor :finding @@ -603,11 +612,11 @@ module Google end end - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Cloud SCC for presentation, notification, analysis, - # policy testing, and enforcement. For example, an XSS vulnerability in an - # App Engine application is a finding. + # ingested into Security Command Center for presentation, notification, + # analysis, policy testing, and enforcement. For example, an XSS vulnerability + # in an App Engine application is a finding. class GoogleCloudSecuritycenterV1beta1Finding include Google::Apis::Core::Hashable @@ -618,7 +627,7 @@ module Google # @return [String] attr_accessor :category - # The time at which the finding was created in Cloud SCC. + # The time at which the finding was created in Security Command Center. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -630,9 +639,9 @@ module Google # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Cloud SCC - # where additional information about the finding can be found. This field is - # guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security + # Command Center where additional information about the finding can be found. + # This field is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri @@ -655,19 +664,19 @@ module Google # @return [String] attr_accessor :parent - # For findings on Google Cloud Platform (GCP) resources, the full resource - # name of the GCP resource this finding is for. See: + # For findings on Google Cloud resources, the full resource + # name of the Google Cloud resource this finding is for. See: # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-GCP resource, the resourceName can be a - # customer or partner defined string. - # This field is immutable after creation time. + # When the finding is for a non-Google Cloud resource, the resourceName can + # be a customer or partner defined string. This field is immutable after + # creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1SecurityMarks] @@ -730,9 +739,9 @@ module Google end end - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. class GoogleCloudSecuritycenterV1beta1SecurityMarks include Google::Apis::Core::Hashable @@ -769,22 +778,24 @@ module Google end end - # Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud - # Platform (GCP) resource. - # The Asset is a Cloud SCC resource that captures information about a single - # GCP resource. All modifications to an Asset are only within the context of - # Cloud SCC and don't affect the referenced GCP resource. + # Security Command Center representation of a Google Cloud + # resource. + # The Asset is a Security Command Center resource that captures information + # about a single Google Cloud resource. All modifications to an Asset are only + # within the context of Security Command Center and don't affect the referenced + # Google Cloud resource. class GoogleCloudSecuritycenterV1p1beta1Asset include Google::Apis::Core::Hashable - # The time at which the asset was created in Cloud SCC. + # The time at which the asset was created in Security Command Center. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time - # IAM Policy information associated with the GCP resource described by the - # Cloud SCC asset. This information is managed and defined by the GCP - # resource and cannot be modified by the user. + # Cloud IAM Policy information associated with the Google Cloud resource + # described by the Security Command Center asset. This information is managed + # and defined by the Google Cloud resource and cannot be modified by the + # user. # Corresponds to the JSON property `iamPolicy` # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1IamPolicy] attr_accessor :iam_policy @@ -798,20 +809,20 @@ module Google attr_accessor :name # Resource managed properties. These properties are managed and defined by - # the GCP resource and cannot be modified by the user. + # the Google Cloud resource and cannot be modified by the user. # Corresponds to the JSON property `resourceProperties` # @return [Hash] attr_accessor :resource_properties - # Cloud SCC managed properties. These properties are managed by Cloud SCC and - # cannot be modified by the user. + # Security Command Center managed properties. These properties are managed by + # Security Command Center and cannot be modified by the user. # Corresponds to the JSON property `securityCenterProperties` # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties] attr_accessor :security_center_properties - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] @@ -839,11 +850,11 @@ module Google end end - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Cloud SCC for presentation, notification, analysis, - # policy testing, and enforcement. For example, an XSS vulnerability in an - # App Engine application is a finding. + # ingested into Security Command Center for presentation, notification, + # analysis, policy testing, and enforcement. For example, an XSS vulnerability + # in an App Engine application is a finding. class GoogleCloudSecuritycenterV1p1beta1Finding include Google::Apis::Core::Hashable @@ -854,7 +865,7 @@ module Google # @return [String] attr_accessor :category - # The time at which the finding was created in Cloud SCC. + # The time at which the finding was created in Security Command Center. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -866,9 +877,9 @@ module Google # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Cloud SCC - # where additional information about the finding can be found. This field is - # guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security + # Command Center where additional information about the finding can be found. + # This field is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri @@ -890,19 +901,19 @@ module Google # @return [String] attr_accessor :parent - # For findings on Google Cloud Platform (GCP) resources, the full resource - # name of the GCP resource this finding is for. See: + # For findings on Google Cloud resources, the full resource + # name of the Google Cloud resource this finding is for. See: # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-GCP resource, the resourceName can be a - # customer or partner defined string. - # This field is immutable after creation time. + # When the finding is for a non-Google Cloud resource, the resourceName can + # be a customer or partner defined string. This field is immutable after + # creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] @@ -940,14 +951,15 @@ module Google end end - # IAM Policy information associated with the GCP resource described by the - # Cloud SCC asset. This information is managed and defined by the GCP - # resource and cannot be modified by the user. + # Cloud IAM Policy information associated with the Google Cloud resource + # described by the Security Command Center asset. This information is managed + # and defined by the Google Cloud resource and cannot be modified by the + # user. class GoogleCloudSecuritycenterV1p1beta1IamPolicy include Google::Apis::Core::Hashable # The JSON representation of the Policy associated with the asset. - # See https://cloud.google.com/iam/reference/rest/v1p1beta1/Policy for + # See https://cloud.google.com/iam/docs/reference/rest/v1/Policy for # format details. # Corresponds to the JSON property `policyBlob` # @return [String] @@ -963,15 +975,15 @@ module Google end end - # Cloud SCC's Notification + # Security Command Center's Notification class GoogleCloudSecuritycenterV1p1beta1NotificationMessage include Google::Apis::Core::Hashable - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Cloud SCC for presentation, notification, analysis, - # policy testing, and enforcement. For example, an XSS vulnerability in an - # App Engine application is a finding. + # ingested into Security Command Center for presentation, notification, + # analysis, policy testing, and enforcement. For example, an XSS vulnerability + # in an App Engine application is a finding. # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] attr_accessor :finding @@ -1024,8 +1036,8 @@ module Google end end - # Cloud SCC managed properties. These properties are managed by Cloud SCC and - # cannot be modified by the user. + # Security Command Center managed properties. These properties are managed by + # Security Command Center and cannot be modified by the user. class GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties include Google::Apis::Core::Hashable @@ -1034,7 +1046,7 @@ module Google # @return [String] attr_accessor :resource_display_name - # The full resource name of the GCP resource this asset + # The full resource name of the Google Cloud resource this asset # represents. This field is immutable after create time. See: # https://cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceName` @@ -1068,10 +1080,10 @@ module Google # @return [String] attr_accessor :resource_project_display_name - # The type of the GCP resource. Examples include: APPLICATION, + # The type of the Google Cloud resource. Examples include: APPLICATION, # PROJECT, and ORGANIZATION. This is a case insensitive field defined by - # Cloud SCC and/or the producer of the resource and is immutable - # after create time. + # Security Command Center and/or the producer of the resource and is + # immutable after create time. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -1093,9 +1105,9 @@ module Google end end - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. class GoogleCloudSecuritycenterV1p1beta1SecurityMarks include Google::Apis::Core::Hashable @@ -1137,11 +1149,12 @@ module Google class GoogleCloudSecuritycenterV1p1beta1TemporalAsset include Google::Apis::Core::Hashable - # Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud - # Platform (GCP) resource. - # The Asset is a Cloud SCC resource that captures information about a single - # GCP resource. All modifications to an Asset are only within the context of - # Cloud SCC and don't affect the referenced GCP resource. + # Security Command Center representation of a Google Cloud + # resource. + # The Asset is a Security Command Center resource that captures information + # about a single Google Cloud resource. All modifications to an Asset are only + # within the context of Security Command Center and don't affect the referenced + # Google Cloud resource. # Corresponds to the JSON property `asset` # @return [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1p1beta1Asset] attr_accessor :asset @@ -1473,11 +1486,12 @@ module Google class ListAssetsResult include Google::Apis::Core::Hashable - # Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud - # Platform (GCP) resource. - # The Asset is a Cloud SCC resource that captures information about a single - # GCP resource. All modifications to an Asset are only within the context of - # Cloud SCC and don't affect the referenced GCP resource. + # Security Command Center representation of a Google Cloud + # resource. + # The Asset is a Security Command Center resource that captures information + # about a single Google Cloud resource. All modifications to an Asset are only + # within the context of Security Command Center and don't affect the referenced + # Google Cloud resource. # Corresponds to the JSON property `asset` # @return [Google::Apis::SecuritycenterV1beta1::Asset] attr_accessor :asset @@ -1651,8 +1665,8 @@ module Google end end - # User specified settings that are attached to the Cloud Security Command - # Center (Cloud SCC) organization. + # User specified settings that are attached to the Security Command + # Center organization. class OrganizationSettings include Google::Apis::Core::Hashable @@ -1823,12 +1837,12 @@ module Google end end - # Cloud SCC managed properties. These properties are managed by Cloud SCC and - # cannot be modified by the user. + # Security Command Center managed properties. These properties are managed by + # Security Command Center and cannot be modified by the user. class SecurityCenterProperties include Google::Apis::Core::Hashable - # Immutable. The full resource name of the GCP resource this asset + # Immutable. The full resource name of the Google Cloud resource this asset # represents. This field is immutable after create time. See: # https://cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceName` @@ -1852,10 +1866,10 @@ module Google # @return [String] attr_accessor :resource_project - # The type of the GCP resource. Examples include: APPLICATION, + # The type of the Google Cloud resource. Examples include: APPLICATION, # PROJECT, and ORGANIZATION. This is a case insensitive field defined by - # Cloud SCC and/or the producer of the resource and is immutable - # after create time. + # Security Command Center and/or the producer of the resource and is + # immutable after create time. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -1874,9 +1888,9 @@ module Google end end - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. class SecurityMarks include Google::Apis::Core::Hashable @@ -2022,7 +2036,7 @@ module Google end end - # Cloud Security Command Center's (Cloud SCC) finding source. A finding source + # Security Command Center finding source. A finding source # is an entity or a mechanism that can produce a finding. A source is like a # container of findings that come from the same scanner, logger, monitor, etc. class Source @@ -2030,7 +2044,7 @@ module Google # The description of the source (max of 1024 characters). # Example: - # "Cloud Security Scanner is a web security scanner for common + # "Web Security Scanner is a web security scanner for common # vulnerabilities in App Engine applications. It can automatically # scan and detect four common vulnerabilities, including cross-site-scripting # (XSS), Flash injection, mixed content (HTTP in HTTPS), and diff --git a/generated/google/apis/securitycenter_v1beta1/service.rb b/generated/google/apis/securitycenter_v1beta1/service.rb index 9c7314e55..7154ab447 100644 --- a/generated/google/apis/securitycenter_v1beta1/service.rb +++ b/generated/google/apis/securitycenter_v1beta1/service.rb @@ -20,10 +20,10 @@ require 'google/apis/errors' module Google module Apis module SecuritycenterV1beta1 - # Cloud Security Command Center API + # Security Command Center API # - # Cloud Security Command Center API provides access to temporal views of assets - # and findings within an organization. + # Security Command Center API provides access to temporal views of assets and + # findings within an organization. # # @example # require 'google/apis/securitycenter_v1beta1' diff --git a/generated/google/apis/securitycenter_v1p1alpha1.rb b/generated/google/apis/securitycenter_v1p1alpha1.rb index a60705f50..7d5fe5f6b 100644 --- a/generated/google/apis/securitycenter_v1p1alpha1.rb +++ b/generated/google/apis/securitycenter_v1p1alpha1.rb @@ -18,15 +18,15 @@ require 'google/apis/securitycenter_v1p1alpha1/representations.rb' module Google module Apis - # Cloud Security Command Center API + # Security Command Center API # - # Cloud Security Command Center API provides access to temporal views of assets - # and findings within an organization. + # Security Command Center API provides access to temporal views of assets and + # findings within an organization. # # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview module SecuritycenterV1p1alpha1 VERSION = 'V1p1alpha1' - REVISION = '20200306' + REVISION = '20200406' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/securitycenter_v1p1alpha1/classes.rb b/generated/google/apis/securitycenter_v1p1alpha1/classes.rb index 9e0ddbf43..db1f6ae09 100644 --- a/generated/google/apis/securitycenter_v1p1alpha1/classes.rb +++ b/generated/google/apis/securitycenter_v1p1alpha1/classes.rb @@ -41,12 +41,16 @@ module Google end end - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Cloud SCC for presentation, notification, - # analysis, policy testing, and enforcement. For example, a + # privacy, that is ingested into Security Command Center for presentation, + # notification, analysis, policy testing, and enforcement. For example, a # cross-site scripting (XSS) vulnerability in an App Engine application is a # finding. + # When adding a new field hidden behind a visibility label, ensure it is also + # hidden from Notifications: + # http://google3/java/com/google/cloud/security/riskdashboard/notification/ + # actions/streaming/FindingTranslator.java?l=26 class Finding include Google::Apis::Core::Hashable @@ -57,7 +61,7 @@ module Google # @return [String] attr_accessor :category - # The time at which the finding was created in Cloud SCC. + # The time at which the finding was created in Security Command Center. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -69,9 +73,9 @@ module Google # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Cloud SCC - # where additional information about the finding can be found. This field is - # guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security + # Command Center where additional information about the finding can be found. + # This field is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri @@ -93,19 +97,19 @@ module Google # @return [String] attr_accessor :parent - # For findings on Google Cloud Platform (GCP) resources, the full resource - # name of the GCP resource this finding is for. See: + # For findings on Google Cloud resources, the full resource + # name of the Google Cloud resource this finding is for. See: # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-GCP resource, the resourceName can be a - # customer or partner defined string. - # This field is immutable after creation time. + # When the finding is for a non-Google Cloud resource, the resourceName can + # be a customer or partner defined string. This field is immutable after + # creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1p1alpha1::SecurityMarks] @@ -147,12 +151,16 @@ module Google class GoogleCloudSecuritycenterV1NotificationMessage include Google::Apis::Core::Hashable - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Cloud SCC for presentation, notification, - # analysis, policy testing, and enforcement. For example, a + # privacy, that is ingested into Security Command Center for presentation, + # notification, analysis, policy testing, and enforcement. For example, a # cross-site scripting (XSS) vulnerability in an App Engine application is a # finding. + # When adding a new field hidden behind a visibility label, ensure it is also + # hidden from Notifications: + # http://google3/java/com/google/cloud/security/riskdashboard/notification/ + # actions/streaming/FindingTranslator.java?l=26 # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1p1alpha1::Finding] attr_accessor :finding @@ -223,22 +231,24 @@ module Google end end - # Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud - # Platform (GCP) resource. - # The Asset is a Cloud SCC resource that captures information about a single - # GCP resource. All modifications to an Asset are only within the context of - # Cloud SCC and don't affect the referenced GCP resource. + # Security Command Center representation of a Google Cloud + # resource. + # The Asset is a Security Command Center resource that captures information + # about a single Google Cloud resource. All modifications to an Asset are only + # within the context of Security Command Center and don't affect the referenced + # Google Cloud resource. class GoogleCloudSecuritycenterV1p1beta1Asset include Google::Apis::Core::Hashable - # The time at which the asset was created in Cloud SCC. + # The time at which the asset was created in Security Command Center. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time - # IAM Policy information associated with the GCP resource described by the - # Cloud SCC asset. This information is managed and defined by the GCP - # resource and cannot be modified by the user. + # Cloud IAM Policy information associated with the Google Cloud resource + # described by the Security Command Center asset. This information is managed + # and defined by the Google Cloud resource and cannot be modified by the + # user. # Corresponds to the JSON property `iamPolicy` # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1IamPolicy] attr_accessor :iam_policy @@ -252,20 +262,20 @@ module Google attr_accessor :name # Resource managed properties. These properties are managed and defined by - # the GCP resource and cannot be modified by the user. + # the Google Cloud resource and cannot be modified by the user. # Corresponds to the JSON property `resourceProperties` # @return [Hash] attr_accessor :resource_properties - # Cloud SCC managed properties. These properties are managed by Cloud SCC and - # cannot be modified by the user. + # Security Command Center managed properties. These properties are managed by + # Security Command Center and cannot be modified by the user. # Corresponds to the JSON property `securityCenterProperties` # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties] attr_accessor :security_center_properties - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] @@ -293,11 +303,11 @@ module Google end end - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Cloud SCC for presentation, notification, analysis, - # policy testing, and enforcement. For example, an XSS vulnerability in an - # App Engine application is a finding. + # ingested into Security Command Center for presentation, notification, + # analysis, policy testing, and enforcement. For example, an XSS vulnerability + # in an App Engine application is a finding. class GoogleCloudSecuritycenterV1p1beta1Finding include Google::Apis::Core::Hashable @@ -308,7 +318,7 @@ module Google # @return [String] attr_accessor :category - # The time at which the finding was created in Cloud SCC. + # The time at which the finding was created in Security Command Center. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -320,9 +330,9 @@ module Google # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Cloud SCC - # where additional information about the finding can be found. This field is - # guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security + # Command Center where additional information about the finding can be found. + # This field is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri @@ -344,19 +354,19 @@ module Google # @return [String] attr_accessor :parent - # For findings on Google Cloud Platform (GCP) resources, the full resource - # name of the GCP resource this finding is for. See: + # For findings on Google Cloud resources, the full resource + # name of the Google Cloud resource this finding is for. See: # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-GCP resource, the resourceName can be a - # customer or partner defined string. - # This field is immutable after creation time. + # When the finding is for a non-Google Cloud resource, the resourceName can + # be a customer or partner defined string. This field is immutable after + # creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] @@ -394,14 +404,15 @@ module Google end end - # IAM Policy information associated with the GCP resource described by the - # Cloud SCC asset. This information is managed and defined by the GCP - # resource and cannot be modified by the user. + # Cloud IAM Policy information associated with the Google Cloud resource + # described by the Security Command Center asset. This information is managed + # and defined by the Google Cloud resource and cannot be modified by the + # user. class GoogleCloudSecuritycenterV1p1beta1IamPolicy include Google::Apis::Core::Hashable # The JSON representation of the Policy associated with the asset. - # See https://cloud.google.com/iam/reference/rest/v1p1beta1/Policy for + # See https://cloud.google.com/iam/docs/reference/rest/v1/Policy for # format details. # Corresponds to the JSON property `policyBlob` # @return [String] @@ -417,15 +428,15 @@ module Google end end - # Cloud SCC's Notification + # Security Command Center's Notification class GoogleCloudSecuritycenterV1p1beta1NotificationMessage include Google::Apis::Core::Hashable - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Cloud SCC for presentation, notification, analysis, - # policy testing, and enforcement. For example, an XSS vulnerability in an - # App Engine application is a finding. + # ingested into Security Command Center for presentation, notification, + # analysis, policy testing, and enforcement. For example, an XSS vulnerability + # in an App Engine application is a finding. # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Finding] attr_accessor :finding @@ -478,8 +489,8 @@ module Google end end - # Cloud SCC managed properties. These properties are managed by Cloud SCC and - # cannot be modified by the user. + # Security Command Center managed properties. These properties are managed by + # Security Command Center and cannot be modified by the user. class GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties include Google::Apis::Core::Hashable @@ -488,7 +499,7 @@ module Google # @return [String] attr_accessor :resource_display_name - # The full resource name of the GCP resource this asset + # The full resource name of the Google Cloud resource this asset # represents. This field is immutable after create time. See: # https://cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceName` @@ -522,10 +533,10 @@ module Google # @return [String] attr_accessor :resource_project_display_name - # The type of the GCP resource. Examples include: APPLICATION, + # The type of the Google Cloud resource. Examples include: APPLICATION, # PROJECT, and ORGANIZATION. This is a case insensitive field defined by - # Cloud SCC and/or the producer of the resource and is immutable - # after create time. + # Security Command Center and/or the producer of the resource and is + # immutable after create time. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -547,9 +558,9 @@ module Google end end - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. class GoogleCloudSecuritycenterV1p1beta1SecurityMarks include Google::Apis::Core::Hashable @@ -591,11 +602,12 @@ module Google class GoogleCloudSecuritycenterV1p1beta1TemporalAsset include Google::Apis::Core::Hashable - # Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud - # Platform (GCP) resource. - # The Asset is a Cloud SCC resource that captures information about a single - # GCP resource. All modifications to an Asset are only within the context of - # Cloud SCC and don't affect the referenced GCP resource. + # Security Command Center representation of a Google Cloud + # resource. + # The Asset is a Security Command Center resource that captures information + # about a single Google Cloud resource. All modifications to an Asset are only + # within the context of Security Command Center and don't affect the referenced + # Google Cloud resource. # Corresponds to the JSON property `asset` # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Asset] attr_accessor :asset @@ -705,9 +717,9 @@ module Google end end - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. class SecurityMarks include Google::Apis::Core::Hashable diff --git a/generated/google/apis/securitycenter_v1p1alpha1/service.rb b/generated/google/apis/securitycenter_v1p1alpha1/service.rb index e7e92fa19..f016ea7f1 100644 --- a/generated/google/apis/securitycenter_v1p1alpha1/service.rb +++ b/generated/google/apis/securitycenter_v1p1alpha1/service.rb @@ -20,10 +20,10 @@ require 'google/apis/errors' module Google module Apis module SecuritycenterV1p1alpha1 - # Cloud Security Command Center API + # Security Command Center API # - # Cloud Security Command Center API provides access to temporal views of assets - # and findings within an organization. + # Security Command Center API provides access to temporal views of assets and + # findings within an organization. # # @example # require 'google/apis/securitycenter_v1p1alpha1' diff --git a/generated/google/apis/securitycenter_v1p1beta1.rb b/generated/google/apis/securitycenter_v1p1beta1.rb index 998507e4f..81b523e35 100644 --- a/generated/google/apis/securitycenter_v1p1beta1.rb +++ b/generated/google/apis/securitycenter_v1p1beta1.rb @@ -18,15 +18,15 @@ require 'google/apis/securitycenter_v1p1beta1/representations.rb' module Google module Apis - # Cloud Security Command Center API + # Security Command Center API # - # Cloud Security Command Center API provides access to temporal views of assets - # and findings within an organization. + # Security Command Center API provides access to temporal views of assets and + # findings within an organization. # # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview module SecuritycenterV1p1beta1 VERSION = 'V1p1beta1' - REVISION = '20200306' + REVISION = '20200406' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/securitycenter_v1p1beta1/classes.rb b/generated/google/apis/securitycenter_v1p1beta1/classes.rb index 74db27641..dce3e8d8c 100644 --- a/generated/google/apis/securitycenter_v1p1beta1/classes.rb +++ b/generated/google/apis/securitycenter_v1p1beta1/classes.rb @@ -328,12 +328,16 @@ module Google end end - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Cloud SCC for presentation, notification, - # analysis, policy testing, and enforcement. For example, a + # privacy, that is ingested into Security Command Center for presentation, + # notification, analysis, policy testing, and enforcement. For example, a # cross-site scripting (XSS) vulnerability in an App Engine application is a # finding. + # When adding a new field hidden behind a visibility label, ensure it is also + # hidden from Notifications: + # http://google3/java/com/google/cloud/security/riskdashboard/notification/ + # actions/streaming/FindingTranslator.java?l=26 class Finding include Google::Apis::Core::Hashable @@ -344,7 +348,7 @@ module Google # @return [String] attr_accessor :category - # The time at which the finding was created in Cloud SCC. + # The time at which the finding was created in Security Command Center. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -356,9 +360,9 @@ module Google # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Cloud SCC - # where additional information about the finding can be found. This field is - # guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security + # Command Center where additional information about the finding can be found. + # This field is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri @@ -380,19 +384,19 @@ module Google # @return [String] attr_accessor :parent - # For findings on Google Cloud Platform (GCP) resources, the full resource - # name of the GCP resource this finding is for. See: + # For findings on Google Cloud resources, the full resource + # name of the Google Cloud resource this finding is for. See: # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-GCP resource, the resourceName can be a - # customer or partner defined string. - # This field is immutable after creation time. + # When the finding is for a non-Google Cloud resource, the resourceName can + # be a customer or partner defined string. This field is immutable after + # creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1p1beta1::SecurityMarks] @@ -477,12 +481,16 @@ module Google class GoogleCloudSecuritycenterV1NotificationMessage include Google::Apis::Core::Hashable - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data like security, risk, health, or - # privacy, that is ingested into Cloud SCC for presentation, notification, - # analysis, policy testing, and enforcement. For example, a + # privacy, that is ingested into Security Command Center for presentation, + # notification, analysis, policy testing, and enforcement. For example, a # cross-site scripting (XSS) vulnerability in an App Engine application is a # finding. + # When adding a new field hidden behind a visibility label, ensure it is also + # hidden from Notifications: + # http://google3/java/com/google/cloud/security/riskdashboard/notification/ + # actions/streaming/FindingTranslator.java?l=26 # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1p1beta1::Finding] attr_accessor :finding @@ -553,22 +561,24 @@ module Google end end - # Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud - # Platform (GCP) resource. - # The Asset is a Cloud SCC resource that captures information about a single - # GCP resource. All modifications to an Asset are only within the context of - # Cloud SCC and don't affect the referenced GCP resource. + # Security Command Center representation of a Google Cloud + # resource. + # The Asset is a Security Command Center resource that captures information + # about a single Google Cloud resource. All modifications to an Asset are only + # within the context of Security Command Center and don't affect the referenced + # Google Cloud resource. class GoogleCloudSecuritycenterV1p1beta1Asset include Google::Apis::Core::Hashable - # The time at which the asset was created in Cloud SCC. + # The time at which the asset was created in Security Command Center. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time - # IAM Policy information associated with the GCP resource described by the - # Cloud SCC asset. This information is managed and defined by the GCP - # resource and cannot be modified by the user. + # Cloud IAM Policy information associated with the Google Cloud resource + # described by the Security Command Center asset. This information is managed + # and defined by the Google Cloud resource and cannot be modified by the + # user. # Corresponds to the JSON property `iamPolicy` # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1IamPolicy] attr_accessor :iam_policy @@ -582,20 +592,20 @@ module Google attr_accessor :name # Resource managed properties. These properties are managed and defined by - # the GCP resource and cannot be modified by the user. + # the Google Cloud resource and cannot be modified by the user. # Corresponds to the JSON property `resourceProperties` # @return [Hash] attr_accessor :resource_properties - # Cloud SCC managed properties. These properties are managed by Cloud SCC and - # cannot be modified by the user. + # Security Command Center managed properties. These properties are managed by + # Security Command Center and cannot be modified by the user. # Corresponds to the JSON property `securityCenterProperties` # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties] attr_accessor :security_center_properties - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] @@ -623,11 +633,11 @@ module Google end end - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Cloud SCC for presentation, notification, analysis, - # policy testing, and enforcement. For example, an XSS vulnerability in an - # App Engine application is a finding. + # ingested into Security Command Center for presentation, notification, + # analysis, policy testing, and enforcement. For example, an XSS vulnerability + # in an App Engine application is a finding. class GoogleCloudSecuritycenterV1p1beta1Finding include Google::Apis::Core::Hashable @@ -638,7 +648,7 @@ module Google # @return [String] attr_accessor :category - # The time at which the finding was created in Cloud SCC. + # The time at which the finding was created in Security Command Center. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time @@ -650,9 +660,9 @@ module Google # @return [String] attr_accessor :event_time - # The URI that, if available, points to a web page outside of Cloud SCC - # where additional information about the finding can be found. This field is - # guaranteed to be either empty or a well formed URL. + # The URI that, if available, points to a web page outside of Security + # Command Center where additional information about the finding can be found. + # This field is guaranteed to be either empty or a well formed URL. # Corresponds to the JSON property `externalUri` # @return [String] attr_accessor :external_uri @@ -674,19 +684,19 @@ module Google # @return [String] attr_accessor :parent - # For findings on Google Cloud Platform (GCP) resources, the full resource - # name of the GCP resource this finding is for. See: + # For findings on Google Cloud resources, the full resource + # name of the Google Cloud resource this finding is for. See: # https://cloud.google.com/apis/design/resource_names#full_resource_name - # When the finding is for a non-GCP resource, the resourceName can be a - # customer or partner defined string. - # This field is immutable after creation time. + # When the finding is for a non-Google Cloud resource, the resourceName can + # be a customer or partner defined string. This field is immutable after + # creation time. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. # Corresponds to the JSON property `securityMarks` # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] @@ -724,14 +734,15 @@ module Google end end - # IAM Policy information associated with the GCP resource described by the - # Cloud SCC asset. This information is managed and defined by the GCP - # resource and cannot be modified by the user. + # Cloud IAM Policy information associated with the Google Cloud resource + # described by the Security Command Center asset. This information is managed + # and defined by the Google Cloud resource and cannot be modified by the + # user. class GoogleCloudSecuritycenterV1p1beta1IamPolicy include Google::Apis::Core::Hashable # The JSON representation of the Policy associated with the asset. - # See https://cloud.google.com/iam/reference/rest/v1p1beta1/Policy for + # See https://cloud.google.com/iam/docs/reference/rest/v1/Policy for # format details. # Corresponds to the JSON property `policyBlob` # @return [String] @@ -747,15 +758,15 @@ module Google end end - # Cloud SCC's Notification + # Security Command Center's Notification class GoogleCloudSecuritycenterV1p1beta1NotificationMessage include Google::Apis::Core::Hashable - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Cloud SCC for presentation, notification, analysis, - # policy testing, and enforcement. For example, an XSS vulnerability in an - # App Engine application is a finding. + # ingested into Security Command Center for presentation, notification, + # analysis, policy testing, and enforcement. For example, an XSS vulnerability + # in an App Engine application is a finding. # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] attr_accessor :finding @@ -808,8 +819,8 @@ module Google end end - # Cloud SCC managed properties. These properties are managed by Cloud SCC and - # cannot be modified by the user. + # Security Command Center managed properties. These properties are managed by + # Security Command Center and cannot be modified by the user. class GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties include Google::Apis::Core::Hashable @@ -818,7 +829,7 @@ module Google # @return [String] attr_accessor :resource_display_name - # The full resource name of the GCP resource this asset + # The full resource name of the Google Cloud resource this asset # represents. This field is immutable after create time. See: # https://cloud.google.com/apis/design/resource_names#full_resource_name # Corresponds to the JSON property `resourceName` @@ -852,10 +863,10 @@ module Google # @return [String] attr_accessor :resource_project_display_name - # The type of the GCP resource. Examples include: APPLICATION, + # The type of the Google Cloud resource. Examples include: APPLICATION, # PROJECT, and ORGANIZATION. This is a case insensitive field defined by - # Cloud SCC and/or the producer of the resource and is immutable - # after create time. + # Security Command Center and/or the producer of the resource and is + # immutable after create time. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -877,9 +888,9 @@ module Google end end - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. class GoogleCloudSecuritycenterV1p1beta1SecurityMarks include Google::Apis::Core::Hashable @@ -921,11 +932,12 @@ module Google class GoogleCloudSecuritycenterV1p1beta1TemporalAsset include Google::Apis::Core::Hashable - # Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud - # Platform (GCP) resource. - # The Asset is a Cloud SCC resource that captures information about a single - # GCP resource. All modifications to an Asset are only within the context of - # Cloud SCC and don't affect the referenced GCP resource. + # Security Command Center representation of a Google Cloud + # resource. + # The Asset is a Security Command Center resource that captures information + # about a single Google Cloud resource. All modifications to an Asset are only + # within the context of Security Command Center and don't affect the referenced + # Google Cloud resource. # Corresponds to the JSON property `asset` # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Asset] attr_accessor :asset @@ -1019,6 +1031,10 @@ module Google # * security_center_properties.resource_project_display_name: `=`, `:` # * security_center_properties.resource_owners: `=`, `:` # For example, `resource_properties.size = 100` is a valid filter string. + # Use a partial match on the empty string to filter based on a property + # existing: "resource_properties.my_property : \"\"" + # Use a negated partial match on the empty string to filter based on a + # property not existing: "-resource_properties.my_property : \"\"" # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter @@ -1186,6 +1202,10 @@ module Google # * security_marks.marks: `=`, `:` # * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` # For example, `source_properties.size = 100` is a valid filter string. + # Use a partial match on the empty string to filter based on a property + # existing: "source_properties.my_property : \"\"" + # Use a negated partial match on the empty string to filter based on a + # property not existing: "-source_properties.my_property : \"\"" # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter @@ -1348,11 +1368,12 @@ module Google class ListAssetsResult include Google::Apis::Core::Hashable - # Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud - # Platform (GCP) resource. - # The Asset is a Cloud SCC resource that captures information about a single - # GCP resource. All modifications to an Asset are only within the context of - # Cloud SCC and don't affect the referenced GCP resource. + # Security Command Center representation of a Google Cloud + # resource. + # The Asset is a Security Command Center resource that captures information + # about a single Google Cloud resource. All modifications to an Asset are only + # within the context of Security Command Center and don't affect the referenced + # Google Cloud resource. # Corresponds to the JSON property `asset` # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Asset] attr_accessor :asset @@ -1415,16 +1436,16 @@ module Google class ListFindingsResult include Google::Apis::Core::Hashable - # Cloud Security Command Center (Cloud SCC) finding. + # Security Command Center finding. # A finding is a record of assessment data (security, risk, health or privacy) - # ingested into Cloud SCC for presentation, notification, analysis, - # policy testing, and enforcement. For example, an XSS vulnerability in an - # App Engine application is a finding. + # ingested into Security Command Center for presentation, notification, + # analysis, policy testing, and enforcement. For example, an XSS vulnerability + # in an App Engine application is a finding. # Corresponds to the JSON property `finding` # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] attr_accessor :finding - # Information related to the Google Cloud Platform (GCP) resource that is + # Information related to the Google Cloud resource that is # associated with this finding. # Corresponds to the JSON property `resource` # @return [Google::Apis::SecuritycenterV1p1beta1::Resource] @@ -1524,9 +1545,10 @@ module Google end end - # Cloud Security Command Center (Cloud SCC) notification configs. - # A notification config is a Cloud SCC resource that contains the configuration - # to send notifications for create/update events of findings, assets and etc. + # Security Command Center notification configs. + # A notification config is a Security Command Center resource that contains the + # configuration to send notifications for create/update events of findings, + # assets and etc. class NotificationConfig include Google::Apis::Core::Hashable @@ -1548,14 +1570,14 @@ module Google # @return [String] attr_accessor :name - # The PubSub topic to send notifications to. Its format is + # The Pub/Sub topic to send notifications to. Its format is # "projects/[project_id]/topics/[topic]". # Corresponds to the JSON property `pubsubTopic` # @return [String] attr_accessor :pubsub_topic # Output only. The service account that needs "pubsub.topics.publish" - # permission to publish to the PubSub topic. + # permission to publish to the Pub/Sub topic. # Corresponds to the JSON property `serviceAccount` # @return [String] attr_accessor :service_account @@ -1645,8 +1667,8 @@ module Google end end - # User specified settings that are attached to the Cloud Security Command - # Center (Cloud SCC) organization. + # User specified settings that are attached to the Security Command + # Center organization. class OrganizationSettings include Google::Apis::Core::Hashable @@ -1804,7 +1826,7 @@ module Google end end - # Information related to the Google Cloud Platform (GCP) resource that is + # Information related to the Google Cloud resource that is # associated with this finding. class Resource include Google::Apis::Core::Hashable @@ -1862,9 +1884,9 @@ module Google end end - # User specified security marks that are attached to the parent Cloud Security - # Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud - # SCC organization -- they can be modified and viewed by all users who have + # User specified security marks that are attached to the parent Security + # Command Center resource. Security marks are scoped within a Security Command + # Center organization -- they can be modified and viewed by all users who have # proper permissions on the organization. class SecurityMarks include Google::Apis::Core::Hashable @@ -2010,7 +2032,7 @@ module Google end end - # Cloud Security Command Center's (Cloud SCC) finding source. A finding source + # Security Command Center finding source. A finding source # is an entity or a mechanism that can produce a finding. A source is like a # container of findings that come from the same scanner, logger, monitor, etc. class Source @@ -2018,7 +2040,7 @@ module Google # The description of the source (max of 1024 characters). # Example: - # "Cloud Security Scanner is a web security scanner for common + # "Web Security Scanner is a web security scanner for common # vulnerabilities in App Engine applications. It can automatically # scan and detect four common vulnerabilities, including cross-site-scripting # (XSS), Flash injection, mixed content (HTTP in HTTPS), and diff --git a/generated/google/apis/securitycenter_v1p1beta1/service.rb b/generated/google/apis/securitycenter_v1p1beta1/service.rb index 3e7e61891..050d12fa8 100644 --- a/generated/google/apis/securitycenter_v1p1beta1/service.rb +++ b/generated/google/apis/securitycenter_v1p1beta1/service.rb @@ -20,10 +20,10 @@ require 'google/apis/errors' module Google module Apis module SecuritycenterV1p1beta1 - # Cloud Security Command Center API + # Security Command Center API # - # Cloud Security Command Center API provides access to temporal views of assets - # and findings within an organization. + # Security Command Center API provides access to temporal views of assets and + # findings within an organization. # # @example # require 'google/apis/securitycenter_v1p1beta1' @@ -229,6 +229,10 @@ module Google # * security_center_properties.resource_project_display_name: `=`, `:` # * security_center_properties.resource_owners: `=`, `:` # For example, `resource_properties.size = 100` is a valid filter string. + # Use a partial match on the empty string to filter based on a property + # existing: "resource_properties.my_property : \"\"" + # Use a negated partial match on the empty string to filter based on a + # property not existing: "-resource_properties.my_property : \"\"" # @param [String] order_by # Expression that defines what fields and order to use for sorting. The # string value should follow SQL syntax: comma separated list of fields. For @@ -1115,6 +1119,10 @@ module Google # security_marks.marks: `=`, `:` # source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` # For example, `source_properties.size = 100` is a valid filter string. + # Use a partial match on the empty string to filter based on a property + # existing: "source_properties.my_property : \"\"" + # Use a negated partial match on the empty string to filter based on a + # property not existing: "-source_properties.my_property : \"\"" # @param [String] order_by # Expression that defines what fields and order to use for sorting. The # string value should follow SQL syntax: comma separated list of fields. For diff --git a/generated/google/apis/serviceconsumermanagement_v1.rb b/generated/google/apis/serviceconsumermanagement_v1.rb index 681d8c7b5..8673f420c 100644 --- a/generated/google/apis/serviceconsumermanagement_v1.rb +++ b/generated/google/apis/serviceconsumermanagement_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/service-consumer-management/docs/overview module ServiceconsumermanagementV1 VERSION = 'V1' - REVISION = '20200305' + REVISION = '20200329' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/serviceconsumermanagement_v1/classes.rb b/generated/google/apis/serviceconsumermanagement_v1/classes.rb index 064f6a5e9..0c5f75a7d 100644 --- a/generated/google/apis/serviceconsumermanagement_v1/classes.rb +++ b/generated/google/apis/serviceconsumermanagement_v1/classes.rb @@ -206,12 +206,16 @@ module Google # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# # section-4.1.3). # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, only JWTs with audience - # "https://Service_name/API_name" - # will be accepted. For example, if no audiences are in the setting, - # LibraryService API will only accept JWTs with the following audience - # "https://library-example.googleapis.com/google.example.library.v1. - # LibraryService". + # be accepted. When this setting is absent, JWTs with audiences: + # - "https://[service.name]/[google.protobuf.Api.name]" + # - "https://[service.name]/" + # will be accepted. + # For example, if no audiences are in the setting, LibraryService API will + # accept JWTs with the following audiences: + # - + # https://library-example.googleapis.com/google.example.library.v1. + # LibraryService + # - https://library-example.googleapis.com/ # Example: # audiences: bookstore_android.apps.googleusercontent.com, # bookstore_web.apps.googleusercontent.com @@ -531,6 +535,36 @@ module Google # @return [String] attr_accessor :protocol + # Unimplemented. Do not use. + # The new name the selected proto elements should be renamed to. + # The package, the service and the method can all be renamed. + # The backend server should implement the renamed proto. However, clients + # should call the original method, and ESF routes the traffic to the renamed + # method. + # HTTP clients should call the URL mapped to the original method. + # gRPC and Stubby clients should call the original method with package name. + # For legacy reasons, ESF allows Stubby clients to call with the + # short name (without the package name). However, for API Versioning(or + # multiple methods mapped to the same short name), all Stubby clients must + # call the method's full name with the package name, otherwise the first one + # (selector) wins. + # If this `rename_to` is specified with a trailing `*`, the `selector` must + # be specified with a trailing `*` as well. The all element short names + # matched by the `*` in the selector will be kept in the `rename_to`. + # For example, + # rename_rules: + # - selector: |- + # google.example.library.v1.* + # rename_to: google.example.library.* + # The selector matches `google.example.library.v1.Library.CreateShelf` and + # `google.example.library.v1.Library.CreateBook`, they will be renamed to + # `google.example.library.Library.CreateShelf` and + # `google.example.library.Library.CreateBook`. It essentially renames the + # proto package name section of the matched proto service and methods. + # Corresponds to the JSON property `renameTo` + # @return [String] + attr_accessor :rename_to + # Selects the methods to which this rule applies. # Refer to selector for syntax details. # Corresponds to the JSON property `selector` @@ -551,6 +585,7 @@ module Google @operation_deadline = args[:operation_deadline] if args.key?(:operation_deadline) @path_translation = args[:path_translation] if args.key?(:path_translation) @protocol = args[:protocol] if args.key?(:protocol) + @rename_to = args[:rename_to] if args.key?(:rename_to) @selector = args[:selector] if args.key?(:selector) end end diff --git a/generated/google/apis/serviceconsumermanagement_v1/representations.rb b/generated/google/apis/serviceconsumermanagement_v1/representations.rb index b420a2c68..8c2ec68cb 100644 --- a/generated/google/apis/serviceconsumermanagement_v1/representations.rb +++ b/generated/google/apis/serviceconsumermanagement_v1/representations.rb @@ -662,6 +662,7 @@ module Google property :operation_deadline, as: 'operationDeadline' property :path_translation, as: 'pathTranslation' property :protocol, as: 'protocol' + property :rename_to, as: 'renameTo' property :selector, as: 'selector' end end diff --git a/generated/google/apis/cloudprivatecatalogproducer_v1beta1.rb b/generated/google/apis/serviceconsumermanagement_v1beta1.rb similarity index 62% rename from generated/google/apis/cloudprivatecatalogproducer_v1beta1.rb rename to generated/google/apis/serviceconsumermanagement_v1beta1.rb index aacd7244e..a8eecd8dd 100644 --- a/generated/google/apis/cloudprivatecatalogproducer_v1beta1.rb +++ b/generated/google/apis/serviceconsumermanagement_v1beta1.rb @@ -12,21 +12,20 @@ # See the License for the specific language governing permissions and # limitations under the License. -require 'google/apis/cloudprivatecatalogproducer_v1beta1/service.rb' -require 'google/apis/cloudprivatecatalogproducer_v1beta1/classes.rb' -require 'google/apis/cloudprivatecatalogproducer_v1beta1/representations.rb' +require 'google/apis/serviceconsumermanagement_v1beta1/service.rb' +require 'google/apis/serviceconsumermanagement_v1beta1/classes.rb' +require 'google/apis/serviceconsumermanagement_v1beta1/representations.rb' module Google module Apis - # Cloud Private Catalog Producer API + # Service Consumer Management API # - # Enables cloud users to manage and share enterprise catalogs intheir - # organizations. + # Manages the service consumers of a Service Infrastructure service. # - # @see https://cloud.google.com/private-catalog/ - module CloudprivatecatalogproducerV1beta1 + # @see https://cloud.google.com/service-consumer-management/docs/overview + module ServiceconsumermanagementV1beta1 VERSION = 'V1beta1' - REVISION = '20200210' + REVISION = '20200329' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb b/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb new file mode 100644 index 000000000..5527ec520 --- /dev/null +++ b/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb @@ -0,0 +1,4170 @@ +# Copyright 2015 Google Inc. +# +# 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 ServiceconsumermanagementV1beta1 + + # Api is a light-weight descriptor for an API Interface. + # Interfaces are also described as "protocol buffer services" in some contexts, + # such as by the "service" keyword in a .proto file, but they are different + # from API Services, which represent a concrete implementation of an interface + # as opposed to simply a description of methods and bindings. They are also + # sometimes simply referred to as "APIs" in other contexts, such as the name of + # this message itself. See https://cloud.google.com/apis/design/glossary for + # detailed terminology. + class Api + include Google::Apis::Core::Hashable + + # The methods of this interface, in unspecified order. + # Corresponds to the JSON property `methods` + # @return [Array] + attr_accessor :methods_prop + + # Included interfaces. See Mixin. + # Corresponds to the JSON property `mixins` + # @return [Array] + attr_accessor :mixins + + # The fully qualified name of this interface, including package name + # followed by the interface's simple name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Any metadata attached to the interface. + # Corresponds to the JSON property `options` + # @return [Array] + attr_accessor :options + + # `SourceContext` represents information about the source of a + # protobuf element, like the file in which it is defined. + # Corresponds to the JSON property `sourceContext` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::SourceContext] + attr_accessor :source_context + + # The source syntax of the service. + # Corresponds to the JSON property `syntax` + # @return [String] + attr_accessor :syntax + + # A version string for this interface. If specified, must have the form + # `major-version.minor-version`, as in `1.10`. If the minor version is + # omitted, it defaults to zero. If the entire version field is empty, the + # major version is derived from the package name, as outlined below. If the + # field is not empty, the version in the package name will be verified to be + # consistent with what is provided here. + # The versioning schema uses [semantic + # versioning](http://semver.org) where the major version number + # indicates a breaking change and the minor version an additive, + # non-breaking change. Both version numbers are signals to users + # what to expect from different versions, and should be carefully + # chosen based on the product plan. + # The major version is also reflected in the package name of the + # interface, which must end in `v`, as in + # `google.feature.v1`. For major versions 0 and 1, the suffix can + # be omitted. Zero major versions must only be used for + # experimental, non-GA interfaces. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @methods_prop = args[:methods_prop] if args.key?(:methods_prop) + @mixins = args[:mixins] if args.key?(:mixins) + @name = args[:name] if args.key?(:name) + @options = args[:options] if args.key?(:options) + @source_context = args[:source_context] if args.key?(:source_context) + @syntax = args[:syntax] if args.key?(:syntax) + @version = args[:version] if args.key?(:version) + end + end + + # Configuration for an authentication provider, including support for + # [JSON Web Token + # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + class AuthProvider + include Google::Apis::Core::Hashable + + # The list of JWT + # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# + # section-4.1.3). + # that are allowed to access. A JWT containing any of these audiences will + # be accepted. When this setting is absent, JWTs with audiences: + # - "https://[service.name]/[google.protobuf.Api.name]" + # - "https://[service.name]/" + # will be accepted. + # For example, if no audiences are in the setting, LibraryService API will + # accept JWTs with the following audiences: + # - + # https://library-example.googleapis.com/google.example.library.v1. + # LibraryService + # - https://library-example.googleapis.com/ + # Example: + # audiences: bookstore_android.apps.googleusercontent.com, + # bookstore_web.apps.googleusercontent.com + # Corresponds to the JSON property `audiences` + # @return [String] + attr_accessor :audiences + + # Redirect URL if JWT token is required but not present or is expired. + # Implement authorizationUrl of securityDefinitions in OpenAPI spec. + # Corresponds to the JSON property `authorizationUrl` + # @return [String] + attr_accessor :authorization_url + + # The unique identifier of the auth provider. It will be referred to by + # `AuthRequirement.provider_id`. + # Example: "bookstore_auth". + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies the principal that issued the JWT. See + # https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 + # Usually a URL or an email address. + # Example: https://securetoken.google.com + # Example: 1234567-compute@developer.gserviceaccount.com + # Corresponds to the JSON property `issuer` + # @return [String] + attr_accessor :issuer + + # URL of the provider's public key set to validate signature of the JWT. See + # [OpenID + # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html# + # ProviderMetadata). + # Optional if the key set document: + # - can be retrieved from + # [OpenID + # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of + # the issuer. + # - can be inferred from the email domain of the issuer (e.g. a Google + # service account). + # Example: https://www.googleapis.com/oauth2/v1/certs + # Corresponds to the JSON property `jwksUri` + # @return [String] + attr_accessor :jwks_uri + + # Defines the locations to extract the JWT. + # JWT locations can be either from HTTP headers or URL query parameters. + # The rule is that the first match wins. The checking order is: checking + # all headers first, then URL query parameters. + # If not specified, default to use following 3 locations: + # 1) Authorization: Bearer + # 2) x-goog-iap-jwt-assertion + # 3) access_token query parameter + # Default locations can be specified as followings: + # jwt_locations: + # - header: Authorization + # value_prefix: "Bearer " + # - header: x-goog-iap-jwt-assertion + # - query: access_token + # Corresponds to the JSON property `jwtLocations` + # @return [Array] + attr_accessor :jwt_locations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audiences = args[:audiences] if args.key?(:audiences) + @authorization_url = args[:authorization_url] if args.key?(:authorization_url) + @id = args[:id] if args.key?(:id) + @issuer = args[:issuer] if args.key?(:issuer) + @jwks_uri = args[:jwks_uri] if args.key?(:jwks_uri) + @jwt_locations = args[:jwt_locations] if args.key?(:jwt_locations) + end + end + + # User-defined authentication requirements, including support for + # [JSON Web Token + # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). + class AuthRequirement + include Google::Apis::Core::Hashable + + # NOTE: This will be deprecated soon, once AuthProvider.audiences is + # implemented and accepted in all the runtime components. + # The list of JWT + # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# + # section-4.1.3). + # that are allowed to access. A JWT containing any of these audiences will + # be accepted. When this setting is absent, only JWTs with audience + # "https://Service_name/API_name" + # will be accepted. For example, if no audiences are in the setting, + # LibraryService API will only accept JWTs with the following audience + # "https://library-example.googleapis.com/google.example.library.v1. + # LibraryService". + # Example: + # audiences: bookstore_android.apps.googleusercontent.com, + # bookstore_web.apps.googleusercontent.com + # Corresponds to the JSON property `audiences` + # @return [String] + attr_accessor :audiences + + # id from authentication provider. + # Example: + # provider_id: bookstore_auth + # Corresponds to the JSON property `providerId` + # @return [String] + attr_accessor :provider_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audiences = args[:audiences] if args.key?(:audiences) + @provider_id = args[:provider_id] if args.key?(:provider_id) + end + end + + # `Authentication` defines the authentication configuration for an API. + # Example for an API targeted for external use: + # name: calendar.googleapis.com + # authentication: + # providers: + # - id: google_calendar_auth + # jwks_uri: https://www.googleapis.com/oauth2/v1/certs + # issuer: https://securetoken.google.com + # rules: + # - selector: "*" + # requirements: + # provider_id: google_calendar_auth + class Authentication + include Google::Apis::Core::Hashable + + # Defines a set of authentication providers that a service supports. + # Corresponds to the JSON property `providers` + # @return [Array] + attr_accessor :providers + + # A list of authentication rules that apply to individual API methods. + # **NOTE:** All service configuration rules follow "last one wins" order. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @providers = args[:providers] if args.key?(:providers) + @rules = args[:rules] if args.key?(:rules) + end + end + + # Authentication rules for the service. + # By default, if a method has any authentication requirements, every request + # must include a valid credential matching one of the requirements. + # It's an error to include more than one kind of credential in a single + # request. + # If a method doesn't have any auth requirements, request credentials will be + # ignored. + class AuthenticationRule + include Google::Apis::Core::Hashable + + # If true, the service accepts API keys without any other credential. + # Corresponds to the JSON property `allowWithoutCredential` + # @return [Boolean] + attr_accessor :allow_without_credential + alias_method :allow_without_credential?, :allow_without_credential + + # OAuth scopes are a way to define data and permissions on data. For example, + # there are scopes defined for "Read-only access to Google Calendar" and + # "Access to Cloud Platform". Users can consent to a scope for an application, + # giving it permission to access that data on their behalf. + # OAuth scope specifications should be fairly coarse grained; a user will need + # to see and understand the text description of what your scope means. + # In most cases: use one or at most two OAuth scopes for an entire family of + # products. If your product has multiple APIs, you should probably be sharing + # the OAuth scope across all of those APIs. + # When you need finer grained OAuth consent screens: talk with your product + # management about how developers will use them in practice. + # Please note that even though each of the canonical scopes is enough for a + # request to be accepted and passed to the backend, a request can still fail + # due to the backend requiring additional scopes or permissions. + # Corresponds to the JSON property `oauth` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::OAuthRequirements] + attr_accessor :oauth + + # Requirements for additional authentication providers. + # Corresponds to the JSON property `requirements` + # @return [Array] + attr_accessor :requirements + + # Selects the methods to which this rule applies. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allow_without_credential = args[:allow_without_credential] if args.key?(:allow_without_credential) + @oauth = args[:oauth] if args.key?(:oauth) + @requirements = args[:requirements] if args.key?(:requirements) + @selector = args[:selector] if args.key?(:selector) + end + end + + # `Backend` defines the backend configuration for a service. + class Backend + include Google::Apis::Core::Hashable + + # A list of API backend rules that apply to individual API methods. + # **NOTE:** All service configuration rules follow "last one wins" order. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @rules = args[:rules] if args.key?(:rules) + end + end + + # A backend rule provides configuration for an individual API element. + class BackendRule + include Google::Apis::Core::Hashable + + # The address of the API backend. + # The scheme is used to determine the backend protocol and security. + # The following schemes are accepted: + # SCHEME PROTOCOL SECURITY + # http:// HTTP None + # https:// HTTP TLS + # grpc:// gRPC None + # grpcs:// gRPC TLS + # It is recommended to explicitly include a scheme. Leaving out the scheme + # may cause constrasting behaviors across platforms. + # If the port is unspecified, the default is: + # - 80 for schemes without TLS + # - 443 for schemes with TLS + # For HTTP backends, use protocol + # to specify the protocol version. + # Corresponds to the JSON property `address` + # @return [String] + attr_accessor :address + + # The number of seconds to wait for a response from a request. The default + # varies based on the request protocol and deployment environment. + # Corresponds to the JSON property `deadline` + # @return [Float] + attr_accessor :deadline + + # When disable_auth is true, a JWT ID token won't be generated and the + # original "Authorization" HTTP header will be preserved. If the header is + # used to carry the original token and is expected by the backend, this + # field must be set to true to preserve the header. + # Corresponds to the JSON property `disableAuth` + # @return [Boolean] + attr_accessor :disable_auth + alias_method :disable_auth?, :disable_auth + + # The JWT audience is used when generating a JWT ID token for the backend. + # This ID token will be added in the HTTP "authorization" header, and sent + # to the backend. + # Corresponds to the JSON property `jwtAudience` + # @return [String] + attr_accessor :jwt_audience + + # Minimum deadline in seconds needed for this method. Calls having deadline + # value lower than this will be rejected. + # Corresponds to the JSON property `minDeadline` + # @return [Float] + attr_accessor :min_deadline + + # The number of seconds to wait for the completion of a long running + # operation. The default is no deadline. + # Corresponds to the JSON property `operationDeadline` + # @return [Float] + attr_accessor :operation_deadline + + # + # Corresponds to the JSON property `pathTranslation` + # @return [String] + attr_accessor :path_translation + + # The protocol used for sending a request to the backend. + # The supported values are "http/1.1" and "h2". + # The default value is inferred from the scheme in the + # address field: + # SCHEME PROTOCOL + # http:// http/1.1 + # https:// http/1.1 + # grpc:// h2 + # grpcs:// h2 + # For secure HTTP backends (https://) that support HTTP/2, set this field + # to "h2" for improved performance. + # Configuring this field to non-default values is only supported for secure + # HTTP backends. This field will be ignored for all other backends. + # See + # https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype- + # values.xhtml#alpn-protocol-ids + # for more details on the supported values. + # Corresponds to the JSON property `protocol` + # @return [String] + attr_accessor :protocol + + # Unimplemented. Do not use. + # The new name the selected proto elements should be renamed to. + # The package, the service and the method can all be renamed. + # The backend server should implement the renamed proto. However, clients + # should call the original method, and ESF routes the traffic to the renamed + # method. + # HTTP clients should call the URL mapped to the original method. + # gRPC and Stubby clients should call the original method with package name. + # For legacy reasons, ESF allows Stubby clients to call with the + # short name (without the package name). However, for API Versioning(or + # multiple methods mapped to the same short name), all Stubby clients must + # call the method's full name with the package name, otherwise the first one + # (selector) wins. + # If this `rename_to` is specified with a trailing `*`, the `selector` must + # be specified with a trailing `*` as well. The all element short names + # matched by the `*` in the selector will be kept in the `rename_to`. + # For example, + # rename_rules: + # - selector: |- + # google.example.library.v1.* + # rename_to: google.example.library.* + # The selector matches `google.example.library.v1.Library.CreateShelf` and + # `google.example.library.v1.Library.CreateBook`, they will be renamed to + # `google.example.library.Library.CreateShelf` and + # `google.example.library.Library.CreateBook`. It essentially renames the + # proto package name section of the matched proto service and methods. + # Corresponds to the JSON property `renameTo` + # @return [String] + attr_accessor :rename_to + + # Selects the methods to which this rule applies. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @address = args[:address] if args.key?(:address) + @deadline = args[:deadline] if args.key?(:deadline) + @disable_auth = args[:disable_auth] if args.key?(:disable_auth) + @jwt_audience = args[:jwt_audience] if args.key?(:jwt_audience) + @min_deadline = args[:min_deadline] if args.key?(:min_deadline) + @operation_deadline = args[:operation_deadline] if args.key?(:operation_deadline) + @path_translation = args[:path_translation] if args.key?(:path_translation) + @protocol = args[:protocol] if args.key?(:protocol) + @rename_to = args[:rename_to] if args.key?(:rename_to) + @selector = args[:selector] if args.key?(:selector) + end + end + + # Billing related configuration of the service. + # The following example shows how to configure monitored resources and metrics + # for billing: + # monitored_resources: + # - type: library.googleapis.com/branch + # labels: + # - key: /city + # description: The city where the library branch is located in. + # - key: /name + # description: The name of the branch. + # metrics: + # - name: library.googleapis.com/book/borrowed_count + # metric_kind: DELTA + # value_type: INT64 + # billing: + # consumer_destinations: + # - monitored_resource: library.googleapis.com/branch + # metrics: + # - library.googleapis.com/book/borrowed_count + class Billing + include Google::Apis::Core::Hashable + + # Billing configurations for sending metrics to the consumer project. + # There can be multiple consumer destinations per service, each one must have + # a different monitored resource type. A metric can be used in at most + # one consumer destination. + # Corresponds to the JSON property `consumerDestinations` + # @return [Array] + attr_accessor :consumer_destinations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @consumer_destinations = args[:consumer_destinations] if args.key?(:consumer_destinations) + end + end + + # Configuration of a specific billing destination (Currently only support + # bill against consumer project). + class BillingDestination + include Google::Apis::Core::Hashable + + # Names of the metrics to report to this billing destination. + # Each name must be defined in Service.metrics section. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # The monitored resource type. The type must be defined in + # Service.monitored_resources section. + # Corresponds to the JSON property `monitoredResource` + # @return [String] + attr_accessor :monitored_resource + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @metrics = args[:metrics] if args.key?(:metrics) + @monitored_resource = args[:monitored_resource] if args.key?(:monitored_resource) + end + end + + # `Context` defines which contexts an API requests. + # Example: + # context: + # rules: + # - selector: "*" + # requested: + # - google.rpc.context.ProjectContext + # - google.rpc.context.OriginContext + # The above specifies that all methods in the API request + # `google.rpc.context.ProjectContext` and + # `google.rpc.context.OriginContext`. + # Available context types are defined in package + # `google.rpc.context`. + # This also provides mechanism to whitelist any protobuf message extension that + # can be sent in grpc metadata using “x-goog-ext--bin” and + # “x-goog-ext--jspb” format. For example, list any service + # specific protobuf types that can appear in grpc metadata as follows in your + # yaml file: + # Example: + # context: + # rules: + # - selector: "google.example.library.v1.LibraryService.CreateBook" + # allowed_request_extensions: + # - google.foo.v1.NewExtension + # allowed_response_extensions: + # - google.foo.v1.NewExtension + # You can also specify extension ID instead of fully qualified extension name + # here. + class Context + include Google::Apis::Core::Hashable + + # A list of RPC context rules that apply to individual API methods. + # **NOTE:** All service configuration rules follow "last one wins" order. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @rules = args[:rules] if args.key?(:rules) + end + end + + # A context rule provides information about the context for an individual API + # element. + class ContextRule + include Google::Apis::Core::Hashable + + # A list of full type names or extension IDs of extensions allowed in grpc + # side channel from client to backend. + # Corresponds to the JSON property `allowedRequestExtensions` + # @return [Array] + attr_accessor :allowed_request_extensions + + # A list of full type names or extension IDs of extensions allowed in grpc + # side channel from backend to client. + # Corresponds to the JSON property `allowedResponseExtensions` + # @return [Array] + attr_accessor :allowed_response_extensions + + # A list of full type names of provided contexts. + # Corresponds to the JSON property `provided` + # @return [Array] + attr_accessor :provided + + # A list of full type names of requested contexts. + # Corresponds to the JSON property `requested` + # @return [Array] + attr_accessor :requested + + # Selects the methods to which this rule applies. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allowed_request_extensions = args[:allowed_request_extensions] if args.key?(:allowed_request_extensions) + @allowed_response_extensions = args[:allowed_response_extensions] if args.key?(:allowed_response_extensions) + @provided = args[:provided] if args.key?(:provided) + @requested = args[:requested] if args.key?(:requested) + @selector = args[:selector] if args.key?(:selector) + end + end + + # Selects and configures the service controller used by the service. The + # service controller handles features like abuse, quota, billing, logging, + # monitoring, etc. + class Control + include Google::Apis::Core::Hashable + + # The service control environment to use. If empty, no control plane + # feature (like quota and billing) will be enabled. + # Corresponds to the JSON property `environment` + # @return [String] + attr_accessor :environment + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @environment = args[:environment] if args.key?(:environment) + end + end + + # Customize service error responses. For example, list any service + # specific protobuf types that can appear in error detail lists of + # error responses. + # Example: + # custom_error: + # types: + # - google.foo.v1.CustomError + # - google.foo.v1.AnotherError + class CustomError + include Google::Apis::Core::Hashable + + # The list of custom error rules that apply to individual API messages. + # **NOTE:** All service configuration rules follow "last one wins" order. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. + # Corresponds to the JSON property `types` + # @return [Array] + attr_accessor :types + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @rules = args[:rules] if args.key?(:rules) + @types = args[:types] if args.key?(:types) + end + end + + # A custom error rule. + class CustomErrorRule + include Google::Apis::Core::Hashable + + # Mark this message as possible payload in error response. Otherwise, + # objects of this type will be filtered when they appear in error payload. + # Corresponds to the JSON property `isErrorType` + # @return [Boolean] + attr_accessor :is_error_type + alias_method :is_error_type?, :is_error_type + + # Selects messages to which this rule applies. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @is_error_type = args[:is_error_type] if args.key?(:is_error_type) + @selector = args[:selector] if args.key?(:selector) + end + end + + # A custom pattern is used for defining custom HTTP verb. + class CustomHttpPattern + include Google::Apis::Core::Hashable + + # The name of this custom HTTP verb. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The path matched by this custom verb. + # 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) + @kind = args[:kind] if args.key?(:kind) + @path = args[:path] if args.key?(:path) + end + end + + # `Documentation` provides the information for describing a service. + # Example: + #
    documentation:
    +      # summary: >
    +      # The Google Calendar API gives access
    +      # to most calendar features.
    +      # pages:
    +      # - name: Overview
    +      # content: (== include google/foo/overview.md ==)
    +      # - name: Tutorial
    +      # content: (== include google/foo/tutorial.md ==)
    +      # subpages;
    +      # - name: Java
    +      # content: (== include google/foo/tutorial_java.md ==)
    +      # rules:
    +      # - selector: google.calendar.Calendar.Get
    +      # description: >
    +      # ...
    +      # - selector: google.calendar.Calendar.Put
    +      # description: >
    +      # ...
    +      # 
    + # Documentation is provided in markdown syntax. In addition to + # standard markdown features, definition lists, tables and fenced + # code blocks are supported. Section headers can be provided and are + # interpreted relative to the section nesting of the context where + # a documentation fragment is embedded. + # Documentation from the IDL is merged with documentation defined + # via the config at normalization time, where documentation provided + # by config rules overrides IDL provided. + # A number of constructs specific to the API platform are supported + # in documentation text. + # In order to reference a proto element, the following + # notation can be used: + #
    [fully.qualified.proto.name][]
    + # To override the display text used for the link, this can be used: + #
    [display text][fully.qualified.proto.name]
    + # Text can be excluded from doc using the following notation: + #
    (-- internal comment --)
    + # A few directives are available in documentation. Note that + # directives must appear on a single line to be properly + # identified. The `include` directive includes a markdown file from + # an external source: + #
    (== include path/to/file ==)
    + # The `resource_for` directive marks a message to be the resource of + # a collection in REST view. If it is not specified, tools attempt + # to infer the resource from the operations in a collection: + #
    (== resource_for v1.shelves.books ==)
    + # The directive `suppress_warning` does not directly affect documentation + # and is documented together with service config validation. + class Documentation + include Google::Apis::Core::Hashable + + # The URL to the root of documentation. + # Corresponds to the JSON property `documentationRootUrl` + # @return [String] + attr_accessor :documentation_root_url + + # Declares a single overview page. For example: + #
    documentation:
    +        # summary: ...
    +        # overview: (== include overview.md ==)
    +        # 
    + # This is a shortcut for the following declaration (using pages style): + #
    documentation:
    +        # summary: ...
    +        # pages:
    +        # - name: Overview
    +        # content: (== include overview.md ==)
    +        # 
    + # Note: you cannot specify both `overview` field and `pages` field. + # Corresponds to the JSON property `overview` + # @return [String] + attr_accessor :overview + + # The top level pages for the documentation set. + # Corresponds to the JSON property `pages` + # @return [Array] + attr_accessor :pages + + # A list of documentation rules that apply to individual API elements. + # **NOTE:** All service configuration rules follow "last one wins" order. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + # Specifies the service root url if the default one (the service name + # from the yaml file) is not suitable. This can be seen in any fully + # specified service urls as well as sections that show a base that other + # urls are relative to. + # Corresponds to the JSON property `serviceRootUrl` + # @return [String] + attr_accessor :service_root_url + + # A short summary of what the service does. Can only be provided by + # plain text. + # Corresponds to the JSON property `summary` + # @return [String] + attr_accessor :summary + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @documentation_root_url = args[:documentation_root_url] if args.key?(:documentation_root_url) + @overview = args[:overview] if args.key?(:overview) + @pages = args[:pages] if args.key?(:pages) + @rules = args[:rules] if args.key?(:rules) + @service_root_url = args[:service_root_url] if args.key?(:service_root_url) + @summary = args[:summary] if args.key?(:summary) + end + end + + # A documentation rule provides information about individual API elements. + class DocumentationRule + include Google::Apis::Core::Hashable + + # Deprecation description of the selected element(s). It can be provided if + # an element is marked as `deprecated`. + # Corresponds to the JSON property `deprecationDescription` + # @return [String] + attr_accessor :deprecation_description + + # Description of the selected API(s). + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The selector is a comma-separated list of patterns. Each pattern is a + # qualified name of the element which may end in "*", indicating a wildcard. + # Wildcards are only allowed at the end and for a whole component of the + # qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A + # wildcard will match one or more components. To specify a default for all + # applicable elements, the whole pattern "*" is used. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @deprecation_description = args[:deprecation_description] if args.key?(:deprecation_description) + @description = args[:description] if args.key?(:description) + @selector = args[:selector] if args.key?(:selector) + 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 + + # `Endpoint` describes a network endpoint that serves a set of APIs. + # A service may expose any number of endpoints, and all endpoints share the + # same service configuration, such as quota configuration and monitoring + # configuration. + # Example service configuration: + # name: library-example.googleapis.com + # endpoints: + # # Below entry makes 'google.example.library.v1.Library' + # # API be served from endpoint address library-example.googleapis.com. + # # It also allows HTTP OPTIONS calls to be passed to the backend, for + # # it to decide whether the subsequent cross-origin request is + # # allowed to proceed. + # - name: library-example.googleapis.com + # allow_cors: true + class Endpoint + include Google::Apis::Core::Hashable + + # DEPRECATED: This field is no longer supported. Instead of using aliases, + # please specify multiple google.api.Endpoint for each of the intended + # aliases. + # Additional names that this endpoint will be hosted on. + # Corresponds to the JSON property `aliases` + # @return [Array] + attr_accessor :aliases + + # Allowing + # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka + # cross-domain traffic, would allow the backends served from this endpoint to + # receive and respond to HTTP OPTIONS requests. The response will be used by + # the browser to determine whether the subsequent cross-origin request is + # allowed to proceed. + # Corresponds to the JSON property `allowCors` + # @return [Boolean] + attr_accessor :allow_cors + alias_method :allow_cors?, :allow_cors + + # The list of features enabled on this endpoint. + # Corresponds to the JSON property `features` + # @return [Array] + attr_accessor :features + + # The canonical name of this endpoint. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The specification of an Internet routable address of API frontend that will + # handle requests to this [API + # Endpoint](https://cloud.google.com/apis/design/glossary). It should be + # either a valid IPv4 address or a fully-qualified domain name. For example, + # "8.8.8.8" or "myservice.appspot.com". + # Corresponds to the JSON property `target` + # @return [String] + attr_accessor :target + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @aliases = args[:aliases] if args.key?(:aliases) + @allow_cors = args[:allow_cors] if args.key?(:allow_cors) + @features = args[:features] if args.key?(:features) + @name = args[:name] if args.key?(:name) + @target = args[:target] if args.key?(:target) + end + end + + # Enum type definition. + class Enum + include Google::Apis::Core::Hashable + + # Enum value definitions. + # Corresponds to the JSON property `enumvalue` + # @return [Array] + attr_accessor :enumvalue + + # Enum type name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Protocol buffer options. + # Corresponds to the JSON property `options` + # @return [Array] + attr_accessor :options + + # `SourceContext` represents information about the source of a + # protobuf element, like the file in which it is defined. + # Corresponds to the JSON property `sourceContext` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::SourceContext] + attr_accessor :source_context + + # The source syntax. + # Corresponds to the JSON property `syntax` + # @return [String] + attr_accessor :syntax + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @enumvalue = args[:enumvalue] if args.key?(:enumvalue) + @name = args[:name] if args.key?(:name) + @options = args[:options] if args.key?(:options) + @source_context = args[:source_context] if args.key?(:source_context) + @syntax = args[:syntax] if args.key?(:syntax) + end + end + + # Enum value definition. + class EnumValue + include Google::Apis::Core::Hashable + + # Enum value name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Enum value number. + # Corresponds to the JSON property `number` + # @return [Fixnum] + attr_accessor :number + + # Protocol buffer options. + # Corresponds to the JSON property `options` + # @return [Array] + attr_accessor :options + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @number = args[:number] if args.key?(:number) + @options = args[:options] if args.key?(:options) + end + end + + # A single field of a message type. + class Field + include Google::Apis::Core::Hashable + + # The field cardinality. + # Corresponds to the JSON property `cardinality` + # @return [String] + attr_accessor :cardinality + + # The string value of the default value of this field. Proto2 syntax only. + # Corresponds to the JSON property `defaultValue` + # @return [String] + attr_accessor :default_value + + # The field JSON name. + # Corresponds to the JSON property `jsonName` + # @return [String] + attr_accessor :json_name + + # The field type. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The field name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The field number. + # Corresponds to the JSON property `number` + # @return [Fixnum] + attr_accessor :number + + # The index of the field type in `Type.oneofs`, for message or enumeration + # types. The first type has index 1; zero means the type is not in the list. + # Corresponds to the JSON property `oneofIndex` + # @return [Fixnum] + attr_accessor :oneof_index + + # The protocol buffer options. + # Corresponds to the JSON property `options` + # @return [Array] + attr_accessor :options + + # Whether to use alternative packed wire representation. + # Corresponds to the JSON property `packed` + # @return [Boolean] + attr_accessor :packed + alias_method :packed?, :packed + + # The field type URL, without the scheme, for message or enumeration + # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + # Corresponds to the JSON property `typeUrl` + # @return [String] + attr_accessor :type_url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cardinality = args[:cardinality] if args.key?(:cardinality) + @default_value = args[:default_value] if args.key?(:default_value) + @json_name = args[:json_name] if args.key?(:json_name) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @number = args[:number] if args.key?(:number) + @oneof_index = args[:oneof_index] if args.key?(:oneof_index) + @options = args[:options] if args.key?(:options) + @packed = args[:packed] if args.key?(:packed) + @type_url = args[:type_url] if args.key?(:type_url) + end + end + + # Defines the HTTP configuration for an API service. It contains a list of + # HttpRule, each specifying the mapping of an RPC method + # to one or more HTTP REST API methods. + class Http + include Google::Apis::Core::Hashable + + # When set to true, URL path parameters will be fully URI-decoded except in + # cases of single segment matches in reserved expansion, where "%2F" will be + # left encoded. + # The default behavior is to not decode RFC 6570 reserved characters in multi + # segment matches. + # Corresponds to the JSON property `fullyDecodeReservedExpansion` + # @return [Boolean] + attr_accessor :fully_decode_reserved_expansion + alias_method :fully_decode_reserved_expansion?, :fully_decode_reserved_expansion + + # A list of HTTP configuration rules that apply to individual API methods. + # **NOTE:** All service configuration rules follow "last one wins" order. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fully_decode_reserved_expansion = args[:fully_decode_reserved_expansion] if args.key?(:fully_decode_reserved_expansion) + @rules = args[:rules] if args.key?(:rules) + end + end + + # # gRPC Transcoding + # gRPC Transcoding is a feature for mapping between a gRPC method and one or + # more HTTP REST endpoints. It allows developers to build a single API service + # that supports both gRPC APIs and REST APIs. Many systems, including [Google + # APIs](https://github.com/googleapis/googleapis), + # [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC + # Gateway](https://github.com/grpc-ecosystem/grpc-gateway), + # and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature + # and use it for large scale production services. + # `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies + # how different portions of the gRPC request message are mapped to the URL + # path, URL query parameters, and HTTP request body. It also controls how the + # gRPC response message is mapped to the HTTP response body. `HttpRule` is + # typically specified as an `google.api.http` annotation on the gRPC method. + # Each mapping specifies a URL path template and an HTTP method. The path + # template may refer to one or more fields in the gRPC request message, as long + # as each field is a non-repeated field with a primitive (non-message) type. + # The path template controls how fields of the request message are mapped to + # the URL path. + # Example: + # service Messaging ` + # rpc GetMessage(GetMessageRequest) returns (Message) ` + # option (google.api.http) = ` + # get: "/v1/`name=messages/*`" + # `; + # ` + # ` + # message GetMessageRequest ` + # string name = 1; // Mapped to URL path. + # ` + # message Message ` + # string text = 1; // The resource content. + # ` + # This enables an HTTP REST to gRPC mapping as below: + # HTTP | gRPC + # -----|----- + # `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` + # Any fields in the request message which are not bound by the path template + # automatically become HTTP query parameters if there is no HTTP request body. + # For example: + # service Messaging ` + # rpc GetMessage(GetMessageRequest) returns (Message) ` + # option (google.api.http) = ` + # get:"/v1/messages/`message_id`" + # `; + # ` + # ` + # message GetMessageRequest ` + # message SubMessage ` + # string subfield = 1; + # ` + # string message_id = 1; // Mapped to URL path. + # int64 revision = 2; // Mapped to URL query parameter `revision`. + # SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. + # ` + # This enables a HTTP JSON to RPC mapping as below: + # HTTP | gRPC + # -----|----- + # `GET /v1/messages/123456?revision=2&sub.subfield=foo` | + # `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: + # "foo"))` + # Note that fields which are mapped to URL query parameters must have a + # primitive type or a repeated primitive type or a non-repeated message type. + # In the case of a repeated type, the parameter can be repeated in the URL + # as `...?param=A¶m=B`. In the case of a message type, each field of the + # message is mapped to a separate parameter, such as + # `...?foo.a=A&foo.b=B&foo.c=C`. + # For HTTP methods that allow a request body, the `body` field + # specifies the mapping. Consider a REST update method on the + # message resource collection: + # service Messaging ` + # rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` + # option (google.api.http) = ` + # patch: "/v1/messages/`message_id`" + # body: "message" + # `; + # ` + # ` + # message UpdateMessageRequest ` + # string message_id = 1; // mapped to the URL + # Message message = 2; // mapped to the body + # ` + # The following HTTP JSON to RPC mapping is enabled, where the + # representation of the JSON in the request body is determined by + # protos JSON encoding: + # HTTP | gRPC + # -----|----- + # `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: + # "123456" message ` text: "Hi!" `)` + # The special name `*` can be used in the body mapping to define that + # every field not bound by the path template should be mapped to the + # request body. This enables the following alternative definition of + # the update method: + # service Messaging ` + # rpc UpdateMessage(Message) returns (Message) ` + # option (google.api.http) = ` + # patch: "/v1/messages/`message_id`" + # body: "*" + # `; + # ` + # ` + # message Message ` + # string message_id = 1; + # string text = 2; + # ` + # The following HTTP JSON to RPC mapping is enabled: + # HTTP | gRPC + # -----|----- + # `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: + # "123456" text: "Hi!")` + # Note that when using `*` in the body mapping, it is not possible to + # have HTTP parameters, as all fields not bound by the path end in + # the body. This makes this option more rarely used in practice when + # defining REST APIs. The common usage of `*` is in custom methods + # which don't use the URL at all for transferring data. + # It is possible to define multiple HTTP methods for one RPC by using + # the `additional_bindings` option. Example: + # service Messaging ` + # rpc GetMessage(GetMessageRequest) returns (Message) ` + # option (google.api.http) = ` + # get: "/v1/messages/`message_id`" + # additional_bindings ` + # get: "/v1/users/`user_id`/messages/`message_id`" + # ` + # `; + # ` + # ` + # message GetMessageRequest ` + # string message_id = 1; + # string user_id = 2; + # ` + # This enables the following two alternative HTTP JSON to RPC mappings: + # HTTP | gRPC + # -----|----- + # `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` + # `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: + # "123456")` + # ## Rules for HTTP mapping + # 1. Leaf request fields (recursive expansion nested messages in the request + # message) are classified into three categories: + # - Fields referred by the path template. They are passed via the URL path. + # - Fields referred by the HttpRule.body. They are passed via the HTTP + # request body. + # - All other fields are passed via the URL query parameters, and the + # parameter name is the field path in the request message. A repeated + # field can be represented as multiple query parameters under the same + # name. + # 2. If HttpRule.body is "*", there is no URL query parameter, all fields + # are passed via URL path and HTTP request body. + # 3. If HttpRule.body is omitted, there is no HTTP request body, all + # fields are passed via URL path and URL query parameters. + # ### Path template syntax + # Template = "/" Segments [ Verb ] ; + # Segments = Segment ` "/" Segment ` ; + # Segment = "*" | "**" | LITERAL | Variable ; + # Variable = "`" FieldPath [ "=" Segments ] "`" ; + # FieldPath = IDENT ` "." IDENT ` ; + # Verb = ":" LITERAL ; + # The syntax `*` matches a single URL path segment. The syntax `**` matches + # zero or more URL path segments, which must be the last part of the URL path + # except the `Verb`. + # The syntax `Variable` matches part of the URL path as specified by its + # template. A variable template must not contain other variables. If a variable + # matches a single path segment, its template may be omitted, e.g. ``var`` + # is equivalent to ``var=*``. + # The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` + # contains any reserved character, such characters should be percent-encoded + # before the matching. + # If a variable contains exactly one path segment, such as `"`var`"` or + # `"`var=*`"`, when such a variable is expanded into a URL path on the client + # side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The + # server side does the reverse decoding. Such variables show up in the + # [Discovery + # Document](https://developers.google.com/discovery/v1/reference/apis) as + # ``var``. + # If a variable contains multiple path segments, such as `"`var=foo/*`"` + # or `"`var=**`"`, when such a variable is expanded into a URL path on the + # client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. + # The server side does the reverse decoding, except "%2F" and "%2f" are left + # unchanged. Such variables show up in the + # [Discovery + # Document](https://developers.google.com/discovery/v1/reference/apis) as + # ``+var``. + # ## Using gRPC API Service Configuration + # gRPC API Service Configuration (service config) is a configuration language + # for configuring a gRPC service to become a user-facing product. The + # service config is simply the YAML representation of the `google.api.Service` + # proto message. + # As an alternative to annotating your proto file, you can configure gRPC + # transcoding in your service config YAML files. You do this by specifying a + # `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same + # effect as the proto annotation. This can be particularly useful if you + # have a proto that is reused in multiple services. Note that any transcoding + # specified in the service config will override any matching transcoding + # configuration in the proto. + # Example: + # http: + # rules: + # # Selects a gRPC method and applies HttpRule to it. + # - selector: example.v1.Messaging.GetMessage + # get: /v1/messages/`message_id`/`sub.subfield` + # ## Special notes + # When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the + # proto to JSON conversion must follow the [proto3 + # specification](https://developers.google.com/protocol-buffers/docs/proto3#json) + # . + # While the single segment variable follows the semantics of + # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String + # Expansion, the multi segment variable **does not** follow RFC 6570 Section + # 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion + # does not expand special characters like `?` and `#`, which would lead + # to invalid URLs. As the result, gRPC Transcoding uses a custom encoding + # for multi segment variables. + # The path variables **must not** refer to any repeated or mapped field, + # because client libraries are not capable of handling such variable expansion. + # The path variables **must not** capture the leading "/" character. The reason + # is that the most common use case "`var`" does not capture the leading "/" + # character. For consistency, all path variables must share the same behavior. + # Repeated message fields must not be mapped to URL query parameters, because + # no client library can support such complicated mapping. + # If an API needs to use a JSON array for request or response body, it can map + # the request or response body to a repeated field. However, some gRPC + # Transcoding implementations may not support this feature. + class HttpRule + include Google::Apis::Core::Hashable + + # Additional HTTP bindings for the selector. Nested bindings must + # not contain an `additional_bindings` field themselves (that is, + # the nesting may only be one level deep). + # Corresponds to the JSON property `additionalBindings` + # @return [Array] + attr_accessor :additional_bindings + + # When this flag is set to true, HTTP requests will be allowed to invoke a + # half-duplex streaming method. + # Corresponds to the JSON property `allowHalfDuplex` + # @return [Boolean] + attr_accessor :allow_half_duplex + alias_method :allow_half_duplex?, :allow_half_duplex + + # The name of the request field whose value is mapped to the HTTP request + # body, or `*` for mapping all request fields not captured by the path + # pattern to the HTTP body, or omitted for not having any HTTP request body. + # NOTE: the referred field must be present at the top-level of the request + # message type. + # Corresponds to the JSON property `body` + # @return [String] + attr_accessor :body + + # A custom pattern is used for defining custom HTTP verb. + # Corresponds to the JSON property `custom` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::CustomHttpPattern] + attr_accessor :custom + + # Maps to HTTP DELETE. Used for deleting a resource. + # Corresponds to the JSON property `delete` + # @return [String] + attr_accessor :delete + + # Maps to HTTP GET. Used for listing and getting information about + # resources. + # Corresponds to the JSON property `get` + # @return [String] + attr_accessor :get + + # Maps to HTTP PATCH. Used for updating a resource. + # Corresponds to the JSON property `patch` + # @return [String] + attr_accessor :patch + + # Maps to HTTP POST. Used for creating a resource or performing an action. + # Corresponds to the JSON property `post` + # @return [String] + attr_accessor :post + + # Maps to HTTP PUT. Used for replacing a resource. + # Corresponds to the JSON property `put` + # @return [String] + attr_accessor :put + + # Optional. The name of the response field whose value is mapped to the HTTP + # response body. When omitted, the entire response message will be used + # as the HTTP response body. + # NOTE: The referred field must be present at the top-level of the response + # message type. + # Corresponds to the JSON property `responseBody` + # @return [String] + attr_accessor :response_body + + # Selects a method to which this rule applies. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @additional_bindings = args[:additional_bindings] if args.key?(:additional_bindings) + @allow_half_duplex = args[:allow_half_duplex] if args.key?(:allow_half_duplex) + @body = args[:body] if args.key?(:body) + @custom = args[:custom] if args.key?(:custom) + @delete = args[:delete] if args.key?(:delete) + @get = args[:get] if args.key?(:get) + @patch = args[:patch] if args.key?(:patch) + @post = args[:post] if args.key?(:post) + @put = args[:put] if args.key?(:put) + @response_body = args[:response_body] if args.key?(:response_body) + @selector = args[:selector] if args.key?(:selector) + end + end + + # Specifies a location to extract JWT from an API request. + class JwtLocation + include Google::Apis::Core::Hashable + + # Specifies HTTP header name to extract JWT token. + # Corresponds to the JSON property `header` + # @return [String] + attr_accessor :header + + # Specifies URL query parameter name to extract JWT token. + # Corresponds to the JSON property `query` + # @return [String] + attr_accessor :query + + # The value prefix. The value format is "value_prefix`token`" + # Only applies to "in" header type. Must be empty for "in" query type. + # If not empty, the header value has to match (case sensitive) this prefix. + # If not matched, JWT will not be extracted. If matched, JWT will be + # extracted after the prefix is removed. + # For example, for "Authorization: Bearer `JWT`", + # value_prefix="Bearer " with a space at the end. + # Corresponds to the JSON property `valuePrefix` + # @return [String] + attr_accessor :value_prefix + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @header = args[:header] if args.key?(:header) + @query = args[:query] if args.key?(:query) + @value_prefix = args[:value_prefix] if args.key?(:value_prefix) + end + end + + # A description of a label. + class LabelDescriptor + include Google::Apis::Core::Hashable + + # A human-readable description for the label. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The label key. + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # The type of data that can be assigned to the label. + # Corresponds to the JSON property `valueType` + # @return [String] + attr_accessor :value_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @key = args[:key] if args.key?(:key) + @value_type = args[:value_type] if args.key?(:value_type) + end + end + + # A description of a log type. Example in YAML format: + # - name: library.googleapis.com/activity_history + # description: The history of borrowing and returning library items. + # display_name: Activity + # labels: + # - key: /customer_id + # description: Identifier of a library customer + class LogDescriptor + include Google::Apis::Core::Hashable + + # A human-readable description of this log. This information appears in + # the documentation and can contain details. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The human-readable name for this log. This information appears on + # the user interface and should be concise. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The set of labels that are available to describe a specific log entry. + # Runtime requests that contain labels not specified here are + # considered invalid. + # Corresponds to the JSON property `labels` + # @return [Array] + attr_accessor :labels + + # The name of the log. It must be less than 512 characters long and can + # include the following characters: upper- and lower-case alphanumeric + # characters [A-Za-z0-9], and punctuation characters including + # slash, underscore, hyphen, period [/_-.]. + # 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) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + end + end + + # Logging configuration of the service. + # The following example shows how to configure logs to be sent to the + # producer and consumer projects. In the example, the `activity_history` + # log is sent to both the producer and consumer projects, whereas the + # `purchase_history` log is only sent to the producer project. + # monitored_resources: + # - type: library.googleapis.com/branch + # labels: + # - key: /city + # description: The city where the library branch is located in. + # - key: /name + # description: The name of the branch. + # logs: + # - name: activity_history + # labels: + # - key: /customer_id + # - name: purchase_history + # logging: + # producer_destinations: + # - monitored_resource: library.googleapis.com/branch + # logs: + # - activity_history + # - purchase_history + # consumer_destinations: + # - monitored_resource: library.googleapis.com/branch + # logs: + # - activity_history + class Logging + include Google::Apis::Core::Hashable + + # Logging configurations for sending logs to the consumer project. + # There can be multiple consumer destinations, each one must have a + # different monitored resource type. A log can be used in at most + # one consumer destination. + # Corresponds to the JSON property `consumerDestinations` + # @return [Array] + attr_accessor :consumer_destinations + + # Logging configurations for sending logs to the producer project. + # There can be multiple producer destinations, each one must have a + # different monitored resource type. A log can be used in at most + # one producer destination. + # Corresponds to the JSON property `producerDestinations` + # @return [Array] + attr_accessor :producer_destinations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @consumer_destinations = args[:consumer_destinations] if args.key?(:consumer_destinations) + @producer_destinations = args[:producer_destinations] if args.key?(:producer_destinations) + end + end + + # Configuration of a specific logging destination (the producer project + # or the consumer project). + class LoggingDestination + include Google::Apis::Core::Hashable + + # Names of the logs to be sent to this destination. Each name must + # be defined in the Service.logs section. If the log name is + # not a domain scoped name, it will be automatically prefixed with + # the service name followed by "/". + # Corresponds to the JSON property `logs` + # @return [Array] + attr_accessor :logs + + # The monitored resource type. The type must be defined in the + # Service.monitored_resources section. + # Corresponds to the JSON property `monitoredResource` + # @return [String] + attr_accessor :monitored_resource + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @logs = args[:logs] if args.key?(:logs) + @monitored_resource = args[:monitored_resource] if args.key?(:monitored_resource) + end + end + + # Method represents a method of an API interface. + class MethodProp + include Google::Apis::Core::Hashable + + # The simple name of this method. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Any metadata attached to the method. + # Corresponds to the JSON property `options` + # @return [Array] + attr_accessor :options + + # If true, the request is streamed. + # Corresponds to the JSON property `requestStreaming` + # @return [Boolean] + attr_accessor :request_streaming + alias_method :request_streaming?, :request_streaming + + # A URL of the input message type. + # Corresponds to the JSON property `requestTypeUrl` + # @return [String] + attr_accessor :request_type_url + + # If true, the response is streamed. + # Corresponds to the JSON property `responseStreaming` + # @return [Boolean] + attr_accessor :response_streaming + alias_method :response_streaming?, :response_streaming + + # The URL of the output message type. + # Corresponds to the JSON property `responseTypeUrl` + # @return [String] + attr_accessor :response_type_url + + # The source syntax of this method. + # Corresponds to the JSON property `syntax` + # @return [String] + attr_accessor :syntax + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @options = args[:options] if args.key?(:options) + @request_streaming = args[:request_streaming] if args.key?(:request_streaming) + @request_type_url = args[:request_type_url] if args.key?(:request_type_url) + @response_streaming = args[:response_streaming] if args.key?(:response_streaming) + @response_type_url = args[:response_type_url] if args.key?(:response_type_url) + @syntax = args[:syntax] if args.key?(:syntax) + end + end + + # Defines a metric type and its schema. Once a metric descriptor is created, + # deleting or altering it stops data collection and makes the metric type's + # existing data unusable. + class MetricDescriptor + include Google::Apis::Core::Hashable + + # A detailed description of the metric, which can be used in documentation. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # A concise name for the metric, which can be displayed in user interfaces. + # Use sentence case without an ending period, for example "Request count". + # This field is optional but it is recommended to be set for any metrics + # associated with user-visible concepts, such as Quota. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The set of labels that can be used to describe a specific + # instance of this metric type. For example, the + # `appengine.googleapis.com/http/server/response_latencies` metric + # type has a label for the HTTP response code, `response_code`, so + # you can look at latencies for successful responses or just + # for responses that failed. + # Corresponds to the JSON property `labels` + # @return [Array] + attr_accessor :labels + + # Optional. The launch stage of the metric definition. + # Corresponds to the JSON property `launchStage` + # @return [String] + attr_accessor :launch_stage + + # Additional annotations that can be used to guide the usage of a metric. + # Corresponds to the JSON property `metadata` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::MetricDescriptorMetadata] + attr_accessor :metadata + + # Whether the metric records instantaneous values, changes to a value, etc. + # Some combinations of `metric_kind` and `value_type` might not be supported. + # Corresponds to the JSON property `metricKind` + # @return [String] + attr_accessor :metric_kind + + # Read-only. If present, then a time + # series, which is identified partially by + # a metric type and a MonitoredResourceDescriptor, that is associated + # with this metric type can only be associated with one of the monitored + # resource types listed here. + # Corresponds to the JSON property `monitoredResourceTypes` + # @return [Array] + attr_accessor :monitored_resource_types + + # The resource name of the metric descriptor. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The metric type, including its DNS name prefix. The type is not + # URL-encoded. All user-defined metric types have the DNS name + # `custom.googleapis.com` or `external.googleapis.com`. Metric types should + # use a natural hierarchical grouping. For example: + # "custom.googleapis.com/invoice/paid/amount" + # "external.googleapis.com/prometheus/up" + # "appengine.googleapis.com/http/server/response_latencies" + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # The units in which the metric value is reported. It is only applicable + # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` + # defines the representation of the stored metric values. + # Different systems may scale the values to be more easily displayed (so a + # value of `0.02KBy` _might_ be displayed as `20By`, and a value of + # `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is + # `KBy`, then the value of the metric is always in thousands of bytes, no + # matter how it may be displayed.. + # If you want a custom metric to record the exact number of CPU-seconds used + # by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is + # `s`CPU`` (or equivalently `1s`CPU`` or just `s`). If the job uses 12,005 + # CPU-seconds, then the value is written as `12005`. + # Alternatively, if you want a custom metric to record data in a more + # granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is + # `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), + # or use `Kis`CPU`` and write `11.723` (which is `12005/1024`). + # The supported units are a subset of [The Unified Code for Units of + # Measure](http://unitsofmeasure.org/ucum.html) standard: + # **Basic units (UNIT)** + # * `bit` bit + # * `By` byte + # * `s` second + # * `min` minute + # * `h` hour + # * `d` day + # **Prefixes (PREFIX)** + # * `k` kilo (10^3) + # * `M` mega (10^6) + # * `G` giga (10^9) + # * `T` tera (10^12) + # * `P` peta (10^15) + # * `E` exa (10^18) + # * `Z` zetta (10^21) + # * `Y` yotta (10^24) + # * `m` milli (10^-3) + # * `u` micro (10^-6) + # * `n` nano (10^-9) + # * `p` pico (10^-12) + # * `f` femto (10^-15) + # * `a` atto (10^-18) + # * `z` zepto (10^-21) + # * `y` yocto (10^-24) + # * `Ki` kibi (2^10) + # * `Mi` mebi (2^20) + # * `Gi` gibi (2^30) + # * `Ti` tebi (2^40) + # * `Pi` pebi (2^50) + # **Grammar** + # The grammar also includes these connectors: + # * `/` division or ratio (as an infix operator). For examples, + # `kBy/`email`` or `MiBy/10ms` (although you should almost never + # have `/s` in a metric `unit`; rates should always be computed at + # query time from the underlying cumulative or delta value). + # * `.` multiplication or composition (as an infix operator). For + # examples, `GBy.d` or `k`watt`.h`. + # The grammar for a unit is as follows: + # Expression = Component ` "." Component ` ` "/" Component ` ; + # Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] + # | Annotation + # | "1" + # ; + # Annotation = "`" NAME "`" ; + # Notes: + # * `Annotation` is just a comment if it follows a `UNIT`. If the annotation + # is used alone, then the unit is equivalent to `1`. For examples, + # ``request`/s == 1/s`, `By`transmitted`/s == By/s`. + # * `NAME` is a sequence of non-blank printable ASCII characters not + # containing ``` or ```. + # * `1` represents a unitary [dimensionless + # unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such + # as in `1/s`. It is typically used when none of the basic units are + # appropriate. For example, "new users per day" can be represented as + # `1/d` or ``new-users`/d` (and a metric value `5` would mean "5 new + # users). Alternatively, "thousands of page views per day" would be + # represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric + # value of `5.3` would mean "5300 page views per day"). + # * `%` represents dimensionless value of 1/100, and annotates values giving + # a percentage (so the metric values are typically in the range of 0..100, + # and a metric value `3` means "3 percent"). + # * `10^2.%` indicates a metric contains a ratio, typically in the range + # 0..1, that will be multiplied by 100 and displayed as a percentage + # (so a metric value `0.03` means "3 percent"). + # Corresponds to the JSON property `unit` + # @return [String] + attr_accessor :unit + + # Whether the measurement is an integer, a floating-point number, etc. + # Some combinations of `metric_kind` and `value_type` might not be supported. + # Corresponds to the JSON property `valueType` + # @return [String] + attr_accessor :value_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @labels = args[:labels] if args.key?(:labels) + @launch_stage = args[:launch_stage] if args.key?(:launch_stage) + @metadata = args[:metadata] if args.key?(:metadata) + @metric_kind = args[:metric_kind] if args.key?(:metric_kind) + @monitored_resource_types = args[:monitored_resource_types] if args.key?(:monitored_resource_types) + @name = args[:name] if args.key?(:name) + @type = args[:type] if args.key?(:type) + @unit = args[:unit] if args.key?(:unit) + @value_type = args[:value_type] if args.key?(:value_type) + end + end + + # Additional annotations that can be used to guide the usage of a metric. + class MetricDescriptorMetadata + include Google::Apis::Core::Hashable + + # The delay of data points caused by ingestion. Data points older than this + # age are guaranteed to be ingested and available to be read, excluding + # data loss due to errors. + # Corresponds to the JSON property `ingestDelay` + # @return [String] + attr_accessor :ingest_delay + + # Deprecated. Must use the MetricDescriptor.launch_stage instead. + # Corresponds to the JSON property `launchStage` + # @return [String] + attr_accessor :launch_stage + + # The sampling period of metric data points. For metrics which are written + # periodically, consecutive data points are stored at this time interval, + # excluding data loss due to errors. Metrics with a higher granularity have + # a smaller sampling period. + # Corresponds to the JSON property `samplePeriod` + # @return [String] + attr_accessor :sample_period + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ingest_delay = args[:ingest_delay] if args.key?(:ingest_delay) + @launch_stage = args[:launch_stage] if args.key?(:launch_stage) + @sample_period = args[:sample_period] if args.key?(:sample_period) + end + end + + # Bind API methods to metrics. Binding a method to a metric causes that + # metric's configured quota behaviors to apply to the method call. + class MetricRule + include Google::Apis::Core::Hashable + + # Metrics to update when the selected methods are called, and the associated + # cost applied to each metric. + # The key of the map is the metric name, and the values are the amount + # increased for the metric against which the quota limits are defined. + # The value must not be negative. + # Corresponds to the JSON property `metricCosts` + # @return [Hash] + attr_accessor :metric_costs + + # Selects the methods to which this rule applies. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @metric_costs = args[:metric_costs] if args.key?(:metric_costs) + @selector = args[:selector] if args.key?(:selector) + end + end + + # Declares an API Interface to be included in this interface. The including + # interface must redeclare all the methods from the included interface, but + # documentation and options are inherited as follows: + # - If after comment and whitespace stripping, the documentation + # string of the redeclared method is empty, it will be inherited + # from the original method. + # - Each annotation belonging to the service config (http, + # visibility) which is not set in the redeclared method will be + # inherited. + # - If an http annotation is inherited, the path pattern will be + # modified as follows. Any version prefix will be replaced by the + # version of the including interface plus the root path if + # specified. + # Example of a simple mixin: + # package google.acl.v1; + # service AccessControl ` + # // Get the underlying ACL object. + # rpc GetAcl(GetAclRequest) returns (Acl) ` + # option (google.api.http).get = "/v1/`resource=**`:getAcl"; + # ` + # ` + # package google.storage.v2; + # service Storage ` + # // rpc GetAcl(GetAclRequest) returns (Acl); + # // Get a data record. + # rpc GetData(GetDataRequest) returns (Data) ` + # option (google.api.http).get = "/v2/`resource=**`"; + # ` + # ` + # Example of a mixin configuration: + # apis: + # - name: google.storage.v2.Storage + # mixins: + # - name: google.acl.v1.AccessControl + # The mixin construct implies that all methods in `AccessControl` are + # also declared with same name and request/response types in + # `Storage`. A documentation generator or annotation processor will + # see the effective `Storage.GetAcl` method after inherting + # documentation and annotations as follows: + # service Storage ` + # // Get the underlying ACL object. + # rpc GetAcl(GetAclRequest) returns (Acl) ` + # option (google.api.http).get = "/v2/`resource=**`:getAcl"; + # ` + # ... + # ` + # Note how the version in the path pattern changed from `v1` to `v2`. + # If the `root` field in the mixin is specified, it should be a + # relative path under which inherited HTTP paths are placed. Example: + # apis: + # - name: google.storage.v2.Storage + # mixins: + # - name: google.acl.v1.AccessControl + # root: acls + # This implies the following inherited HTTP annotation: + # service Storage ` + # // Get the underlying ACL object. + # rpc GetAcl(GetAclRequest) returns (Acl) ` + # option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; + # ` + # ... + # ` + class Mixin + include Google::Apis::Core::Hashable + + # The fully qualified name of the interface which is included. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # If non-empty specifies a path under which inherited HTTP paths + # are rooted. + # Corresponds to the JSON property `root` + # @return [String] + attr_accessor :root + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @root = args[:root] if args.key?(:root) + end + end + + # An object that describes the schema of a MonitoredResource object using a + # type name and a set of labels. For example, the monitored resource + # descriptor for Google Compute Engine VM instances has a type of + # `"gce_instance"` and specifies the use of the labels `"instance_id"` and + # `"zone"` to identify particular VM instances. + # Different APIs can support different monitored resource types. APIs generally + # provide a `list` method that returns the monitored resource descriptors used + # by the API. + class MonitoredResourceDescriptor + include Google::Apis::Core::Hashable + + # Optional. A detailed description of the monitored resource type that might + # be used in documentation. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Optional. A concise name for the monitored resource type that might be + # displayed in user interfaces. It should be a Title Cased Noun Phrase, + # without any article or other determiners. For example, + # `"Google Cloud SQL Database"`. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Required. A set of labels used to describe instances of this monitored + # resource type. For example, an individual Google Cloud SQL database is + # identified by values for the labels `"database_id"` and `"zone"`. + # Corresponds to the JSON property `labels` + # @return [Array] + attr_accessor :labels + + # Optional. The launch stage of the monitored resource definition. + # Corresponds to the JSON property `launchStage` + # @return [String] + attr_accessor :launch_stage + + # Optional. The resource name of the monitored resource descriptor: + # `"projects/`project_id`/monitoredResourceDescriptors/`type`"` where + # `type` is the value of the `type` field in this object and + # `project_id` is a project ID that provides API-specific context for + # accessing the type. APIs that do not use project information can use the + # resource name format `"monitoredResourceDescriptors/`type`"`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Required. The monitored resource type. For example, the type + # `"cloudsql_database"` represents databases in Google Cloud SQL. + # The maximum length of this value is 256 characters. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @labels = args[:labels] if args.key?(:labels) + @launch_stage = args[:launch_stage] if args.key?(:launch_stage) + @name = args[:name] if args.key?(:name) + @type = args[:type] if args.key?(:type) + end + end + + # Monitoring configuration of the service. + # The example below shows how to configure monitored resources and metrics + # for monitoring. In the example, a monitored resource and two metrics are + # defined. The `library.googleapis.com/book/returned_count` metric is sent + # to both producer and consumer projects, whereas the + # `library.googleapis.com/book/overdue_count` metric is only sent to the + # consumer project. + # monitored_resources: + # - type: library.googleapis.com/branch + # labels: + # - key: /city + # description: The city where the library branch is located in. + # - key: /name + # description: The name of the branch. + # metrics: + # - name: library.googleapis.com/book/returned_count + # metric_kind: DELTA + # value_type: INT64 + # labels: + # - key: /customer_id + # - name: library.googleapis.com/book/overdue_count + # metric_kind: GAUGE + # value_type: INT64 + # labels: + # - key: /customer_id + # monitoring: + # producer_destinations: + # - monitored_resource: library.googleapis.com/branch + # metrics: + # - library.googleapis.com/book/returned_count + # consumer_destinations: + # - monitored_resource: library.googleapis.com/branch + # metrics: + # - library.googleapis.com/book/returned_count + # - library.googleapis.com/book/overdue_count + class Monitoring + include Google::Apis::Core::Hashable + + # Monitoring configurations for sending metrics to the consumer project. + # There can be multiple consumer destinations. A monitored resouce type may + # appear in multiple monitoring destinations if different aggregations are + # needed for different sets of metrics associated with that monitored + # resource type. A monitored resource and metric pair may only be used once + # in the Monitoring configuration. + # Corresponds to the JSON property `consumerDestinations` + # @return [Array] + attr_accessor :consumer_destinations + + # Monitoring configurations for sending metrics to the producer project. + # There can be multiple producer destinations. A monitored resouce type may + # appear in multiple monitoring destinations if different aggregations are + # needed for different sets of metrics associated with that monitored + # resource type. A monitored resource and metric pair may only be used once + # in the Monitoring configuration. + # Corresponds to the JSON property `producerDestinations` + # @return [Array] + attr_accessor :producer_destinations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @consumer_destinations = args[:consumer_destinations] if args.key?(:consumer_destinations) + @producer_destinations = args[:producer_destinations] if args.key?(:producer_destinations) + end + end + + # Configuration of a specific monitoring destination (the producer project + # or the consumer project). + class MonitoringDestination + include Google::Apis::Core::Hashable + + # Types of the metrics to report to this monitoring destination. + # Each type must be defined in Service.metrics section. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # The monitored resource type. The type must be defined in + # Service.monitored_resources section. + # Corresponds to the JSON property `monitoredResource` + # @return [String] + attr_accessor :monitored_resource + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @metrics = args[:metrics] if args.key?(:metrics) + @monitored_resource = args[:monitored_resource] if args.key?(:monitored_resource) + end + end + + # OAuth scopes are a way to define data and permissions on data. For example, + # there are scopes defined for "Read-only access to Google Calendar" and + # "Access to Cloud Platform". Users can consent to a scope for an application, + # giving it permission to access that data on their behalf. + # OAuth scope specifications should be fairly coarse grained; a user will need + # to see and understand the text description of what your scope means. + # In most cases: use one or at most two OAuth scopes for an entire family of + # products. If your product has multiple APIs, you should probably be sharing + # the OAuth scope across all of those APIs. + # When you need finer grained OAuth consent screens: talk with your product + # management about how developers will use them in practice. + # Please note that even though each of the canonical scopes is enough for a + # request to be accepted and passed to the backend, a request can still fail + # due to the backend requiring additional scopes or permissions. + class OAuthRequirements + include Google::Apis::Core::Hashable + + # The list of publicly documented OAuth scopes that are allowed access. An + # OAuth token containing any of these scopes will be accepted. + # Example: + # canonical_scopes: https://www.googleapis.com/auth/calendar, + # https://www.googleapis.com/auth/calendar.read + # Corresponds to the JSON property `canonicalScopes` + # @return [String] + attr_accessor :canonical_scopes + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @canonical_scopes = args[:canonical_scopes] if args.key?(:canonical_scopes) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + class Operation + 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::ServiceconsumermanagementV1beta1::Status] + 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] + 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] + 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 + + # A protocol buffer option, which can be attached to a message, field, + # enumeration, etc. + class Option + include Google::Apis::Core::Hashable + + # The option's name. For protobuf built-in options (options defined in + # descriptor.proto), this is the short name. For example, `"map_entry"`. + # For custom options, it should be the fully-qualified name. For example, + # `"google.api.http"`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The option's value packed in an Any message. If the value is a primitive, + # the corresponding wrapper type defined in google/protobuf/wrappers.proto + # should be used. If the value is an enum, it should be stored as an int32 + # value using the google.protobuf.Int32Value type. + # Corresponds to the JSON property `value` + # @return [Hash] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @value = args[:value] if args.key?(:value) + end + end + + # Represents a documentation page. A page can contain subpages to represent + # nested documentation set structure. + class Page + include Google::Apis::Core::Hashable + + # The Markdown content of the page. You can use (== include `path` + # ==) to include content from a Markdown file. + # Corresponds to the JSON property `content` + # @return [String] + attr_accessor :content + + # The name of the page. It will be used as an identity of the page to + # generate URI of the page, text of the link to this page in navigation, + # etc. The full page name (start from the root page name to this page + # concatenated with `.`) can be used as reference to the page in your + # documentation. For example: + #
    pages:
    +        # - name: Tutorial
    +        # content: (== include tutorial.md ==)
    +        # subpages:
    +        # - name: Java
    +        # content: (== include tutorial_java.md ==)
    +        # 
    + # You can reference `Java` page using Markdown reference link syntax: + # `Java`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Subpages of this page. The order of subpages specified here will be + # honored in the generated docset. + # Corresponds to the JSON property `subpages` + # @return [Array] + attr_accessor :subpages + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content = args[:content] if args.key?(:content) + @name = args[:name] if args.key?(:name) + @subpages = args[:subpages] if args.key?(:subpages) + end + end + + # Quota configuration helps to achieve fairness and budgeting in service + # usage. + # The metric based quota configuration works this way: + # - The service configuration defines a set of metrics. + # - For API calls, the quota.metric_rules maps methods to metrics with + # corresponding costs. + # - The quota.limits defines limits on the metrics, which will be used for + # quota checks at runtime. + # An example quota configuration in yaml format: + # quota: + # limits: + # - name: apiWriteQpsPerProject + # metric: library.googleapis.com/write_calls + # unit: "1/min/`project`" # rate limit for consumer projects + # values: + # STANDARD: 10000 + # # The metric rules bind all methods to the read_calls metric, + # # except for the UpdateBook and DeleteBook methods. These two methods + # # are mapped to the write_calls metric, with the UpdateBook method + # # consuming at twice rate as the DeleteBook method. + # metric_rules: + # - selector: "*" + # metric_costs: + # library.googleapis.com/read_calls: 1 + # - selector: google.example.library.v1.LibraryService.UpdateBook + # metric_costs: + # library.googleapis.com/write_calls: 2 + # - selector: google.example.library.v1.LibraryService.DeleteBook + # metric_costs: + # library.googleapis.com/write_calls: 1 + # Corresponding Metric definition: + # metrics: + # - name: library.googleapis.com/read_calls + # display_name: Read requests + # metric_kind: DELTA + # value_type: INT64 + # - name: library.googleapis.com/write_calls + # display_name: Write requests + # metric_kind: DELTA + # value_type: INT64 + class Quota + include Google::Apis::Core::Hashable + + # List of `QuotaLimit` definitions for the service. + # Corresponds to the JSON property `limits` + # @return [Array] + attr_accessor :limits + + # List of `MetricRule` definitions, each one mapping a selected method to one + # or more metrics. + # Corresponds to the JSON property `metricRules` + # @return [Array] + attr_accessor :metric_rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @limits = args[:limits] if args.key?(:limits) + @metric_rules = args[:metric_rules] if args.key?(:metric_rules) + end + end + + # `QuotaLimit` defines a specific limit that applies over a specified duration + # for a limit type. There can be at most one limit for a duration and limit + # type combination defined within a `QuotaGroup`. + class QuotaLimit + include Google::Apis::Core::Hashable + + # Default number of tokens that can be consumed during the specified + # duration. This is the number of tokens assigned when a client + # application developer activates the service for his/her project. + # Specifying a value of 0 will block all requests. This can be used if you + # are provisioning quota to selected consumers and blocking others. + # Similarly, a value of -1 will indicate an unlimited quota. No other + # negative values are allowed. + # Used by group-based quotas only. + # Corresponds to the JSON property `defaultLimit` + # @return [Fixnum] + attr_accessor :default_limit + + # Optional. User-visible, extended description for this quota limit. + # Should be used only when more context is needed to understand this limit + # than provided by the limit's display name (see: `display_name`). + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # User-visible display name for this limit. + # Optional. If not set, the UI will provide a default display name based on + # the quota configuration. This field can be used to override the default + # display name generated from the configuration. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Duration of this limit in textual notation. Must be "100s" or "1d". + # Used by group-based quotas only. + # Corresponds to the JSON property `duration` + # @return [String] + attr_accessor :duration + + # Free tier value displayed in the Developers Console for this limit. + # The free tier is the number of tokens that will be subtracted from the + # billed amount when billing is enabled. + # This field can only be set on a limit with duration "1d", in a billable + # group; it is invalid on any other limit. If this field is not set, it + # defaults to 0, indicating that there is no free tier for this service. + # Used by group-based quotas only. + # Corresponds to the JSON property `freeTier` + # @return [Fixnum] + attr_accessor :free_tier + + # Maximum number of tokens that can be consumed during the specified + # duration. Client application developers can override the default limit up + # to this maximum. If specified, this value cannot be set to a value less + # than the default limit. If not specified, it is set to the default limit. + # To allow clients to apply overrides with no upper bound, set this to -1, + # indicating unlimited maximum quota. + # Used by group-based quotas only. + # Corresponds to the JSON property `maxLimit` + # @return [Fixnum] + attr_accessor :max_limit + + # The name of the metric this quota limit applies to. The quota limits with + # the same metric will be checked together during runtime. The metric must be + # defined within the service config. + # Corresponds to the JSON property `metric` + # @return [String] + attr_accessor :metric + + # Name of the quota limit. + # The name must be provided, and it must be unique within the service. The + # name can only include alphanumeric characters as well as '-'. + # The maximum length of the limit name is 64 characters. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Specify the unit of the quota limit. It uses the same syntax as + # Metric.unit. The supported unit kinds are determined by the quota + # backend system. + # Here are some examples: + # * "1/min/`project`" for quota per minute per project. + # Note: the order of unit components is insignificant. + # The "1" at the beginning is required to follow the metric unit syntax. + # Corresponds to the JSON property `unit` + # @return [String] + attr_accessor :unit + + # Tiered limit values. You must specify this as a key:value pair, with an + # integer value that is the maximum number of requests allowed for the + # specified unit. Currently only STANDARD is supported. + # Corresponds to the JSON property `values` + # @return [Hash] + attr_accessor :values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @default_limit = args[:default_limit] if args.key?(:default_limit) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @duration = args[:duration] if args.key?(:duration) + @free_tier = args[:free_tier] if args.key?(:free_tier) + @max_limit = args[:max_limit] if args.key?(:max_limit) + @metric = args[:metric] if args.key?(:metric) + @name = args[:name] if args.key?(:name) + @unit = args[:unit] if args.key?(:unit) + @values = args[:values] if args.key?(:values) + end + end + + # `Service` is the root object of Google service configuration schema. It + # describes basic information about a service, such as the name and the + # title, and delegates other aspects to sub-sections. Each sub-section is + # either a proto message or a repeated proto message that configures a + # specific aspect, such as auth. See each proto message definition for details. + # Example: + # type: google.api.Service + # config_version: 3 + # name: calendar.googleapis.com + # title: Google Calendar API + # apis: + # - name: google.calendar.v3.Calendar + # authentication: + # providers: + # - id: google_calendar_auth + # jwks_uri: https://www.googleapis.com/oauth2/v1/certs + # issuer: https://securetoken.google.com + # rules: + # - selector: "*" + # requirements: + # provider_id: google_calendar_auth + class Service + include Google::Apis::Core::Hashable + + # A list of API interfaces exported by this service. Only the `name` field + # of the google.protobuf.Api needs to be provided by the configuration + # author, as the remaining fields will be derived from the IDL during the + # normalization process. It is an error to specify an API interface here + # which cannot be resolved against the associated IDL files. + # Corresponds to the JSON property `apis` + # @return [Array] + attr_accessor :apis + + # `Authentication` defines the authentication configuration for an API. + # Example for an API targeted for external use: + # name: calendar.googleapis.com + # authentication: + # providers: + # - id: google_calendar_auth + # jwks_uri: https://www.googleapis.com/oauth2/v1/certs + # issuer: https://securetoken.google.com + # rules: + # - selector: "*" + # requirements: + # provider_id: google_calendar_auth + # Corresponds to the JSON property `authentication` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::Authentication] + attr_accessor :authentication + + # `Backend` defines the backend configuration for a service. + # Corresponds to the JSON property `backend` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::Backend] + attr_accessor :backend + + # Billing related configuration of the service. + # The following example shows how to configure monitored resources and metrics + # for billing: + # monitored_resources: + # - type: library.googleapis.com/branch + # labels: + # - key: /city + # description: The city where the library branch is located in. + # - key: /name + # description: The name of the branch. + # metrics: + # - name: library.googleapis.com/book/borrowed_count + # metric_kind: DELTA + # value_type: INT64 + # billing: + # consumer_destinations: + # - monitored_resource: library.googleapis.com/branch + # metrics: + # - library.googleapis.com/book/borrowed_count + # Corresponds to the JSON property `billing` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::Billing] + attr_accessor :billing + + # The semantic version of the service configuration. The config version + # affects the interpretation of the service configuration. For example, + # certain features are enabled by default for certain config versions. + # The latest config version is `3`. + # Corresponds to the JSON property `configVersion` + # @return [Fixnum] + attr_accessor :config_version + + # `Context` defines which contexts an API requests. + # Example: + # context: + # rules: + # - selector: "*" + # requested: + # - google.rpc.context.ProjectContext + # - google.rpc.context.OriginContext + # The above specifies that all methods in the API request + # `google.rpc.context.ProjectContext` and + # `google.rpc.context.OriginContext`. + # Available context types are defined in package + # `google.rpc.context`. + # This also provides mechanism to whitelist any protobuf message extension that + # can be sent in grpc metadata using “x-goog-ext--bin” and + # “x-goog-ext--jspb” format. For example, list any service + # specific protobuf types that can appear in grpc metadata as follows in your + # yaml file: + # Example: + # context: + # rules: + # - selector: "google.example.library.v1.LibraryService.CreateBook" + # allowed_request_extensions: + # - google.foo.v1.NewExtension + # allowed_response_extensions: + # - google.foo.v1.NewExtension + # You can also specify extension ID instead of fully qualified extension name + # here. + # Corresponds to the JSON property `context` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::Context] + attr_accessor :context + + # Selects and configures the service controller used by the service. The + # service controller handles features like abuse, quota, billing, logging, + # monitoring, etc. + # Corresponds to the JSON property `control` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::Control] + attr_accessor :control + + # Customize service error responses. For example, list any service + # specific protobuf types that can appear in error detail lists of + # error responses. + # Example: + # custom_error: + # types: + # - google.foo.v1.CustomError + # - google.foo.v1.AnotherError + # Corresponds to the JSON property `customError` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::CustomError] + attr_accessor :custom_error + + # `Documentation` provides the information for describing a service. + # Example: + #
    documentation:
    +        # summary: >
    +        # The Google Calendar API gives access
    +        # to most calendar features.
    +        # pages:
    +        # - name: Overview
    +        # content: (== include google/foo/overview.md ==)
    +        # - name: Tutorial
    +        # content: (== include google/foo/tutorial.md ==)
    +        # subpages;
    +        # - name: Java
    +        # content: (== include google/foo/tutorial_java.md ==)
    +        # rules:
    +        # - selector: google.calendar.Calendar.Get
    +        # description: >
    +        # ...
    +        # - selector: google.calendar.Calendar.Put
    +        # description: >
    +        # ...
    +        # 
    + # Documentation is provided in markdown syntax. In addition to + # standard markdown features, definition lists, tables and fenced + # code blocks are supported. Section headers can be provided and are + # interpreted relative to the section nesting of the context where + # a documentation fragment is embedded. + # Documentation from the IDL is merged with documentation defined + # via the config at normalization time, where documentation provided + # by config rules overrides IDL provided. + # A number of constructs specific to the API platform are supported + # in documentation text. + # In order to reference a proto element, the following + # notation can be used: + #
    [fully.qualified.proto.name][]
    + # To override the display text used for the link, this can be used: + #
    [display text][fully.qualified.proto.name]
    + # Text can be excluded from doc using the following notation: + #
    (-- internal comment --)
    + # A few directives are available in documentation. Note that + # directives must appear on a single line to be properly + # identified. The `include` directive includes a markdown file from + # an external source: + #
    (== include path/to/file ==)
    + # The `resource_for` directive marks a message to be the resource of + # a collection in REST view. If it is not specified, tools attempt + # to infer the resource from the operations in a collection: + #
    (== resource_for v1.shelves.books ==)
    + # The directive `suppress_warning` does not directly affect documentation + # and is documented together with service config validation. + # Corresponds to the JSON property `documentation` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::Documentation] + attr_accessor :documentation + + # Configuration for network endpoints. If this is empty, then an endpoint + # with the same name as the service is automatically generated to service all + # defined APIs. + # Corresponds to the JSON property `endpoints` + # @return [Array] + attr_accessor :endpoints + + # A list of all enum types included in this API service. Enums + # referenced directly or indirectly by the `apis` are automatically + # included. Enums which are not referenced but shall be included + # should be listed here by name. Example: + # enums: + # - name: google.someapi.v1.SomeEnum + # Corresponds to the JSON property `enums` + # @return [Array] + attr_accessor :enums + + # Defines the HTTP configuration for an API service. It contains a list of + # HttpRule, each specifying the mapping of an RPC method + # to one or more HTTP REST API methods. + # Corresponds to the JSON property `http` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::Http] + attr_accessor :http + + # A unique ID for a specific instance of this message, typically assigned + # by the client for tracking purpose. Must be no longer than 63 characters + # and only lower case letters, digits, '.', '_' and '-' are allowed. If + # empty, the server may choose to generate one instead. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Logging configuration of the service. + # The following example shows how to configure logs to be sent to the + # producer and consumer projects. In the example, the `activity_history` + # log is sent to both the producer and consumer projects, whereas the + # `purchase_history` log is only sent to the producer project. + # monitored_resources: + # - type: library.googleapis.com/branch + # labels: + # - key: /city + # description: The city where the library branch is located in. + # - key: /name + # description: The name of the branch. + # logs: + # - name: activity_history + # labels: + # - key: /customer_id + # - name: purchase_history + # logging: + # producer_destinations: + # - monitored_resource: library.googleapis.com/branch + # logs: + # - activity_history + # - purchase_history + # consumer_destinations: + # - monitored_resource: library.googleapis.com/branch + # logs: + # - activity_history + # Corresponds to the JSON property `logging` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::Logging] + attr_accessor :logging + + # Defines the logs used by this service. + # Corresponds to the JSON property `logs` + # @return [Array] + attr_accessor :logs + + # Defines the metrics used by this service. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Defines the monitored resources used by this service. This is required + # by the Service.monitoring and Service.logging configurations. + # Corresponds to the JSON property `monitoredResources` + # @return [Array] + attr_accessor :monitored_resources + + # Monitoring configuration of the service. + # The example below shows how to configure monitored resources and metrics + # for monitoring. In the example, a monitored resource and two metrics are + # defined. The `library.googleapis.com/book/returned_count` metric is sent + # to both producer and consumer projects, whereas the + # `library.googleapis.com/book/overdue_count` metric is only sent to the + # consumer project. + # monitored_resources: + # - type: library.googleapis.com/branch + # labels: + # - key: /city + # description: The city where the library branch is located in. + # - key: /name + # description: The name of the branch. + # metrics: + # - name: library.googleapis.com/book/returned_count + # metric_kind: DELTA + # value_type: INT64 + # labels: + # - key: /customer_id + # - name: library.googleapis.com/book/overdue_count + # metric_kind: GAUGE + # value_type: INT64 + # labels: + # - key: /customer_id + # monitoring: + # producer_destinations: + # - monitored_resource: library.googleapis.com/branch + # metrics: + # - library.googleapis.com/book/returned_count + # consumer_destinations: + # - monitored_resource: library.googleapis.com/branch + # metrics: + # - library.googleapis.com/book/returned_count + # - library.googleapis.com/book/overdue_count + # Corresponds to the JSON property `monitoring` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::Monitoring] + attr_accessor :monitoring + + # The service name, which is a DNS-like logical identifier for the + # service, such as `calendar.googleapis.com`. The service name + # typically goes through DNS verification to make sure the owner + # of the service also owns the DNS name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The Google project that owns this service. + # Corresponds to the JSON property `producerProjectId` + # @return [String] + attr_accessor :producer_project_id + + # Quota configuration helps to achieve fairness and budgeting in service + # usage. + # The metric based quota configuration works this way: + # - The service configuration defines a set of metrics. + # - For API calls, the quota.metric_rules maps methods to metrics with + # corresponding costs. + # - The quota.limits defines limits on the metrics, which will be used for + # quota checks at runtime. + # An example quota configuration in yaml format: + # quota: + # limits: + # - name: apiWriteQpsPerProject + # metric: library.googleapis.com/write_calls + # unit: "1/min/`project`" # rate limit for consumer projects + # values: + # STANDARD: 10000 + # # The metric rules bind all methods to the read_calls metric, + # # except for the UpdateBook and DeleteBook methods. These two methods + # # are mapped to the write_calls metric, with the UpdateBook method + # # consuming at twice rate as the DeleteBook method. + # metric_rules: + # - selector: "*" + # metric_costs: + # library.googleapis.com/read_calls: 1 + # - selector: google.example.library.v1.LibraryService.UpdateBook + # metric_costs: + # library.googleapis.com/write_calls: 2 + # - selector: google.example.library.v1.LibraryService.DeleteBook + # metric_costs: + # library.googleapis.com/write_calls: 1 + # Corresponding Metric definition: + # metrics: + # - name: library.googleapis.com/read_calls + # display_name: Read requests + # metric_kind: DELTA + # value_type: INT64 + # - name: library.googleapis.com/write_calls + # display_name: Write requests + # metric_kind: DELTA + # value_type: INT64 + # Corresponds to the JSON property `quota` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::Quota] + attr_accessor :quota + + # Source information used to create a Service Config + # Corresponds to the JSON property `sourceInfo` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::SourceInfo] + attr_accessor :source_info + + # ### System parameter configuration + # A system parameter is a special kind of parameter defined by the API + # system, not by an individual API. It is typically mapped to an HTTP header + # and/or a URL query parameter. This configuration specifies which methods + # change the names of the system parameters. + # Corresponds to the JSON property `systemParameters` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::SystemParameters] + attr_accessor :system_parameters + + # A list of all proto message types included in this API service. + # It serves similar purpose as [google.api.Service.types], except that + # these types are not needed by user-defined APIs. Therefore, they will not + # show up in the generated discovery doc. This field should only be used + # to define system APIs in ESF. + # Corresponds to the JSON property `systemTypes` + # @return [Array] + attr_accessor :system_types + + # The product title for this service. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # A list of all proto message types included in this API service. + # Types referenced directly or indirectly by the `apis` are + # automatically included. Messages which are not referenced but + # shall be included, such as types used by the `google.protobuf.Any` type, + # should be listed here by name. Example: + # types: + # - name: google.protobuf.Int32 + # Corresponds to the JSON property `types` + # @return [Array] + attr_accessor :types + + # Configuration controlling usage of a service. + # Corresponds to the JSON property `usage` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::Usage] + attr_accessor :usage + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @apis = args[:apis] if args.key?(:apis) + @authentication = args[:authentication] if args.key?(:authentication) + @backend = args[:backend] if args.key?(:backend) + @billing = args[:billing] if args.key?(:billing) + @config_version = args[:config_version] if args.key?(:config_version) + @context = args[:context] if args.key?(:context) + @control = args[:control] if args.key?(:control) + @custom_error = args[:custom_error] if args.key?(:custom_error) + @documentation = args[:documentation] if args.key?(:documentation) + @endpoints = args[:endpoints] if args.key?(:endpoints) + @enums = args[:enums] if args.key?(:enums) + @http = args[:http] if args.key?(:http) + @id = args[:id] if args.key?(:id) + @logging = args[:logging] if args.key?(:logging) + @logs = args[:logs] if args.key?(:logs) + @metrics = args[:metrics] if args.key?(:metrics) + @monitored_resources = args[:monitored_resources] if args.key?(:monitored_resources) + @monitoring = args[:monitoring] if args.key?(:monitoring) + @name = args[:name] if args.key?(:name) + @producer_project_id = args[:producer_project_id] if args.key?(:producer_project_id) + @quota = args[:quota] if args.key?(:quota) + @source_info = args[:source_info] if args.key?(:source_info) + @system_parameters = args[:system_parameters] if args.key?(:system_parameters) + @system_types = args[:system_types] if args.key?(:system_types) + @title = args[:title] if args.key?(:title) + @types = args[:types] if args.key?(:types) + @usage = args[:usage] if args.key?(:usage) + end + end + + # The per-product per-project service identity for a service. + # Use this field to configure per-product per-project service identity. + # Example of a service identity configuration. + # usage: + # service_identity: + # - service_account_parent: "projects/123456789" + # display_name: "Cloud XXX Service Agent" + # description: "Used as the identity of Cloud XXX to access resources" + class ServiceIdentity + include Google::Apis::Core::Hashable + + # Optional. A user-specified opaque description of the service account. + # Must be less than or equal to 256 UTF-8 bytes. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Optional. A user-specified name for the service account. + # Must be less than or equal to 100 UTF-8 bytes. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # A service account project that hosts the service accounts. + # An example name would be: + # `projects/123456789` + # Corresponds to the JSON property `serviceAccountParent` + # @return [String] + attr_accessor :service_account_parent + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @service_account_parent = args[:service_account_parent] if args.key?(:service_account_parent) + end + end + + # `SourceContext` represents information about the source of a + # protobuf element, like the file in which it is defined. + class SourceContext + include Google::Apis::Core::Hashable + + # The path-qualified name of the .proto file that contained the associated + # protobuf element. For example: `"google/protobuf/source_context.proto"`. + # Corresponds to the JSON property `fileName` + # @return [String] + attr_accessor :file_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @file_name = args[:file_name] if args.key?(:file_name) + end + end + + # Source information used to create a Service Config + class SourceInfo + include Google::Apis::Core::Hashable + + # All files used during config generation. + # Corresponds to the JSON property `sourceFiles` + # @return [Array>] + attr_accessor :source_files + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @source_files = args[:source_files] if args.key?(:source_files) + 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 Status + 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>] + 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 + + # Define a parameter's name and location. The parameter may be passed as either + # an HTTP header or a URL query parameter, and if both are passed the behavior + # is implementation-dependent. + class SystemParameter + include Google::Apis::Core::Hashable + + # Define the HTTP header name to use for the parameter. It is case + # insensitive. + # Corresponds to the JSON property `httpHeader` + # @return [String] + attr_accessor :http_header + + # Define the name of the parameter, such as "api_key" . It is case sensitive. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Define the URL query parameter name to use for the parameter. It is case + # sensitive. + # Corresponds to the JSON property `urlQueryParameter` + # @return [String] + attr_accessor :url_query_parameter + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @http_header = args[:http_header] if args.key?(:http_header) + @name = args[:name] if args.key?(:name) + @url_query_parameter = args[:url_query_parameter] if args.key?(:url_query_parameter) + end + end + + # Define a system parameter rule mapping system parameter definitions to + # methods. + class SystemParameterRule + include Google::Apis::Core::Hashable + + # Define parameters. Multiple names may be defined for a parameter. + # For a given method call, only one of them should be used. If multiple + # names are used the behavior is implementation-dependent. + # If none of the specified names are present the behavior is + # parameter-dependent. + # Corresponds to the JSON property `parameters` + # @return [Array] + attr_accessor :parameters + + # Selects the methods to which this rule applies. Use '*' to indicate all + # methods in all APIs. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @parameters = args[:parameters] if args.key?(:parameters) + @selector = args[:selector] if args.key?(:selector) + end + end + + # ### System parameter configuration + # A system parameter is a special kind of parameter defined by the API + # system, not by an individual API. It is typically mapped to an HTTP header + # and/or a URL query parameter. This configuration specifies which methods + # change the names of the system parameters. + class SystemParameters + include Google::Apis::Core::Hashable + + # Define system parameters. + # The parameters defined here will override the default parameters + # implemented by the system. If this field is missing from the service + # config, default system parameters will be used. Default system parameters + # and names is implementation-dependent. + # Example: define api key for all methods + # system_parameters + # rules: + # - selector: "*" + # parameters: + # - name: api_key + # url_query_parameter: api_key + # Example: define 2 api key names for a specific method. + # system_parameters + # rules: + # - selector: "/ListShelves" + # parameters: + # - name: api_key + # http_header: Api-Key1 + # - name: api_key + # http_header: Api-Key2 + # **NOTE:** All service configuration rules follow "last one wins" order. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @rules = args[:rules] if args.key?(:rules) + end + end + + # A protocol buffer message type. + class Type + include Google::Apis::Core::Hashable + + # The list of fields. + # Corresponds to the JSON property `fields` + # @return [Array] + attr_accessor :fields + + # The fully qualified message name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The list of types appearing in `oneof` definitions in this type. + # Corresponds to the JSON property `oneofs` + # @return [Array] + attr_accessor :oneofs + + # The protocol buffer options. + # Corresponds to the JSON property `options` + # @return [Array] + attr_accessor :options + + # `SourceContext` represents information about the source of a + # protobuf element, like the file in which it is defined. + # Corresponds to the JSON property `sourceContext` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::SourceContext] + attr_accessor :source_context + + # The source syntax. + # Corresponds to the JSON property `syntax` + # @return [String] + attr_accessor :syntax + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fields = args[:fields] if args.key?(:fields) + @name = args[:name] if args.key?(:name) + @oneofs = args[:oneofs] if args.key?(:oneofs) + @options = args[:options] if args.key?(:options) + @source_context = args[:source_context] if args.key?(:source_context) + @syntax = args[:syntax] if args.key?(:syntax) + end + end + + # Configuration controlling usage of a service. + class Usage + include Google::Apis::Core::Hashable + + # The full resource name of a channel used for sending notifications to the + # service producer. + # Google Service Management currently only supports + # [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification + # channel. To use Google Cloud Pub/Sub as the channel, this must be the name + # of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format + # documented in https://cloud.google.com/pubsub/docs/overview. + # Corresponds to the JSON property `producerNotificationChannel` + # @return [String] + attr_accessor :producer_notification_channel + + # Requirements that must be satisfied before a consumer project can use the + # service. Each requirement is of the form /; + # for example 'serviceusage.googleapis.com/billing-enabled'. + # Corresponds to the JSON property `requirements` + # @return [Array] + attr_accessor :requirements + + # A list of usage rules that apply to individual API methods. + # **NOTE:** All service configuration rules follow "last one wins" order. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + # The per-product per-project service identity for a service. + # Use this field to configure per-product per-project service identity. + # Example of a service identity configuration. + # usage: + # service_identity: + # - service_account_parent: "projects/123456789" + # display_name: "Cloud XXX Service Agent" + # description: "Used as the identity of Cloud XXX to access resources" + # Corresponds to the JSON property `serviceIdentity` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::ServiceIdentity] + attr_accessor :service_identity + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @producer_notification_channel = args[:producer_notification_channel] if args.key?(:producer_notification_channel) + @requirements = args[:requirements] if args.key?(:requirements) + @rules = args[:rules] if args.key?(:rules) + @service_identity = args[:service_identity] if args.key?(:service_identity) + end + end + + # Usage configuration rules for the service. + # NOTE: Under development. + # Use this rule to configure unregistered calls for the service. Unregistered + # calls are calls that do not contain consumer project identity. + # (Example: calls that do not contain an API key). + # By default, API methods do not allow unregistered calls, and each method call + # must be identified by a consumer project identity. Use this rule to + # allow/disallow unregistered calls. + # Example of an API that wants to allow unregistered calls for entire service. + # usage: + # rules: + # - selector: "*" + # allow_unregistered_calls: true + # Example of a method that wants to allow unregistered calls. + # usage: + # rules: + # - selector: "google.example.library.v1.LibraryService.CreateBook" + # allow_unregistered_calls: true + class UsageRule + include Google::Apis::Core::Hashable + + # If true, the selected method allows unregistered calls, e.g. calls + # that don't identify any user or application. + # Corresponds to the JSON property `allowUnregisteredCalls` + # @return [Boolean] + attr_accessor :allow_unregistered_calls + alias_method :allow_unregistered_calls?, :allow_unregistered_calls + + # Selects the methods to which this rule applies. Use '*' to indicate all + # methods in all APIs. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + # If true, the selected method should skip service control and the control + # plane features, such as quota and billing, will not be available. + # This flag is used by Google Cloud Endpoints to bypass checks for internal + # methods, such as service health check methods. + # Corresponds to the JSON property `skipServiceControl` + # @return [Boolean] + attr_accessor :skip_service_control + alias_method :skip_service_control?, :skip_service_control + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allow_unregistered_calls = args[:allow_unregistered_calls] if args.key?(:allow_unregistered_calls) + @selector = args[:selector] if args.key?(:selector) + @skip_service_control = args[:skip_service_control] if args.key?(:skip_service_control) + end + end + + # Response message for BatchCreateProducerOverrides + class V1Beta1BatchCreateProducerOverridesResponse + include Google::Apis::Core::Hashable + + # The overrides that were created. + # Corresponds to the JSON property `overrides` + # @return [Array] + attr_accessor :overrides + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @overrides = args[:overrides] if args.key?(:overrides) + end + end + + # Consumer quota settings for a quota limit. + class V1Beta1ConsumerQuotaLimit + include Google::Apis::Core::Hashable + + # Whether this limit is precise or imprecise. + # Corresponds to the JSON property `isPrecise` + # @return [Boolean] + attr_accessor :is_precise + alias_method :is_precise?, :is_precise + + # The name of the parent metric of this limit. + # An example name would be: + # `compute.googleapis.com/cpus` + # Corresponds to the JSON property `metric` + # @return [String] + attr_accessor :metric + + # The resource name of the quota limit. + # An example name would be: + # `services/compute.googleapis.com/projects/123/quotas/metrics/compute. + # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` + # The resource name is intended to be opaque and should not be parsed for + # its component strings, since its representation could change in the future. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Summary of the enforced quota buckets, organized by quota dimension, + # ordered from least specific to most specific (for example, the global + # default bucket, with no quota dimensions, will always appear first). + # Corresponds to the JSON property `quotaBuckets` + # @return [Array] + attr_accessor :quota_buckets + + # The limit unit. + # An example unit would be: + # `1/`project`/`region`` + # Note that ``project`` and ``region`` are not placeholders in this example; + # the literal characters ``` and ``` occur in the string. + # Corresponds to the JSON property `unit` + # @return [String] + attr_accessor :unit + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @is_precise = args[:is_precise] if args.key?(:is_precise) + @metric = args[:metric] if args.key?(:metric) + @name = args[:name] if args.key?(:name) + @quota_buckets = args[:quota_buckets] if args.key?(:quota_buckets) + @unit = args[:unit] if args.key?(:unit) + end + end + + # Consumer quota settings for a quota metric. + class V1Beta1ConsumerQuotaMetric + include Google::Apis::Core::Hashable + + # The consumer quota for each quota limit defined on the metric. + # Corresponds to the JSON property `consumerQuotaLimits` + # @return [Array] + attr_accessor :consumer_quota_limits + + # The display name of the metric. + # An example name would be: + # "CPUs" + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The name of the metric. + # An example name would be: + # `compute.googleapis.com/cpus` + # Corresponds to the JSON property `metric` + # @return [String] + attr_accessor :metric + + # The resource name of the quota settings on this metric for this consumer. + # An example name would be: + # `services/serviceconsumermanagement.googleapis.com/projects/123/quota/metrics/ + # compute.googleapis.com%2Fcpus + # The resource name is intended to be opaque and should not be parsed for + # its component strings, since its representation could change in the future. + # 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) + @consumer_quota_limits = args[:consumer_quota_limits] if args.key?(:consumer_quota_limits) + @display_name = args[:display_name] if args.key?(:display_name) + @metric = args[:metric] if args.key?(:metric) + @name = args[:name] if args.key?(:name) + end + end + + # Response message for the `DisableConsumer` method. + # This response message is assigned to the `response` field of the returned + # Operation when that operation is done. + class V1Beta1DisableConsumerResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Response message for the `EnableConsumer` method. + # This response message is assigned to the `response` field of the returned + # Operation when that operation is done. + class V1Beta1EnableConsumerResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Response message for the `GenerateServiceIdentity` method. + # This response message is assigned to the `response` field of the returned + # Operation when that operation is done. + class V1Beta1GenerateServiceIdentityResponse + include Google::Apis::Core::Hashable + + # A service identity in the Identity and Access Management API. + # Corresponds to the JSON property `identity` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ServiceIdentity] + attr_accessor :identity + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @identity = args[:identity] if args.key?(:identity) + end + end + + # Request message for ImportProducerOverrides + class V1Beta1ImportProducerOverridesRequest + include Google::Apis::Core::Hashable + + # Whether to force the creation of the quota overrides. + # If creating an override would cause the effective quota for the consumer to + # decrease by more than 10 percent, the call is rejected, as a safety measure + # to avoid accidentally decreasing quota too quickly. Setting the force + # parameter to true ignores this restriction. + # Corresponds to the JSON property `force` + # @return [Boolean] + attr_accessor :force + alias_method :force?, :force + + # Import data embedded in the request message + # Corresponds to the JSON property `inlineSource` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1OverrideInlineSource] + attr_accessor :inline_source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @force = args[:force] if args.key?(:force) + @inline_source = args[:inline_source] if args.key?(:inline_source) + end + end + + # Response message for ImportProducerOverrides + class V1Beta1ImportProducerOverridesResponse + include Google::Apis::Core::Hashable + + # The overrides that were created from the imported data. + # Corresponds to the JSON property `overrides` + # @return [Array] + attr_accessor :overrides + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @overrides = args[:overrides] if args.key?(:overrides) + end + end + + # Response message for ListConsumerQuotaMetrics. + class V1Beta1ListConsumerQuotaMetricsResponse + include Google::Apis::Core::Hashable + + # Quota settings for the consumer, organized by quota metric. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Token identifying which result to start with; returned by a previous list + # call. + # 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) + @metrics = args[:metrics] if args.key?(:metrics) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Response message for ListProducerOverrides. + class V1Beta1ListProducerOverridesResponse + include Google::Apis::Core::Hashable + + # Token identifying which result to start with; returned by a previous list + # call. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Producer overrides on this limit. + # Corresponds to the JSON property `overrides` + # @return [Array] + attr_accessor :overrides + + 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) + @overrides = args[:overrides] if args.key?(:overrides) + end + end + + # Import data embedded in the request message + class V1Beta1OverrideInlineSource + include Google::Apis::Core::Hashable + + # The overrides to create. + # Each override must have a value for 'metric' and 'unit', to specify + # which metric and which limit the override should be applied to. + # Corresponds to the JSON property `overrides` + # @return [Array] + attr_accessor :overrides + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @overrides = args[:overrides] if args.key?(:overrides) + end + end + + # A quota bucket is a quota provisioning unit for a specific set of dimensions. + class V1Beta1QuotaBucket + include Google::Apis::Core::Hashable + + # A quota override + # Corresponds to the JSON property `adminOverride` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride] + attr_accessor :admin_override + + # A quota override + # Corresponds to the JSON property `consumerOverride` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride] + attr_accessor :consumer_override + + # The default limit of this quota bucket, as specified by the service + # configuration. + # Corresponds to the JSON property `defaultLimit` + # @return [Fixnum] + attr_accessor :default_limit + + # The dimensions of this quota bucket. + # If this map is empty, this is the global bucket, which is the default quota + # value applied to all requests that do not have a more specific override. + # If this map is nonempty, the default limit, effective limit, and quota + # overrides apply only to requests that have the dimensions given in the map. + # For example, if the map has key "region" and value "us-east-1", then the + # specified effective limit is only effective in that region, and the + # specified overrides apply only in that region. + # Corresponds to the JSON property `dimensions` + # @return [Hash] + attr_accessor :dimensions + + # The effective limit of this quota bucket. Equal to default_limit if there + # are no overrides. + # Corresponds to the JSON property `effectiveLimit` + # @return [Fixnum] + attr_accessor :effective_limit + + # A quota override + # Corresponds to the JSON property `producerOverride` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride] + attr_accessor :producer_override + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @admin_override = args[:admin_override] if args.key?(:admin_override) + @consumer_override = args[:consumer_override] if args.key?(:consumer_override) + @default_limit = args[:default_limit] if args.key?(:default_limit) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @effective_limit = args[:effective_limit] if args.key?(:effective_limit) + @producer_override = args[:producer_override] if args.key?(:producer_override) + end + end + + # A quota override + class V1Beta1QuotaOverride + include Google::Apis::Core::Hashable + + # If this map is nonempty, then this override applies only to specific values + # for dimensions defined in the limit unit. + # For example, an override on a limit with the unit 1/`project`/`region` + # could contain an entry with the key "region" and the value "us-east-1"; + # the override is only applied to quota consumed in that region. + # This map has the following restrictions: + # * Keys that are not defined in the limit's unit are not valid keys. + # Any string appearing in `brackets` in the unit (besides `project` or + # `user`) is a defined key. + # * "project" is not a valid key; the project is already specified in + # the parent resource name. + # * "user" is not a valid key; the API does not support quota overrides + # that apply only to a specific user. + # * If "region" appears as a key, its value must be a valid Cloud region. + # * If "zone" appears as a key, its value must be a valid Cloud zone. + # * If any valid key other than "region" or "zone" appears in the map, then + # all valid keys other than "region" or "zone" must also appear in the + # map. + # Corresponds to the JSON property `dimensions` + # @return [Hash] + attr_accessor :dimensions + + # The name of the metric to which this override applies. + # An example name would be: + # `compute.googleapis.com/cpus` + # Corresponds to the JSON property `metric` + # @return [String] + attr_accessor :metric + + # The resource name of the producer override. + # An example name would be: + # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. + # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The overriding quota limit value. + # Can be any nonnegative integer, or -1 (unlimited quota). + # Corresponds to the JSON property `overrideValue` + # @return [Fixnum] + attr_accessor :override_value + + # The limit unit of the limit to which this override applies. + # An example unit would be: + # `1/`project`/`region`` + # Note that ``project`` and ``region`` are not placeholders in this example; + # the literal characters ``` and ``` occur in the string. + # Corresponds to the JSON property `unit` + # @return [String] + attr_accessor :unit + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @metric = args[:metric] if args.key?(:metric) + @name = args[:name] if args.key?(:name) + @override_value = args[:override_value] if args.key?(:override_value) + @unit = args[:unit] if args.key?(:unit) + end + end + + # Response message for the `RefreshConsumer` method. + # This response message is assigned to the `response` field of the returned + # Operation when that operation is done. + class V1Beta1RefreshConsumerResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # A service identity in the Identity and Access Management API. + class V1Beta1ServiceIdentity + include Google::Apis::Core::Hashable + + # The email address of the service identity. + # Corresponds to the JSON property `email` + # @return [String] + attr_accessor :email + + # P4 service identity resource name. + # An example name would be: + # `services/serviceconsumermanagement.googleapis.com/projects/123/ + # serviceIdentities/default` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The P4 service identity configuration tag. This must be defined in + # activation_grants. If not specified when creating the account, the tag is + # set to "default". + # Corresponds to the JSON property `tag` + # @return [String] + attr_accessor :tag + + # The unique and stable id of the service identity. + # Corresponds to the JSON property `uniqueId` + # @return [String] + attr_accessor :unique_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @email = args[:email] if args.key?(:email) + @name = args[:name] if args.key?(:name) + @tag = args[:tag] if args.key?(:tag) + @unique_id = args[:unique_id] if args.key?(:unique_id) + end + end + + # Response message for the `AddVisibilityLabels` method. + # This response message is assigned to the `response` field of the returned + # Operation when that operation is done. + class V1beta1AddVisibilityLabelsResponse + include Google::Apis::Core::Hashable + + # The updated set of visibility labels for this consumer on this service. + # Corresponds to the JSON property `labels` + # @return [Array] + attr_accessor :labels + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @labels = args[:labels] if args.key?(:labels) + end + end + + # A default identity in the Identity and Access Management API. + class V1beta1DefaultIdentity + include Google::Apis::Core::Hashable + + # The email address of the default identity. + # Corresponds to the JSON property `email` + # @return [String] + attr_accessor :email + + # Default identity resource name. + # An example name would be: + # `services/serviceconsumermanagement.googleapis.com/projects/123/ + # defaultIdentity` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The unique and stable id of the default identity. + # Corresponds to the JSON property `uniqueId` + # @return [String] + attr_accessor :unique_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @email = args[:email] if args.key?(:email) + @name = args[:name] if args.key?(:name) + @unique_id = args[:unique_id] if args.key?(:unique_id) + end + end + + # Response message for the `DisableConsumer` method. + # This response message is assigned to the `response` field of the returned + # Operation when that operation is done. + class V1beta1DisableConsumerResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Response message for the `EnableConsumer` method. + # This response message is assigned to the `response` field of the returned + # Operation when that operation is done. + class V1beta1EnableConsumerResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Response message for the `GenerateDefaultIdentity` method. + # This response message is assigned to the `response` field of the returned + # Operation when that operation is done. + class V1beta1GenerateDefaultIdentityResponse + include Google::Apis::Core::Hashable + + # Status of the role attachment. Under development (go/si-attach-role), + # currently always return ATTACH_STATUS_UNSPECIFIED) + # Corresponds to the JSON property `attachStatus` + # @return [String] + attr_accessor :attach_status + + # A default identity in the Identity and Access Management API. + # Corresponds to the JSON property `identity` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::V1beta1DefaultIdentity] + attr_accessor :identity + + # Role attached to consumer project. Empty if not attached in this + # request. (Under development, currently always return empty.) + # 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) + @attach_status = args[:attach_status] if args.key?(:attach_status) + @identity = args[:identity] if args.key?(:identity) + @role = args[:role] if args.key?(:role) + end + end + + # Response message for the `GenerateServiceAccount` method. + # This response message is assigned to the `response` field of the returned + # Operation when that operation is done. + class V1beta1GenerateServiceAccountResponse + include Google::Apis::Core::Hashable + + # A service account in the Identity and Access Management API. + # Corresponds to the JSON property `account` + # @return [Google::Apis::ServiceconsumermanagementV1beta1::V1beta1ServiceAccount] + attr_accessor :account + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account = args[:account] if args.key?(:account) + end + end + + # Response message for the `RefreshConsumer` method. + # This response message is assigned to the `response` field of the returned + # Operation when that operation is done. + class V1beta1RefreshConsumerResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Response message for the `RemoveVisibilityLabels` method. + # This response message is assigned to the `response` field of the returned + # Operation when that operation is done. + class V1beta1RemoveVisibilityLabelsResponse + include Google::Apis::Core::Hashable + + # The updated set of visibility labels for this consumer on this service. + # Corresponds to the JSON property `labels` + # @return [Array] + attr_accessor :labels + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @labels = args[:labels] if args.key?(:labels) + end + end + + # A service account in the Identity and Access Management API. + class V1beta1ServiceAccount + include Google::Apis::Core::Hashable + + # The email address of the service account. + # Corresponds to the JSON property `email` + # @return [String] + attr_accessor :email + + # Deprecated. See b/136209818. + # Corresponds to the JSON property `iamAccountName` + # @return [String] + attr_accessor :iam_account_name + + # P4 SA resource name. + # An example name would be: + # `services/serviceconsumermanagement.googleapis.com/projects/123/ + # serviceAccounts/default` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The P4 SA configuration tag. This must be defined in activation_grants. + # If not specified when creating the account, the tag is set to "default". + # Corresponds to the JSON property `tag` + # @return [String] + attr_accessor :tag + + # The unique and stable id of the service account. + # Corresponds to the JSON property `uniqueId` + # @return [String] + attr_accessor :unique_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @email = args[:email] if args.key?(:email) + @iam_account_name = args[:iam_account_name] if args.key?(:iam_account_name) + @name = args[:name] if args.key?(:name) + @tag = args[:tag] if args.key?(:tag) + @unique_id = args[:unique_id] if args.key?(:unique_id) + end + end + end + end +end diff --git a/generated/google/apis/serviceconsumermanagement_v1beta1/representations.rb b/generated/google/apis/serviceconsumermanagement_v1beta1/representations.rb new file mode 100644 index 000000000..f3d296172 --- /dev/null +++ b/generated/google/apis/serviceconsumermanagement_v1beta1/representations.rb @@ -0,0 +1,1308 @@ +# Copyright 2015 Google Inc. +# +# 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 ServiceconsumermanagementV1beta1 + + class Api + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuthProvider + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuthRequirement + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Authentication + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuthenticationRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Backend + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BackendRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Billing + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BillingDestination + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Context + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ContextRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Control + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomError + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomErrorRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomHttpPattern + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Documentation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DocumentationRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Endpoint + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Enum + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EnumValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Field + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Http + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class HttpRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class JwtLocation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LabelDescriptor + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LogDescriptor + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Logging + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LoggingDestination + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MethodProp + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MetricDescriptor + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MetricDescriptorMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MetricRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Mixin + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MonitoredResourceDescriptor + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Monitoring + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MonitoringDestination + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OAuthRequirements + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Operation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Option + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Page + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Quota + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class QuotaLimit + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Service + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ServiceIdentity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SourceContext + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SourceInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Status + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SystemParameter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SystemParameterRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SystemParameters + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Type + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Usage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UsageRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1Beta1BatchCreateProducerOverridesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1Beta1ConsumerQuotaLimit + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1Beta1ConsumerQuotaMetric + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1Beta1DisableConsumerResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1Beta1EnableConsumerResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1Beta1GenerateServiceIdentityResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1Beta1ImportProducerOverridesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1Beta1ImportProducerOverridesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1Beta1ListConsumerQuotaMetricsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1Beta1ListProducerOverridesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1Beta1OverrideInlineSource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1Beta1QuotaBucket + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1Beta1QuotaOverride + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1Beta1RefreshConsumerResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1Beta1ServiceIdentity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1beta1AddVisibilityLabelsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1beta1DefaultIdentity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1beta1DisableConsumerResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1beta1EnableConsumerResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1beta1GenerateDefaultIdentityResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1beta1GenerateServiceAccountResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1beta1RefreshConsumerResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1beta1RemoveVisibilityLabelsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class V1beta1ServiceAccount + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Api + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :methods_prop, as: 'methods', class: Google::Apis::ServiceconsumermanagementV1beta1::MethodProp, decorator: Google::Apis::ServiceconsumermanagementV1beta1::MethodProp::Representation + + collection :mixins, as: 'mixins', class: Google::Apis::ServiceconsumermanagementV1beta1::Mixin, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Mixin::Representation + + property :name, as: 'name' + collection :options, as: 'options', class: Google::Apis::ServiceconsumermanagementV1beta1::Option, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Option::Representation + + property :source_context, as: 'sourceContext', class: Google::Apis::ServiceconsumermanagementV1beta1::SourceContext, decorator: Google::Apis::ServiceconsumermanagementV1beta1::SourceContext::Representation + + property :syntax, as: 'syntax' + property :version, as: 'version' + end + end + + class AuthProvider + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :audiences, as: 'audiences' + property :authorization_url, as: 'authorizationUrl' + property :id, as: 'id' + property :issuer, as: 'issuer' + property :jwks_uri, as: 'jwksUri' + collection :jwt_locations, as: 'jwtLocations', class: Google::Apis::ServiceconsumermanagementV1beta1::JwtLocation, decorator: Google::Apis::ServiceconsumermanagementV1beta1::JwtLocation::Representation + + end + end + + class AuthRequirement + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :audiences, as: 'audiences' + property :provider_id, as: 'providerId' + end + end + + class Authentication + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :providers, as: 'providers', class: Google::Apis::ServiceconsumermanagementV1beta1::AuthProvider, decorator: Google::Apis::ServiceconsumermanagementV1beta1::AuthProvider::Representation + + collection :rules, as: 'rules', class: Google::Apis::ServiceconsumermanagementV1beta1::AuthenticationRule, decorator: Google::Apis::ServiceconsumermanagementV1beta1::AuthenticationRule::Representation + + end + end + + class AuthenticationRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :allow_without_credential, as: 'allowWithoutCredential' + property :oauth, as: 'oauth', class: Google::Apis::ServiceconsumermanagementV1beta1::OAuthRequirements, decorator: Google::Apis::ServiceconsumermanagementV1beta1::OAuthRequirements::Representation + + collection :requirements, as: 'requirements', class: Google::Apis::ServiceconsumermanagementV1beta1::AuthRequirement, decorator: Google::Apis::ServiceconsumermanagementV1beta1::AuthRequirement::Representation + + property :selector, as: 'selector' + end + end + + class Backend + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :rules, as: 'rules', class: Google::Apis::ServiceconsumermanagementV1beta1::BackendRule, decorator: Google::Apis::ServiceconsumermanagementV1beta1::BackendRule::Representation + + end + end + + class BackendRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :address, as: 'address' + property :deadline, as: 'deadline' + property :disable_auth, as: 'disableAuth' + property :jwt_audience, as: 'jwtAudience' + property :min_deadline, as: 'minDeadline' + property :operation_deadline, as: 'operationDeadline' + property :path_translation, as: 'pathTranslation' + property :protocol, as: 'protocol' + property :rename_to, as: 'renameTo' + property :selector, as: 'selector' + end + end + + class Billing + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :consumer_destinations, as: 'consumerDestinations', class: Google::Apis::ServiceconsumermanagementV1beta1::BillingDestination, decorator: Google::Apis::ServiceconsumermanagementV1beta1::BillingDestination::Representation + + end + end + + class BillingDestination + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :metrics, as: 'metrics' + property :monitored_resource, as: 'monitoredResource' + end + end + + class Context + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :rules, as: 'rules', class: Google::Apis::ServiceconsumermanagementV1beta1::ContextRule, decorator: Google::Apis::ServiceconsumermanagementV1beta1::ContextRule::Representation + + end + end + + class ContextRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :allowed_request_extensions, as: 'allowedRequestExtensions' + collection :allowed_response_extensions, as: 'allowedResponseExtensions' + collection :provided, as: 'provided' + collection :requested, as: 'requested' + property :selector, as: 'selector' + end + end + + class Control + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :environment, as: 'environment' + end + end + + class CustomError + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :rules, as: 'rules', class: Google::Apis::ServiceconsumermanagementV1beta1::CustomErrorRule, decorator: Google::Apis::ServiceconsumermanagementV1beta1::CustomErrorRule::Representation + + collection :types, as: 'types' + end + end + + class CustomErrorRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :is_error_type, as: 'isErrorType' + property :selector, as: 'selector' + end + end + + class CustomHttpPattern + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :path, as: 'path' + end + end + + class Documentation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :documentation_root_url, as: 'documentationRootUrl' + property :overview, as: 'overview' + collection :pages, as: 'pages', class: Google::Apis::ServiceconsumermanagementV1beta1::Page, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Page::Representation + + collection :rules, as: 'rules', class: Google::Apis::ServiceconsumermanagementV1beta1::DocumentationRule, decorator: Google::Apis::ServiceconsumermanagementV1beta1::DocumentationRule::Representation + + property :service_root_url, as: 'serviceRootUrl' + property :summary, as: 'summary' + end + end + + class DocumentationRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :deprecation_description, as: 'deprecationDescription' + property :description, as: 'description' + property :selector, as: 'selector' + end + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class Endpoint + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :aliases, as: 'aliases' + property :allow_cors, as: 'allowCors' + collection :features, as: 'features' + property :name, as: 'name' + property :target, as: 'target' + end + end + + class Enum + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :enumvalue, as: 'enumvalue', class: Google::Apis::ServiceconsumermanagementV1beta1::EnumValue, decorator: Google::Apis::ServiceconsumermanagementV1beta1::EnumValue::Representation + + property :name, as: 'name' + collection :options, as: 'options', class: Google::Apis::ServiceconsumermanagementV1beta1::Option, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Option::Representation + + property :source_context, as: 'sourceContext', class: Google::Apis::ServiceconsumermanagementV1beta1::SourceContext, decorator: Google::Apis::ServiceconsumermanagementV1beta1::SourceContext::Representation + + property :syntax, as: 'syntax' + end + end + + class EnumValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :number, as: 'number' + collection :options, as: 'options', class: Google::Apis::ServiceconsumermanagementV1beta1::Option, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Option::Representation + + end + end + + class Field + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cardinality, as: 'cardinality' + property :default_value, as: 'defaultValue' + property :json_name, as: 'jsonName' + property :kind, as: 'kind' + property :name, as: 'name' + property :number, as: 'number' + property :oneof_index, as: 'oneofIndex' + collection :options, as: 'options', class: Google::Apis::ServiceconsumermanagementV1beta1::Option, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Option::Representation + + property :packed, as: 'packed' + property :type_url, as: 'typeUrl' + end + end + + class Http + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :fully_decode_reserved_expansion, as: 'fullyDecodeReservedExpansion' + collection :rules, as: 'rules', class: Google::Apis::ServiceconsumermanagementV1beta1::HttpRule, decorator: Google::Apis::ServiceconsumermanagementV1beta1::HttpRule::Representation + + end + end + + class HttpRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :additional_bindings, as: 'additionalBindings', class: Google::Apis::ServiceconsumermanagementV1beta1::HttpRule, decorator: Google::Apis::ServiceconsumermanagementV1beta1::HttpRule::Representation + + property :allow_half_duplex, as: 'allowHalfDuplex' + property :body, as: 'body' + property :custom, as: 'custom', class: Google::Apis::ServiceconsumermanagementV1beta1::CustomHttpPattern, decorator: Google::Apis::ServiceconsumermanagementV1beta1::CustomHttpPattern::Representation + + property :delete, as: 'delete' + property :get, as: 'get' + property :patch, as: 'patch' + property :post, as: 'post' + property :put, as: 'put' + property :response_body, as: 'responseBody' + property :selector, as: 'selector' + end + end + + class JwtLocation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :header, as: 'header' + property :query, as: 'query' + property :value_prefix, as: 'valuePrefix' + end + end + + class LabelDescriptor + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :key, as: 'key' + property :value_type, as: 'valueType' + end + end + + class LogDescriptor + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + collection :labels, as: 'labels', class: Google::Apis::ServiceconsumermanagementV1beta1::LabelDescriptor, decorator: Google::Apis::ServiceconsumermanagementV1beta1::LabelDescriptor::Representation + + property :name, as: 'name' + end + end + + class Logging + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :consumer_destinations, as: 'consumerDestinations', class: Google::Apis::ServiceconsumermanagementV1beta1::LoggingDestination, decorator: Google::Apis::ServiceconsumermanagementV1beta1::LoggingDestination::Representation + + collection :producer_destinations, as: 'producerDestinations', class: Google::Apis::ServiceconsumermanagementV1beta1::LoggingDestination, decorator: Google::Apis::ServiceconsumermanagementV1beta1::LoggingDestination::Representation + + end + end + + class LoggingDestination + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :logs, as: 'logs' + property :monitored_resource, as: 'monitoredResource' + end + end + + class MethodProp + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + collection :options, as: 'options', class: Google::Apis::ServiceconsumermanagementV1beta1::Option, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Option::Representation + + property :request_streaming, as: 'requestStreaming' + property :request_type_url, as: 'requestTypeUrl' + property :response_streaming, as: 'responseStreaming' + property :response_type_url, as: 'responseTypeUrl' + property :syntax, as: 'syntax' + end + end + + class MetricDescriptor + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + collection :labels, as: 'labels', class: Google::Apis::ServiceconsumermanagementV1beta1::LabelDescriptor, decorator: Google::Apis::ServiceconsumermanagementV1beta1::LabelDescriptor::Representation + + property :launch_stage, as: 'launchStage' + property :metadata, as: 'metadata', class: Google::Apis::ServiceconsumermanagementV1beta1::MetricDescriptorMetadata, decorator: Google::Apis::ServiceconsumermanagementV1beta1::MetricDescriptorMetadata::Representation + + property :metric_kind, as: 'metricKind' + collection :monitored_resource_types, as: 'monitoredResourceTypes' + property :name, as: 'name' + property :type, as: 'type' + property :unit, as: 'unit' + property :value_type, as: 'valueType' + end + end + + class MetricDescriptorMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ingest_delay, as: 'ingestDelay' + property :launch_stage, as: 'launchStage' + property :sample_period, as: 'samplePeriod' + end + end + + class MetricRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :metric_costs, as: 'metricCosts' + property :selector, as: 'selector' + end + end + + class Mixin + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :root, as: 'root' + end + end + + class MonitoredResourceDescriptor + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + collection :labels, as: 'labels', class: Google::Apis::ServiceconsumermanagementV1beta1::LabelDescriptor, decorator: Google::Apis::ServiceconsumermanagementV1beta1::LabelDescriptor::Representation + + property :launch_stage, as: 'launchStage' + property :name, as: 'name' + property :type, as: 'type' + end + end + + class Monitoring + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :consumer_destinations, as: 'consumerDestinations', class: Google::Apis::ServiceconsumermanagementV1beta1::MonitoringDestination, decorator: Google::Apis::ServiceconsumermanagementV1beta1::MonitoringDestination::Representation + + collection :producer_destinations, as: 'producerDestinations', class: Google::Apis::ServiceconsumermanagementV1beta1::MonitoringDestination, decorator: Google::Apis::ServiceconsumermanagementV1beta1::MonitoringDestination::Representation + + end + end + + class MonitoringDestination + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :metrics, as: 'metrics' + property :monitored_resource, as: 'monitoredResource' + end + end + + class OAuthRequirements + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :canonical_scopes, as: 'canonicalScopes' + end + end + + class Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::ServiceconsumermanagementV1beta1::Status, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Status::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class Option + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + hash :value, as: 'value' + end + end + + class Page + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content, as: 'content' + property :name, as: 'name' + collection :subpages, as: 'subpages', class: Google::Apis::ServiceconsumermanagementV1beta1::Page, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Page::Representation + + end + end + + class Quota + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :limits, as: 'limits', class: Google::Apis::ServiceconsumermanagementV1beta1::QuotaLimit, decorator: Google::Apis::ServiceconsumermanagementV1beta1::QuotaLimit::Representation + + collection :metric_rules, as: 'metricRules', class: Google::Apis::ServiceconsumermanagementV1beta1::MetricRule, decorator: Google::Apis::ServiceconsumermanagementV1beta1::MetricRule::Representation + + end + end + + class QuotaLimit + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :default_limit, :numeric_string => true, as: 'defaultLimit' + property :description, as: 'description' + property :display_name, as: 'displayName' + property :duration, as: 'duration' + property :free_tier, :numeric_string => true, as: 'freeTier' + property :max_limit, :numeric_string => true, as: 'maxLimit' + property :metric, as: 'metric' + property :name, as: 'name' + property :unit, as: 'unit' + hash :values, as: 'values' + end + end + + class Service + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :apis, as: 'apis', class: Google::Apis::ServiceconsumermanagementV1beta1::Api, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Api::Representation + + property :authentication, as: 'authentication', class: Google::Apis::ServiceconsumermanagementV1beta1::Authentication, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Authentication::Representation + + property :backend, as: 'backend', class: Google::Apis::ServiceconsumermanagementV1beta1::Backend, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Backend::Representation + + property :billing, as: 'billing', class: Google::Apis::ServiceconsumermanagementV1beta1::Billing, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Billing::Representation + + property :config_version, as: 'configVersion' + property :context, as: 'context', class: Google::Apis::ServiceconsumermanagementV1beta1::Context, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Context::Representation + + property :control, as: 'control', class: Google::Apis::ServiceconsumermanagementV1beta1::Control, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Control::Representation + + property :custom_error, as: 'customError', class: Google::Apis::ServiceconsumermanagementV1beta1::CustomError, decorator: Google::Apis::ServiceconsumermanagementV1beta1::CustomError::Representation + + property :documentation, as: 'documentation', class: Google::Apis::ServiceconsumermanagementV1beta1::Documentation, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Documentation::Representation + + collection :endpoints, as: 'endpoints', class: Google::Apis::ServiceconsumermanagementV1beta1::Endpoint, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Endpoint::Representation + + collection :enums, as: 'enums', class: Google::Apis::ServiceconsumermanagementV1beta1::Enum, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Enum::Representation + + property :http, as: 'http', class: Google::Apis::ServiceconsumermanagementV1beta1::Http, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Http::Representation + + property :id, as: 'id' + property :logging, as: 'logging', class: Google::Apis::ServiceconsumermanagementV1beta1::Logging, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Logging::Representation + + collection :logs, as: 'logs', class: Google::Apis::ServiceconsumermanagementV1beta1::LogDescriptor, decorator: Google::Apis::ServiceconsumermanagementV1beta1::LogDescriptor::Representation + + collection :metrics, as: 'metrics', class: Google::Apis::ServiceconsumermanagementV1beta1::MetricDescriptor, decorator: Google::Apis::ServiceconsumermanagementV1beta1::MetricDescriptor::Representation + + collection :monitored_resources, as: 'monitoredResources', class: Google::Apis::ServiceconsumermanagementV1beta1::MonitoredResourceDescriptor, decorator: Google::Apis::ServiceconsumermanagementV1beta1::MonitoredResourceDescriptor::Representation + + property :monitoring, as: 'monitoring', class: Google::Apis::ServiceconsumermanagementV1beta1::Monitoring, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Monitoring::Representation + + property :name, as: 'name' + property :producer_project_id, as: 'producerProjectId' + property :quota, as: 'quota', class: Google::Apis::ServiceconsumermanagementV1beta1::Quota, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Quota::Representation + + property :source_info, as: 'sourceInfo', class: Google::Apis::ServiceconsumermanagementV1beta1::SourceInfo, decorator: Google::Apis::ServiceconsumermanagementV1beta1::SourceInfo::Representation + + property :system_parameters, as: 'systemParameters', class: Google::Apis::ServiceconsumermanagementV1beta1::SystemParameters, decorator: Google::Apis::ServiceconsumermanagementV1beta1::SystemParameters::Representation + + collection :system_types, as: 'systemTypes', class: Google::Apis::ServiceconsumermanagementV1beta1::Type, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Type::Representation + + property :title, as: 'title' + collection :types, as: 'types', class: Google::Apis::ServiceconsumermanagementV1beta1::Type, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Type::Representation + + property :usage, as: 'usage', class: Google::Apis::ServiceconsumermanagementV1beta1::Usage, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Usage::Representation + + end + end + + class ServiceIdentity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + property :service_account_parent, as: 'serviceAccountParent' + end + end + + class SourceContext + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :file_name, as: 'fileName' + end + end + + class SourceInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :source_files, as: 'sourceFiles' + end + end + + class Status + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + + class SystemParameter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :http_header, as: 'httpHeader' + property :name, as: 'name' + property :url_query_parameter, as: 'urlQueryParameter' + end + end + + class SystemParameterRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :parameters, as: 'parameters', class: Google::Apis::ServiceconsumermanagementV1beta1::SystemParameter, decorator: Google::Apis::ServiceconsumermanagementV1beta1::SystemParameter::Representation + + property :selector, as: 'selector' + end + end + + class SystemParameters + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :rules, as: 'rules', class: Google::Apis::ServiceconsumermanagementV1beta1::SystemParameterRule, decorator: Google::Apis::ServiceconsumermanagementV1beta1::SystemParameterRule::Representation + + end + end + + class Type + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :fields, as: 'fields', class: Google::Apis::ServiceconsumermanagementV1beta1::Field, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Field::Representation + + property :name, as: 'name' + collection :oneofs, as: 'oneofs' + collection :options, as: 'options', class: Google::Apis::ServiceconsumermanagementV1beta1::Option, decorator: Google::Apis::ServiceconsumermanagementV1beta1::Option::Representation + + property :source_context, as: 'sourceContext', class: Google::Apis::ServiceconsumermanagementV1beta1::SourceContext, decorator: Google::Apis::ServiceconsumermanagementV1beta1::SourceContext::Representation + + property :syntax, as: 'syntax' + end + end + + class Usage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :producer_notification_channel, as: 'producerNotificationChannel' + collection :requirements, as: 'requirements' + collection :rules, as: 'rules', class: Google::Apis::ServiceconsumermanagementV1beta1::UsageRule, decorator: Google::Apis::ServiceconsumermanagementV1beta1::UsageRule::Representation + + property :service_identity, as: 'serviceIdentity', class: Google::Apis::ServiceconsumermanagementV1beta1::ServiceIdentity, decorator: Google::Apis::ServiceconsumermanagementV1beta1::ServiceIdentity::Representation + + end + end + + class UsageRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :allow_unregistered_calls, as: 'allowUnregisteredCalls' + property :selector, as: 'selector' + property :skip_service_control, as: 'skipServiceControl' + end + end + + class V1Beta1BatchCreateProducerOverridesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :overrides, as: 'overrides', class: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride, decorator: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride::Representation + + end + end + + class V1Beta1ConsumerQuotaLimit + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :is_precise, as: 'isPrecise' + property :metric, as: 'metric' + property :name, as: 'name' + collection :quota_buckets, as: 'quotaBuckets', class: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaBucket, decorator: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaBucket::Representation + + property :unit, as: 'unit' + end + end + + class V1Beta1ConsumerQuotaMetric + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :consumer_quota_limits, as: 'consumerQuotaLimits', class: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaLimit, decorator: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaLimit::Representation + + property :display_name, as: 'displayName' + property :metric, as: 'metric' + property :name, as: 'name' + end + end + + class V1Beta1DisableConsumerResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class V1Beta1EnableConsumerResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class V1Beta1GenerateServiceIdentityResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :identity, as: 'identity', class: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ServiceIdentity, decorator: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ServiceIdentity::Representation + + end + end + + class V1Beta1ImportProducerOverridesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :force, as: 'force' + property :inline_source, as: 'inlineSource', class: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1OverrideInlineSource, decorator: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1OverrideInlineSource::Representation + + end + end + + class V1Beta1ImportProducerOverridesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :overrides, as: 'overrides', class: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride, decorator: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride::Representation + + end + end + + class V1Beta1ListConsumerQuotaMetricsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :metrics, as: 'metrics', class: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaMetric, decorator: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaMetric::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class V1Beta1ListProducerOverridesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :overrides, as: 'overrides', class: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride, decorator: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride::Representation + + end + end + + class V1Beta1OverrideInlineSource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :overrides, as: 'overrides', class: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride, decorator: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride::Representation + + end + end + + class V1Beta1QuotaBucket + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :admin_override, as: 'adminOverride', class: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride, decorator: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride::Representation + + property :consumer_override, as: 'consumerOverride', class: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride, decorator: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride::Representation + + property :default_limit, :numeric_string => true, as: 'defaultLimit' + hash :dimensions, as: 'dimensions' + property :effective_limit, :numeric_string => true, as: 'effectiveLimit' + property :producer_override, as: 'producerOverride', class: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride, decorator: Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride::Representation + + end + end + + class V1Beta1QuotaOverride + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :dimensions, as: 'dimensions' + property :metric, as: 'metric' + property :name, as: 'name' + property :override_value, :numeric_string => true, as: 'overrideValue' + property :unit, as: 'unit' + end + end + + class V1Beta1RefreshConsumerResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class V1Beta1ServiceIdentity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :email, as: 'email' + property :name, as: 'name' + property :tag, as: 'tag' + property :unique_id, as: 'uniqueId' + end + end + + class V1beta1AddVisibilityLabelsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :labels, as: 'labels' + end + end + + class V1beta1DefaultIdentity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :email, as: 'email' + property :name, as: 'name' + property :unique_id, as: 'uniqueId' + end + end + + class V1beta1DisableConsumerResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class V1beta1EnableConsumerResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class V1beta1GenerateDefaultIdentityResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :attach_status, as: 'attachStatus' + property :identity, as: 'identity', class: Google::Apis::ServiceconsumermanagementV1beta1::V1beta1DefaultIdentity, decorator: Google::Apis::ServiceconsumermanagementV1beta1::V1beta1DefaultIdentity::Representation + + property :role, as: 'role' + end + end + + class V1beta1GenerateServiceAccountResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account, as: 'account', class: Google::Apis::ServiceconsumermanagementV1beta1::V1beta1ServiceAccount, decorator: Google::Apis::ServiceconsumermanagementV1beta1::V1beta1ServiceAccount::Representation + + end + end + + class V1beta1RefreshConsumerResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class V1beta1RemoveVisibilityLabelsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :labels, as: 'labels' + end + end + + class V1beta1ServiceAccount + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :email, as: 'email' + property :iam_account_name, as: 'iamAccountName' + property :name, as: 'name' + property :tag, as: 'tag' + property :unique_id, as: 'uniqueId' + end + end + end + end +end diff --git a/generated/google/apis/serviceconsumermanagement_v1beta1/service.rb b/generated/google/apis/serviceconsumermanagement_v1beta1/service.rb new file mode 100644 index 000000000..630b8f5a6 --- /dev/null +++ b/generated/google/apis/serviceconsumermanagement_v1beta1/service.rb @@ -0,0 +1,428 @@ +# Copyright 2015 Google Inc. +# +# 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 '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 ServiceconsumermanagementV1beta1 + # Service Consumer Management API + # + # Manages the service consumers of a Service Infrastructure service. + # + # @example + # require 'google/apis/serviceconsumermanagement_v1beta1' + # + # Serviceconsumermanagement = Google::Apis::ServiceconsumermanagementV1beta1 # Alias the module + # service = Serviceconsumermanagement::ServiceConsumerManagementService.new + # + # @see https://cloud.google.com/service-consumer-management/docs/overview + class ServiceConsumerManagementService < Google::Apis::Core::BaseService + # @return [String] + # API key. Your API key identifies your project and provides you with API access, + # quota, and reports. Required unless you provide an OAuth 2.0 token. + attr_accessor :key + + # @return [String] + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + attr_accessor :quota_user + + def initialize + super('https://serviceconsumermanagement.googleapis.com/', '') + @batch_path = 'batch' + end + + # Gets the latest state of a long-running operation. Clients can use this + # method to poll the operation result at intervals as recommended by the API + # service. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::Operation::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a summary of quota information for a specific quota metric. + # @param [String] name + # The resource name of the quota metric, returned by a + # ListConsumerQuotaMetrics call. + # An example name would be: + # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. + # googleapis.com%2Fcpus` + # @param [String] view + # Specifies the level of detail for quota information in the response. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaMetric] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaMetric] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_service_consumer_quota_metric(name, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaMetric::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaMetric + command.params['name'] = name unless name.nil? + command.query['view'] = view unless view.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Create or update multiple producer overrides atomically, all on the + # same consumer, but on many different metrics or limits. + # The name field in the quota override message should not be set. + # @param [String] parent + # The resource name of the consumer. + # An example name would be: + # `services/compute.googleapis.com/projects/123` + # @param [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ImportProducerOverridesRequest] v1_beta1_import_producer_overrides_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def import_service_consumer_quota_metric_producer_overrides(parent, v1_beta1_import_producer_overrides_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+parent}/consumerQuotaMetrics:importProducerOverrides', options) + command.request_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ImportProducerOverridesRequest::Representation + command.request_object = v1_beta1_import_producer_overrides_request_object + command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::Operation::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a summary of all quota information about this consumer that is + # visible to the service producer, for each quota metric defined by the + # service. Each metric includes information about all of its defined limits. + # Each limit includes the limit configuration (quota unit, preciseness, + # default value), the current effective limit value, and all of the overrides + # applied to the limit. + # @param [String] parent + # Parent of the quotas resource. + # An example parent would be: + # `services/serviceconsumermanagement.googleapis.com/projects/123` + # @param [Fixnum] page_size + # Requested size of the next page of data. + # @param [String] page_token + # Token identifying which result to start with; returned by a previous list + # call. + # @param [String] view + # Specifies the level of detail for quota information in the response. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ListConsumerQuotaMetricsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ListConsumerQuotaMetricsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_service_consumer_quota_metrics(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/consumerQuotaMetrics', options) + command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ListConsumerQuotaMetricsResponse::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ListConsumerQuotaMetricsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['view'] = view unless view.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a summary of quota information for a specific quota limit. + # @param [String] name + # The resource name of the quota limit, returned by a + # ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. + # An example name would be: + # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. + # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` + # @param [String] view + # Specifies the level of detail for quota information in the response. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaLimit] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaLimit] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_service_consumer_quota_metric_limit(name, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaLimit::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaLimit + command.params['name'] = name unless name.nil? + command.query['view'] = view unless view.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a producer override. + # A producer override is applied by the owner or administrator of a service + # to increase or decrease the amount of quota a consumer of the service is + # allowed to use. + # To create multiple overrides at once, use ImportProducerOverrides instead. + # If an override with the specified dimensions already exists, this call will + # fail. To overwrite an existing override if one is already present ("upsert" + # semantics), use ImportProducerOverrides instead. + # @param [String] parent + # The resource name of the parent quota limit, returned by a + # ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. + # An example name would be: + # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. + # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` + # @param [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride] v1_beta1_quota_override_object + # @param [Boolean] force + # Whether to force the creation of the quota override. + # If creating an override would cause the effective quota for the consumer to + # decrease by more than 10 percent, the call is rejected, as a safety measure + # to avoid accidentally decreasing quota too quickly. Setting the force + # parameter to true ignores this restriction. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_service_consumer_quota_metric_limit_producer_override(parent, v1_beta1_quota_override_object = nil, force: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+parent}/producerOverrides', options) + command.request_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride::Representation + command.request_object = v1_beta1_quota_override_object + command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::Operation::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['force'] = force unless force.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a producer override. + # @param [String] name + # The resource name of the override to delete. + # An example name would be: + # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. + # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` + # @param [Boolean] force + # Whether to force the deletion of the quota override. + # If deleting an override would cause the effective quota for the consumer to + # decrease by more than 10 percent, the call is rejected, as a safety measure + # to avoid accidentally decreasing quota too quickly. Setting the force + # parameter to true ignores this restriction. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_service_consumer_quota_metric_limit_producer_override(name, force: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::Operation::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['force'] = force unless force.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all producer overrides on this limit. + # @param [String] parent + # The resource name of the parent quota limit, returned by a + # ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. + # An example name would be: + # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. + # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` + # @param [Fixnum] page_size + # Requested size of the next page of data. + # @param [String] page_token + # Token identifying which result to start with; returned by a previous list + # call. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ListProducerOverridesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ListProducerOverridesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_service_consumer_quota_metric_limit_producer_overrides(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/producerOverrides', options) + command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ListProducerOverridesResponse::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ListProducerOverridesResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a producer override. + # @param [String] name + # The resource name of the override to update. + # An example name would be: + # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute. + # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` + # @param [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride] v1_beta1_quota_override_object + # @param [Boolean] force + # Whether to force the update of the quota override. + # If updating an override would cause the effective quota for the consumer to + # decrease by more than 10 percent, the call is rejected, as a safety measure + # to avoid accidentally decreasing quota too quickly. Setting the force + # parameter to true ignores this restriction. + # @param [String] update_mask + # Update only the specified fields. If unset, all modifiable fields will be + # updated. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_service_consumer_quota_metric_limit_producer_override(name, v1_beta1_quota_override_object = nil, force: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta1/{+name}', options) + command.request_representation = Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride::Representation + command.request_object = v1_beta1_quota_override_object + command.response_representation = Google::Apis::ServiceconsumermanagementV1beta1::Operation::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['force'] = force unless force.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/servicecontrol_v1.rb b/generated/google/apis/servicecontrol_v1.rb index 769c83b64..8ac7bde58 100644 --- a/generated/google/apis/servicecontrol_v1.rb +++ b/generated/google/apis/servicecontrol_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/service-control/ module ServicecontrolV1 VERSION = 'V1' - REVISION = '20200224' + REVISION = '20200322' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicecontrol_v1/classes.rb b/generated/google/apis/servicecontrol_v1/classes.rb index 68ee5a4f4..e46e79dd5 100644 --- a/generated/google/apis/servicecontrol_v1/classes.rb +++ b/generated/google/apis/servicecontrol_v1/classes.rb @@ -660,7 +660,7 @@ module Google # @return [String] attr_accessor :service_config_id - # Unimplemented. The current service rollout id used to process the request. + # The current service rollout id used to process the request. # Corresponds to the JSON property `serviceRolloutId` # @return [String] attr_accessor :service_rollout_id @@ -1928,7 +1928,7 @@ module Google # @return [String] attr_accessor :service_config_id - # Unimplemented. The current service rollout id used to process the request. + # The current service rollout id used to process the request. # Corresponds to the JSON property `serviceRolloutId` # @return [String] attr_accessor :service_rollout_id diff --git a/generated/google/apis/cloudprivatecatalog_v1beta1.rb b/generated/google/apis/servicedirectory_v1beta1.rb similarity index 64% rename from generated/google/apis/cloudprivatecatalog_v1beta1.rb rename to generated/google/apis/servicedirectory_v1beta1.rb index accef4cb4..60ca0cffb 100644 --- a/generated/google/apis/cloudprivatecatalog_v1beta1.rb +++ b/generated/google/apis/servicedirectory_v1beta1.rb @@ -12,21 +12,21 @@ # See the License for the specific language governing permissions and # limitations under the License. -require 'google/apis/cloudprivatecatalog_v1beta1/service.rb' -require 'google/apis/cloudprivatecatalog_v1beta1/classes.rb' -require 'google/apis/cloudprivatecatalog_v1beta1/representations.rb' +require 'google/apis/servicedirectory_v1beta1/service.rb' +require 'google/apis/servicedirectory_v1beta1/classes.rb' +require 'google/apis/servicedirectory_v1beta1/representations.rb' module Google module Apis - # Cloud Private Catalog API + # Service Directory API # - # Enable cloud users to discover enterprise catalogs and products in their - # organizations. + # Service Directory is a platform for discovering, publishing, and connecting + # services. # - # @see https://cloud.google.com/private-catalog/ - module CloudprivatecatalogV1beta1 + # @see https://cloud.google.com/service-directory + module ServicedirectoryV1beta1 VERSION = 'V1beta1' - REVISION = '20200210' + REVISION = '20200312' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicedirectory_v1beta1/classes.rb b/generated/google/apis/servicedirectory_v1beta1/classes.rb new file mode 100644 index 000000000..19624f628 --- /dev/null +++ b/generated/google/apis/servicedirectory_v1beta1/classes.rb @@ -0,0 +1,800 @@ +# Copyright 2015 Google Inc. +# +# 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 ServicedirectoryV1beta1 + + # Associates `members` with a `role`. + class Binding + 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::ServicedirectoryV1beta1::Expr] + 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] + 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 + + # 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 + + # An individual endpoint that provides a + # service. The service must + # already exist to create an endpoint. + class Endpoint + include Google::Apis::Core::Hashable + + # Optional. An IPv4 or IPv6 address. Service Directory will reject bad + # addresses like: + # "8.8.8" + # "8.8.8.8:53" + # "test:bad:address" + # "[::1]" + # "[::1]:8080" + # Limited to 45 characters. + # Corresponds to the JSON property `address` + # @return [String] + attr_accessor :address + + # Optional. Metadata for the endpoint. This data can be consumed by service + # clients. The entire metadata dictionary may contain up to 512 characters, + # spread accoss all key-value pairs. Metadata that goes beyond any these + # limits will be rejected. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # Immutable. The resource name for the endpoint in the format + # 'projects/*/locations/*/namespaces/*/services/*/endpoints/*'. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Optional. Service Directory will reject values outside of [0, 65535]. + # Corresponds to the JSON property `port` + # @return [Fixnum] + attr_accessor :port + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @address = args[:address] if args.key?(:address) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + @port = args[:port] if args.key?(:port) + 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 Expr + 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 + + # Request message for `GetIamPolicy` method. + class GetIamPolicyRequest + include Google::Apis::Core::Hashable + + # Encapsulates settings provided to GetIamPolicy. + # Corresponds to the JSON property `options` + # @return [Google::Apis::ServicedirectoryV1beta1::GetPolicyOptions] + attr_accessor :options + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @options = args[:options] if args.key?(:options) + end + end + + # Encapsulates settings provided to GetIamPolicy. + class GetPolicyOptions + include Google::Apis::Core::Hashable + + # Optional. The policy format version to be returned. + # Valid values are 0, 1, and 3. Requests specifying an invalid value will be + # rejected. + # Requests for policies with any conditional bindings must specify version 3. + # Policies without any conditional bindings may specify any valid value or + # leave the field unset. + # Corresponds to the JSON property `requestedPolicyVersion` + # @return [Fixnum] + attr_accessor :requested_policy_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @requested_policy_version = args[:requested_policy_version] if args.key?(:requested_policy_version) + end + end + + # The response message for RegistrationService.ListEndpoints. + class ListEndpointsResponse + include Google::Apis::Core::Hashable + + # The list of endpoints. + # Corresponds to the JSON property `endpoints` + # @return [Array] + attr_accessor :endpoints + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # 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) + @endpoints = args[:endpoints] if args.key?(:endpoints) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # The response message for Locations.ListLocations. + class ListLocationsResponse + 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] + 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 RegistrationService.ListNamespaces. + class ListNamespacesResponse + include Google::Apis::Core::Hashable + + # The list of namespaces. + # Corresponds to the JSON property `namespaces` + # @return [Array] + attr_accessor :namespaces + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # 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) + @namespaces = args[:namespaces] if args.key?(:namespaces) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # The response message for RegistrationService.ListServices. + class ListServicesResponse + include Google::Apis::Core::Hashable + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The list of services. + # Corresponds to the JSON property `services` + # @return [Array] + attr_accessor :services + + 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) + @services = args[:services] if args.key?(:services) + end + end + + # A resource that represents Google Cloud Platform location. + class Location + 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] + 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] + 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 + + # A container for services. + # Namespaces allow administrators to group services together and define + # permissions for a collection of services. + class Namespace + include Google::Apis::Core::Hashable + + # Optional. Resource labels associated with this Namespace. + # No more than 64 user labels can be associated with a given resource. Label + # keys and values can be no longer than 63 characters. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Immutable. The resource name for the namespace in the format + # 'projects/*/locations/*/namespaces/*'. + # 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) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + 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. + # Optionally, a `binding` can 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. + # **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 Policy + include Google::Apis::Core::Hashable + + # 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] + 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. + # 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) + @bindings = args[:bindings] if args.key?(:bindings) + @etag = args[:etag] if args.key?(:etag) + @version = args[:version] if args.key?(:version) + end + end + + # The request message for LookupService.ResolveService. + # Looks up a service by its name, returns the service and its endpoints. + class ResolveServiceRequest + include Google::Apis::Core::Hashable + + # Optional. The filter applied to the endpoints of the resolved service. + # General filter string syntax: + # () + # can be "name" or "metadata." for map field. + # can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS and is + # roughly the same as "=". + # must be the same data type as the field. + # can be "AND, OR, NOT". + # Examples of valid filters: + # * "metadata.owner" returns Endpoints that have a label with the + # key "owner", this is the same as "metadata:owner" + # * "metadata.protocol=gRPC" returns Endpoints that have key/value + # "protocol=gRPC" + # * "metadata.owner!=sd AND metadata.foo=bar" returns + # Endpoints that have "owner" field in metadata with a value that is not + # "sd" AND have the key/value foo=bar. + # Corresponds to the JSON property `endpointFilter` + # @return [String] + attr_accessor :endpoint_filter + + # Optional. The maximum number of endpoints to return. Defaults to 25. Maximum + # is 100. + # If a value less than one is specified, the Default is used. + # If a value greater than the Maximum is specified, the Maximum is used. + # Corresponds to the JSON property `maxEndpoints` + # @return [Fixnum] + attr_accessor :max_endpoints + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @endpoint_filter = args[:endpoint_filter] if args.key?(:endpoint_filter) + @max_endpoints = args[:max_endpoints] if args.key?(:max_endpoints) + end + end + + # The response message for LookupService.ResolveService. + class ResolveServiceResponse + include Google::Apis::Core::Hashable + + # An individual service. A service contains a name and optional metadata. + # A service must exist before + # endpoints can be + # added to it. + # Corresponds to the JSON property `service` + # @return [Google::Apis::ServicedirectoryV1beta1::Service] + attr_accessor :service + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @service = args[:service] if args.key?(:service) + end + end + + # An individual service. A service contains a name and optional metadata. + # A service must exist before + # endpoints can be + # added to it. + class Service + include Google::Apis::Core::Hashable + + # Output only. Endpoints associated with this service. Returned on LookupService. + # Resolve. + # Control plane clients should use RegistrationService.ListEndpoints. + # Corresponds to the JSON property `endpoints` + # @return [Array] + attr_accessor :endpoints + + # Optional. Metadata for the service. This data can be consumed by service + # clients. The entire metadata dictionary may contain up to 2000 characters, + # spread across all key-value pairs. Metadata that goes beyond any these + # limits will be rejected. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # Immutable. The resource name for the service in the format + # 'projects/*/locations/*/namespaces/*/services/*'. + # 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) + @endpoints = args[:endpoints] if args.key?(:endpoints) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + end + end + + # Request message for `SetIamPolicy` method. + class SetIamPolicyRequest + 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. + # Optionally, a `binding` can 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. + # **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::ServicedirectoryV1beta1::Policy] + attr_accessor :policy + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @policy = args[:policy] if args.key?(:policy) + end + end + + # Request message for `TestIamPermissions` method. + class TestIamPermissionsRequest + 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] + 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 TestIamPermissionsResponse + include Google::Apis::Core::Hashable + + # A subset of `TestPermissionsRequest.permissions` that the caller is + # allowed. + # Corresponds to the JSON property `permissions` + # @return [Array] + 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 + end + end +end diff --git a/generated/google/apis/servicedirectory_v1beta1/representations.rb b/generated/google/apis/servicedirectory_v1beta1/representations.rb new file mode 100644 index 000000000..4155c43a9 --- /dev/null +++ b/generated/google/apis/servicedirectory_v1beta1/representations.rb @@ -0,0 +1,304 @@ +# Copyright 2015 Google Inc. +# +# 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 ServicedirectoryV1beta1 + + class Binding + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Endpoint + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Expr + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GetIamPolicyRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GetPolicyOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListEndpointsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListLocationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListNamespacesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListServicesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Location + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Namespace + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Policy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ResolveServiceRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ResolveServiceResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Service + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SetIamPolicyRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TestIamPermissionsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TestIamPermissionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Binding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :condition, as: 'condition', class: Google::Apis::ServicedirectoryV1beta1::Expr, decorator: Google::Apis::ServicedirectoryV1beta1::Expr::Representation + + collection :members, as: 'members' + property :role, as: 'role' + end + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class Endpoint + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :address, as: 'address' + hash :metadata, as: 'metadata' + property :name, as: 'name' + property :port, as: 'port' + end + end + + class Expr + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :expression, as: 'expression' + property :location, as: 'location' + property :title, as: 'title' + end + end + + class GetIamPolicyRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :options, as: 'options', class: Google::Apis::ServicedirectoryV1beta1::GetPolicyOptions, decorator: Google::Apis::ServicedirectoryV1beta1::GetPolicyOptions::Representation + + end + end + + class GetPolicyOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :requested_policy_version, as: 'requestedPolicyVersion' + end + end + + class ListEndpointsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :endpoints, as: 'endpoints', class: Google::Apis::ServicedirectoryV1beta1::Endpoint, decorator: Google::Apis::ServicedirectoryV1beta1::Endpoint::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListLocationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :locations, as: 'locations', class: Google::Apis::ServicedirectoryV1beta1::Location, decorator: Google::Apis::ServicedirectoryV1beta1::Location::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListNamespacesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :namespaces, as: 'namespaces', class: Google::Apis::ServicedirectoryV1beta1::Namespace, decorator: Google::Apis::ServicedirectoryV1beta1::Namespace::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListServicesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :services, as: 'services', class: Google::Apis::ServicedirectoryV1beta1::Service, decorator: Google::Apis::ServicedirectoryV1beta1::Service::Representation + + end + end + + class Location + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + hash :labels, as: 'labels' + property :location_id, as: 'locationId' + hash :metadata, as: 'metadata' + property :name, as: 'name' + end + end + + class Namespace + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :labels, as: 'labels' + property :name, as: 'name' + end + end + + class Policy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :bindings, as: 'bindings', class: Google::Apis::ServicedirectoryV1beta1::Binding, decorator: Google::Apis::ServicedirectoryV1beta1::Binding::Representation + + property :etag, :base64 => true, as: 'etag' + property :version, as: 'version' + end + end + + class ResolveServiceRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :endpoint_filter, as: 'endpointFilter' + property :max_endpoints, as: 'maxEndpoints' + end + end + + class ResolveServiceResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :service, as: 'service', class: Google::Apis::ServicedirectoryV1beta1::Service, decorator: Google::Apis::ServicedirectoryV1beta1::Service::Representation + + end + end + + class Service + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :endpoints, as: 'endpoints', class: Google::Apis::ServicedirectoryV1beta1::Endpoint, decorator: Google::Apis::ServicedirectoryV1beta1::Endpoint::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + end + end + + class SetIamPolicyRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :policy, as: 'policy', class: Google::Apis::ServicedirectoryV1beta1::Policy, decorator: Google::Apis::ServicedirectoryV1beta1::Policy::Representation + + end + end + + class TestIamPermissionsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class TestIamPermissionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + end + end +end diff --git a/generated/google/apis/servicedirectory_v1beta1/service.rb b/generated/google/apis/servicedirectory_v1beta1/service.rb new file mode 100644 index 000000000..de0c23193 --- /dev/null +++ b/generated/google/apis/servicedirectory_v1beta1/service.rb @@ -0,0 +1,992 @@ +# Copyright 2015 Google Inc. +# +# 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 '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 ServicedirectoryV1beta1 + # Service Directory API + # + # Service Directory is a platform for discovering, publishing, and connecting + # services. + # + # @example + # require 'google/apis/servicedirectory_v1beta1' + # + # Servicedirectory = Google::Apis::ServicedirectoryV1beta1 # Alias the module + # service = Servicedirectory::ServiceDirectoryService.new + # + # @see https://cloud.google.com/service-directory + class ServiceDirectoryService < Google::Apis::Core::BaseService + # @return [String] + # API key. Your API key identifies your project and provides you with API access, + # quota, and reports. Required unless you provide an OAuth 2.0 token. + attr_accessor :key + + # @return [String] + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + attr_accessor :quota_user + + def initialize + super('https://servicedirectory.googleapis.com/', '') + @batch_path = 'batch' + end + + # Gets information about a location. + # @param [String] name + # Resource name for the location. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::Location] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::Location] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::ServicedirectoryV1beta1::Location::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::Location + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists information about the supported locations for this service. + # @param [String] name + # The resource that owns the locations collection, if applicable. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::ListLocationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::ListLocationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}/locations', options) + command.response_representation = Google::Apis::ServicedirectoryV1beta1::ListLocationsResponse::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::ListLocationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a namespace, and returns the new Namespace. + # @param [String] parent + # Required. The resource name of the project and location the namespace + # will be created in. + # @param [Google::Apis::ServicedirectoryV1beta1::Namespace] namespace_object + # @param [String] namespace_id + # Required. The Resource ID must be 1-63 characters long, and comply with + # RFC1035. + # Specifically, the name must be 1-63 characters long and match the regular + # expression `[a-z](?:[-a-z0-9]`0,61`[a-z0-9])?` which means the first + # character must be a lowercase letter, and all following characters must + # be a dash, lowercase letter, or digit, except the last character, which + # cannot be a dash. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::Namespace] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::Namespace] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_namespace(parent, namespace_object = nil, namespace_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+parent}/namespaces', options) + command.request_representation = Google::Apis::ServicedirectoryV1beta1::Namespace::Representation + command.request_object = namespace_object + command.response_representation = Google::Apis::ServicedirectoryV1beta1::Namespace::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::Namespace + command.params['parent'] = parent unless parent.nil? + command.query['namespaceId'] = namespace_id unless namespace_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a namespace. This also deletes all services and endpoints in + # the namespace. + # @param [String] name + # Required. The name of the namespace to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_namespace(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::ServicedirectoryV1beta1::Empty::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a namespace. + # @param [String] name + # Required. The name of the namespace to retrieve. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::Namespace] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::Namespace] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_namespace(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::ServicedirectoryV1beta1::Namespace::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::Namespace + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the IAM Policy for a resource (namespace or service only). + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::ServicedirectoryV1beta1::GetIamPolicyRequest] get_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_namespace_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+resource}:getIamPolicy', options) + command.request_representation = Google::Apis::ServicedirectoryV1beta1::GetIamPolicyRequest::Representation + command.request_object = get_iam_policy_request_object + command.response_representation = Google::Apis::ServicedirectoryV1beta1::Policy::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all namespaces. + # @param [String] parent + # Required. The resource name of the project and location whose namespaces we'd + # like to + # list. + # @param [String] filter + # Optional. The filter to list result by. + # General filter string syntax: + # () + # can be "name", or "labels." for map field. + # can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and + # is roughly the same as "=". + # must be the same data type as field. + # can be "AND, OR, NOT". + # Examples of valid filters: + # * "labels.owner" returns Namespaces that have a label with the key "owner" + # this is the same as "labels:owner". + # * "labels.protocol=gRPC" returns Namespaces that have key/value + # "protocol=gRPC". + # * "name>projects/my-project/locations/us-east/namespaces/namespace-c" + # returns Namespaces that have name that is alphabetically later than the + # string, so "namespace-e" will be returned but "namespace-a" will not be. + # * "labels.owner!=sd AND labels.foo=bar" returns Namespaces that have + # "owner" in label key but value is not "sd" AND have key/value foo=bar. + # * "doesnotexist.foo=bar" returns an empty list. Note that Namespace doesn't + # have a field called "doesnotexist". Since the filter does not match any + # Namespaces, it returns no results. + # @param [String] order_by + # Optional. The order to list result by. + # General order by string syntax: + # () (,) + # allows values `"name"` + # ascending or descending order by . If this is left + # blank, "asc" is used. + # Note that an empty order_by string result in default order, which is order + # by name in ascending order. + # @param [Fixnum] page_size + # Optional. The maximum number of items to return. + # @param [String] page_token + # Optional. The next_page_token value returned from a previous List request, if + # any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::ListNamespacesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::ListNamespacesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_namespaces(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/namespaces', options) + command.response_representation = Google::Apis::ServicedirectoryV1beta1::ListNamespacesResponse::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::ListNamespacesResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a namespace. + # @param [String] name + # Immutable. The resource name for the namespace in the format + # 'projects/*/locations/*/namespaces/*'. + # @param [Google::Apis::ServicedirectoryV1beta1::Namespace] namespace_object + # @param [String] update_mask + # Required. List of fields to be updated in this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::Namespace] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::Namespace] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_namespace(name, namespace_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta1/{+name}', options) + command.request_representation = Google::Apis::ServicedirectoryV1beta1::Namespace::Representation + command.request_object = namespace_object + command.response_representation = Google::Apis::ServicedirectoryV1beta1::Namespace::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::Namespace + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the IAM Policy for a resource (namespace or service only). + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::ServicedirectoryV1beta1::SetIamPolicyRequest] set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_namespace_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::ServicedirectoryV1beta1::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::ServicedirectoryV1beta1::Policy::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Tests IAM permissions for a resource (namespace or service only). + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::ServicedirectoryV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_namespace_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::ServicedirectoryV1beta1::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::ServicedirectoryV1beta1::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a service, and returns the new Service. + # @param [String] parent + # Required. The resource name of the namespace this service will belong to. + # @param [Google::Apis::ServicedirectoryV1beta1::Service] service_object + # @param [String] service_id + # Required. The Resource ID must be 1-63 characters long, and comply with + # RFC1035. + # Specifically, the name must be 1-63 characters long and match the regular + # expression `[a-z](?:[-a-z0-9]`0,61`[a-z0-9])?` which means the first + # character must be a lowercase letter, and all following characters must + # be a dash, lowercase letter, or digit, except the last character, which + # cannot be a dash. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::Service] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::Service] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_namespace_service(parent, service_object = nil, service_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+parent}/services', options) + command.request_representation = Google::Apis::ServicedirectoryV1beta1::Service::Representation + command.request_object = service_object + command.response_representation = Google::Apis::ServicedirectoryV1beta1::Service::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::Service + command.params['parent'] = parent unless parent.nil? + command.query['serviceId'] = service_id unless service_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a service. This also deletes all endpoints associated with + # the service. + # @param [String] name + # Required. The name of the service to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_namespace_service(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::ServicedirectoryV1beta1::Empty::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a service. + # @param [String] name + # Required. The name of the service to get. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::Service] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::Service] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_namespace_service(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::ServicedirectoryV1beta1::Service::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::Service + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the IAM Policy for a resource (namespace or service only). + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::ServicedirectoryV1beta1::GetIamPolicyRequest] get_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_service_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+resource}:getIamPolicy', options) + command.request_representation = Google::Apis::ServicedirectoryV1beta1::GetIamPolicyRequest::Representation + command.request_object = get_iam_policy_request_object + command.response_representation = Google::Apis::ServicedirectoryV1beta1::Policy::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all services belonging to a namespace. + # @param [String] parent + # Required. The resource name of the namespace whose services we'd + # like to list. + # @param [String] filter + # Optional. The filter to list result by. + # General filter string syntax: + # () + # can be "name", or "metadata." for map field. + # can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and + # is roughly the same as "=". + # must be the same data type as field. + # can be "AND, OR, NOT". + # Examples of valid filters: + # * "metadata.owner" returns Services that have a label with the key "owner" + # this is the same as "metadata:owner". + # * "metadata.protocol=gRPC" returns Services that have key/value + # "protocol=gRPC". + # * "name>projects/my-project/locations/us-east/namespaces/my-namespace/services/ + # service-c" + # returns Services that have name that is alphabetically later than the + # string, so "service-e" will be returned but "service-a" will not be. + # * "metadata.owner!=sd AND metadata.foo=bar" returns Services that have + # "owner" in label key but value is not "sd" AND have key/value foo=bar. + # * "doesnotexist.foo=bar" returns an empty list. Note that Service doesn't + # have a field called "doesnotexist". Since the filter does not match any + # Services, it returns no results. + # @param [String] order_by + # Optional. The order to list result by. + # @param [Fixnum] page_size + # Optional. The maximum number of items to return. + # @param [String] page_token + # Optional. The next_page_token value returned from a previous List request, + # if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::ListServicesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::ListServicesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_namespace_services(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/services', options) + command.response_representation = Google::Apis::ServicedirectoryV1beta1::ListServicesResponse::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::ListServicesResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a service. + # @param [String] name + # Immutable. The resource name for the service in the format + # 'projects/*/locations/*/namespaces/*/services/*'. + # @param [Google::Apis::ServicedirectoryV1beta1::Service] service_object + # @param [String] update_mask + # Required. List of fields to be updated in this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::Service] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::Service] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_namespace_service(name, service_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta1/{+name}', options) + command.request_representation = Google::Apis::ServicedirectoryV1beta1::Service::Representation + command.request_object = service_object + command.response_representation = Google::Apis::ServicedirectoryV1beta1::Service::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::Service + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns a service and its + # associated endpoints. + # Resolving a service is not considered an active developer method. + # @param [String] name + # Required. The name of the service to resolve. + # @param [Google::Apis::ServicedirectoryV1beta1::ResolveServiceRequest] resolve_service_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::ResolveServiceResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::ResolveServiceResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def resolve_service(name, resolve_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+name}:resolve', options) + command.request_representation = Google::Apis::ServicedirectoryV1beta1::ResolveServiceRequest::Representation + command.request_object = resolve_service_request_object + command.response_representation = Google::Apis::ServicedirectoryV1beta1::ResolveServiceResponse::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::ResolveServiceResponse + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the IAM Policy for a resource (namespace or service only). + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::ServicedirectoryV1beta1::SetIamPolicyRequest] set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_service_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::ServicedirectoryV1beta1::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::ServicedirectoryV1beta1::Policy::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Tests IAM permissions for a resource (namespace or service only). + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::ServicedirectoryV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_service_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::ServicedirectoryV1beta1::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::ServicedirectoryV1beta1::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a endpoint, and returns the new Endpoint. + # @param [String] parent + # Required. The resource name of the service that this endpoint provides. + # @param [Google::Apis::ServicedirectoryV1beta1::Endpoint] endpoint_object + # @param [String] endpoint_id + # Required. The Resource ID must be 1-63 characters long, and comply with + # RFC1035. + # Specifically, the name must be 1-63 characters long and match the regular + # expression `[a-z](?:[-a-z0-9]`0,61`[a-z0-9])?` which means the first + # character must be a lowercase letter, and all following characters must + # be a dash, lowercase letter, or digit, except the last character, which + # cannot be a dash. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::Endpoint] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::Endpoint] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_namespace_service_endpoint(parent, endpoint_object = nil, endpoint_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+parent}/endpoints', options) + command.request_representation = Google::Apis::ServicedirectoryV1beta1::Endpoint::Representation + command.request_object = endpoint_object + command.response_representation = Google::Apis::ServicedirectoryV1beta1::Endpoint::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::Endpoint + command.params['parent'] = parent unless parent.nil? + command.query['endpointId'] = endpoint_id unless endpoint_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a endpoint. + # @param [String] name + # Required. The name of the endpoint to delete. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_namespace_service_endpoint(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::ServicedirectoryV1beta1::Empty::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a endpoint. + # @param [String] name + # Required. The name of the endpoint to get. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::Endpoint] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::Endpoint] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_namespace_service_endpoint(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::ServicedirectoryV1beta1::Endpoint::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::Endpoint + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all endpoints. + # @param [String] parent + # Required. The resource name of the service whose endpoints we'd like to + # list. + # @param [String] filter + # Optional. The filter to list result by. + # General filter string syntax: + # () + # can be "name", "address", "port" or "metadata." for map field. + # can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and + # is roughly the same as "=". + # must be the same data type as field. + # can be "AND, OR, NOT". + # Examples of valid filters: + # * "metadata.owner" returns Endpoints that have a label with the key "owner" + # this is the same as "metadata:owner". + # * "metadata.protocol=gRPC" returns Endpoints that have key/value + # "protocol=gRPC". + # * "address=192.108.1.105" returns Endpoints that have this address. + # * "port>8080" returns Endpoints that have port number larger than 8080. + # * "name>projects/my-project/locations/us-east/namespaces/my-namespace/services/ + # my-service/endpoints/endpoint-c" + # returns Endpoints that have name that is alphabetically later than the + # string, so "endpoint-e" will be returned but "endpoint-a" will not be. + # * "metadata.owner!=sd AND metadata.foo=bar" returns Endpoints that have + # "owner" in label key but value is not "sd" AND have key/value foo=bar. + # * "doesnotexist.foo=bar" returns an empty list. Note that Endpoint doesn't + # have a field called "doesnotexist". Since the filter does not match any + # Endpoints, it returns no results. + # @param [String] order_by + # Optional. The order to list result by. + # @param [Fixnum] page_size + # Optional. The maximum number of items to return. + # @param [String] page_token + # Optional. The next_page_token value returned from a previous List request, + # if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::ListEndpointsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::ListEndpointsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_namespace_service_endpoints(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/endpoints', options) + command.response_representation = Google::Apis::ServicedirectoryV1beta1::ListEndpointsResponse::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::ListEndpointsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a endpoint. + # @param [String] name + # Immutable. The resource name for the endpoint in the format + # 'projects/*/locations/*/namespaces/*/services/*/endpoints/*'. + # @param [Google::Apis::ServicedirectoryV1beta1::Endpoint] endpoint_object + # @param [String] update_mask + # Required. List of fields to be updated in this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicedirectoryV1beta1::Endpoint] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicedirectoryV1beta1::Endpoint] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_namespace_service_endpoint(name, endpoint_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1beta1/{+name}', options) + command.request_representation = Google::Apis::ServicedirectoryV1beta1::Endpoint::Representation + command.request_object = endpoint_object + command.response_representation = Google::Apis::ServicedirectoryV1beta1::Endpoint::Representation + command.response_class = Google::Apis::ServicedirectoryV1beta1::Endpoint + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/servicemanagement_v1.rb b/generated/google/apis/servicemanagement_v1.rb index 2bb48babc..a182d2faf 100644 --- a/generated/google/apis/servicemanagement_v1.rb +++ b/generated/google/apis/servicemanagement_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/service-management/ module ServicemanagementV1 VERSION = 'V1' - REVISION = '20200228' + REVISION = '20200406' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicemanagement_v1/classes.rb b/generated/google/apis/servicemanagement_v1/classes.rb index dcf484ace..bdb4993c7 100644 --- a/generated/google/apis/servicemanagement_v1/classes.rb +++ b/generated/google/apis/servicemanagement_v1/classes.rb @@ -249,12 +249,16 @@ module Google # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# # section-4.1.3). # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, only JWTs with audience - # "https://Service_name/API_name" - # will be accepted. For example, if no audiences are in the setting, - # LibraryService API will only accept JWTs with the following audience - # "https://library-example.googleapis.com/google.example.library.v1. - # LibraryService". + # be accepted. When this setting is absent, JWTs with audiences: + # - "https://[service.name]/[google.protobuf.Api.name]" + # - "https://[service.name]/" + # will be accepted. + # For example, if no audiences are in the setting, LibraryService API will + # accept JWTs with the following audiences: + # - + # https://library-example.googleapis.com/google.example.library.v1. + # LibraryService + # - https://library-example.googleapis.com/ # Example: # audiences: bookstore_android.apps.googleusercontent.com, # bookstore_web.apps.googleusercontent.com @@ -574,6 +578,36 @@ module Google # @return [String] attr_accessor :protocol + # Unimplemented. Do not use. + # The new name the selected proto elements should be renamed to. + # The package, the service and the method can all be renamed. + # The backend server should implement the renamed proto. However, clients + # should call the original method, and ESF routes the traffic to the renamed + # method. + # HTTP clients should call the URL mapped to the original method. + # gRPC and Stubby clients should call the original method with package name. + # For legacy reasons, ESF allows Stubby clients to call with the + # short name (without the package name). However, for API Versioning(or + # multiple methods mapped to the same short name), all Stubby clients must + # call the method's full name with the package name, otherwise the first one + # (selector) wins. + # If this `rename_to` is specified with a trailing `*`, the `selector` must + # be specified with a trailing `*` as well. The all element short names + # matched by the `*` in the selector will be kept in the `rename_to`. + # For example, + # rename_rules: + # - selector: |- + # google.example.library.v1.* + # rename_to: google.example.library.* + # The selector matches `google.example.library.v1.Library.CreateShelf` and + # `google.example.library.v1.Library.CreateBook`, they will be renamed to + # `google.example.library.Library.CreateShelf` and + # `google.example.library.Library.CreateBook`. It essentially renames the + # proto package name section of the matched proto service and methods. + # Corresponds to the JSON property `renameTo` + # @return [String] + attr_accessor :rename_to + # Selects the methods to which this rule applies. # Refer to selector for syntax details. # Corresponds to the JSON property `selector` @@ -594,6 +628,7 @@ module Google @operation_deadline = args[:operation_deadline] if args.key?(:operation_deadline) @path_translation = args[:path_translation] if args.key?(:path_translation) @protocol = args[:protocol] if args.key?(:protocol) + @rename_to = args[:rename_to] if args.key?(:rename_to) @selector = args[:selector] if args.key?(:selector) end end diff --git a/generated/google/apis/servicemanagement_v1/representations.rb b/generated/google/apis/servicemanagement_v1/representations.rb index 51e411ed2..5ec848a64 100644 --- a/generated/google/apis/servicemanagement_v1/representations.rb +++ b/generated/google/apis/servicemanagement_v1/representations.rb @@ -665,6 +665,7 @@ module Google property :operation_deadline, as: 'operationDeadline' property :path_translation, as: 'pathTranslation' property :protocol, as: 'protocol' + property :rename_to, as: 'renameTo' property :selector, as: 'selector' end end diff --git a/generated/google/apis/servicenetworking_v1.rb b/generated/google/apis/servicenetworking_v1.rb index b6146f394..6f14715c3 100644 --- a/generated/google/apis/servicenetworking_v1.rb +++ b/generated/google/apis/servicenetworking_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started module ServicenetworkingV1 VERSION = 'V1' - REVISION = '20200305' + REVISION = '20200408' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicenetworking_v1/classes.rb b/generated/google/apis/servicenetworking_v1/classes.rb index 1a812dbf7..294ee5fdf 100644 --- a/generated/google/apis/servicenetworking_v1/classes.rb +++ b/generated/google/apis/servicenetworking_v1/classes.rb @@ -22,6 +22,70 @@ module Google module Apis module ServicenetworkingV1 + # Metadata provided through GetOperation request for the LRO generated by + # AddRoles API + class AddRolesMetadata + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Request for AddRoles to allow Service Producers to add roles in the shared + # VPC host project for them to use. + class AddRolesRequest + include Google::Apis::Core::Hashable + + # Required. The network that the consumer is using to connect with services. + # Must be in + # the form of projects/`project`/global/networks/`network` + # `project` is a project number, as in '12345' + # `network` is a network name. + # Corresponds to the JSON property `consumerNetwork` + # @return [String] + attr_accessor :consumer_network + + # Required. List of policy bindings to add to shared VPC host project. + # Corresponds to the JSON property `policyBinding` + # @return [Array] + attr_accessor :policy_binding + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @consumer_network = args[:consumer_network] if args.key?(:consumer_network) + @policy_binding = args[:policy_binding] if args.key?(:policy_binding) + end + end + + # Represents IAM roles added to the shared VPC host project. + class AddRolesResponse + include Google::Apis::Core::Hashable + + # Required. List of policy bindings that were added to the shared VPC host + # project. + # Corresponds to the JSON property `policyBinding` + # @return [Array] + attr_accessor :policy_binding + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @policy_binding = args[:policy_binding] if args.key?(:policy_binding) + end + end + # Request to create a subnetwork in a previously peered service network. class AddSubnetworkRequest include Google::Apis::Core::Hashable @@ -202,12 +266,16 @@ module Google # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# # section-4.1.3). # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, only JWTs with audience - # "https://Service_name/API_name" - # will be accepted. For example, if no audiences are in the setting, - # LibraryService API will only accept JWTs with the following audience - # "https://library-example.googleapis.com/google.example.library.v1. - # LibraryService". + # be accepted. When this setting is absent, JWTs with audiences: + # - "https://[service.name]/[google.protobuf.Api.name]" + # - "https://[service.name]/" + # will be accepted. + # For example, if no audiences are in the setting, LibraryService API will + # accept JWTs with the following audiences: + # - + # https://library-example.googleapis.com/google.example.library.v1. + # LibraryService + # - https://library-example.googleapis.com/ # Example: # audiences: bookstore_android.apps.googleusercontent.com, # bookstore_web.apps.googleusercontent.com @@ -527,6 +595,36 @@ module Google # @return [String] attr_accessor :protocol + # Unimplemented. Do not use. + # The new name the selected proto elements should be renamed to. + # The package, the service and the method can all be renamed. + # The backend server should implement the renamed proto. However, clients + # should call the original method, and ESF routes the traffic to the renamed + # method. + # HTTP clients should call the URL mapped to the original method. + # gRPC and Stubby clients should call the original method with package name. + # For legacy reasons, ESF allows Stubby clients to call with the + # short name (without the package name). However, for API Versioning(or + # multiple methods mapped to the same short name), all Stubby clients must + # call the method's full name with the package name, otherwise the first one + # (selector) wins. + # If this `rename_to` is specified with a trailing `*`, the `selector` must + # be specified with a trailing `*` as well. The all element short names + # matched by the `*` in the selector will be kept in the `rename_to`. + # For example, + # rename_rules: + # - selector: |- + # google.example.library.v1.* + # rename_to: google.example.library.* + # The selector matches `google.example.library.v1.Library.CreateShelf` and + # `google.example.library.v1.Library.CreateBook`, they will be renamed to + # `google.example.library.Library.CreateShelf` and + # `google.example.library.Library.CreateBook`. It essentially renames the + # proto package name section of the matched proto service and methods. + # Corresponds to the JSON property `renameTo` + # @return [String] + attr_accessor :rename_to + # Selects the methods to which this rule applies. # Refer to selector for syntax details. # Corresponds to the JSON property `selector` @@ -547,6 +645,7 @@ module Google @operation_deadline = args[:operation_deadline] if args.key?(:operation_deadline) @path_translation = args[:path_translation] if args.key?(:path_translation) @protocol = args[:protocol] if args.key?(:protocol) + @rename_to = args[:rename_to] if args.key?(:rename_to) @selector = args[:selector] if args.key?(:selector) end end @@ -2725,6 +2824,38 @@ module Google end end + # Grouping of IAM role and IAM member. + class PolicyBinding + include Google::Apis::Core::Hashable + + # Required. Member to bind the role with. See + # /iam/docs/reference/rest/v1/Policy#Binding for how to format each member. + # Eg. + # - user:myuser@mydomain.com + # - serviceAccount:my-service-account@app.gserviceaccount.com + # Corresponds to the JSON property `member` + # @return [String] + attr_accessor :member + + # Required. Role to apply. Only whitelisted roles can be used at the specified + # granularity. The role must be one of the following: + # - 'roles/container.hostServiceAgentUser' applied on the shared VPC host + # project + # 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) + @member = args[:member] if args.key?(:member) + @role = args[:role] if args.key?(:role) + end + end + # Quota configuration helps to achieve fairness and budgeting in service # usage. # The metric based quota configuration works this way: @@ -2964,6 +3095,48 @@ module Google end end + # Represents a route that was created or discovered by a private access + # management service. + class Route + include Google::Apis::Core::Hashable + + # Destination CIDR range that this route applies to. + # Corresponds to the JSON property `destRange` + # @return [String] + attr_accessor :dest_range + + # Route name. See https://cloud.google.com/vpc/docs/routes + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Fully-qualified URL of the VPC network in the producer host tenant project + # that this route applies to. For example: + # `projects/123456/global/networks/host-network` + # Corresponds to the JSON property `network` + # @return [String] + attr_accessor :network + + # Fully-qualified URL of the gateway that should handle matching packets that + # this route applies to. For example: + # `projects/123456/global/gateways/default-internet-gateway` + # Corresponds to the JSON property `nextHopGateway` + # @return [String] + attr_accessor :next_hop_gateway + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dest_range = args[:dest_range] if args.key?(:dest_range) + @name = args[:name] if args.key?(:name) + @network = args[:network] if args.key?(:network) + @next_hop_gateway = args[:next_hop_gateway] if args.key?(:next_hop_gateway) + end + end + # Request to search for an unused range within allocated ranges. class SearchRangeRequest include Google::Apis::Core::Hashable diff --git a/generated/google/apis/servicenetworking_v1/representations.rb b/generated/google/apis/servicenetworking_v1/representations.rb index 14fa2343f..0038590de 100644 --- a/generated/google/apis/servicenetworking_v1/representations.rb +++ b/generated/google/apis/servicenetworking_v1/representations.rb @@ -22,6 +22,24 @@ module Google module Apis module ServicenetworkingV1 + class AddRolesMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AddRolesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AddRolesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class AddSubnetworkRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -322,6 +340,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class PolicyBinding + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Quota class Representation < Google::Apis::Core::JsonRepresentation; end @@ -346,6 +370,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Route + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SearchRangeRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -436,6 +466,29 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class AddRolesMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class AddRolesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :consumer_network, as: 'consumerNetwork' + collection :policy_binding, as: 'policyBinding', class: Google::Apis::ServicenetworkingV1::PolicyBinding, decorator: Google::Apis::ServicenetworkingV1::PolicyBinding::Representation + + end + end + + class AddRolesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :policy_binding, as: 'policyBinding', class: Google::Apis::ServicenetworkingV1::PolicyBinding, decorator: Google::Apis::ServicenetworkingV1::PolicyBinding::Representation + + end + end + class AddSubnetworkRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -530,6 +583,7 @@ module Google property :operation_deadline, as: 'operationDeadline' property :path_translation, as: 'pathTranslation' property :protocol, as: 'protocol' + property :rename_to, as: 'renameTo' property :selector, as: 'selector' end end @@ -947,6 +1001,14 @@ module Google end end + class PolicyBinding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :member, as: 'member' + property :role, as: 'role' + end + end + class Quota # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -989,6 +1051,16 @@ module Google end end + class Route + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dest_range, as: 'destRange' + property :name, as: 'name' + property :network, as: 'network' + property :next_hop_gateway, as: 'nextHopGateway' + end + end + class SearchRangeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/servicenetworking_v1/service.rb b/generated/google/apis/servicenetworking_v1/service.rb index 73d8e92e3..1e76f3aa6 100644 --- a/generated/google/apis/servicenetworking_v1/service.rb +++ b/generated/google/apis/servicenetworking_v1/service.rb @@ -202,15 +202,14 @@ module Google execute_or_queue_command(command, &block) end - # For service producers, provisions a new subnet in a - # peered service's shared VPC network in the requested region and with the - # requested size that's expressed as a CIDR range (number of leading bits of - # ipV4 network mask). The method checks against the assigned allocated ranges - # to find a non-conflicting IP address range. The method will reuse a subnet - # if subsequent calls contain the same subnet name, region, and prefix - # length. This method will make producer's tenant project to be a shared VPC - # service project as needed. The response from the `get` operation will be of - # type `Subnetwork` if the operation successfully completes. + # For service producers, provisions a new subnet in a peered service's shared + # VPC network in the requested region and with the requested size that's + # expressed as a CIDR range (number of leading bits of ipV4 network mask). + # The method checks against the assigned allocated ranges to find a + # non-conflicting IP address range. The method will reuse a subnet if + # subsequent calls contain the same subnet name, region, and prefix length. + # This method will make producer's tenant project to be a shared VPC service + # project as needed. # @param [String] parent # Required. A tenant project in the service producer organization, in the # following format: services/`service`/`collection-id`/`resource-id`. @@ -321,13 +320,11 @@ module Google end # Service producers can use this method to find a currently unused range - # within consumer allocated ranges. This returned range is not reserved, - # and not guaranteed to remain unused. - # It will validate previously provided allocated ranges, find - # non-conflicting sub-range of requested size (expressed in - # number of leading bits of ipv4 network mask, as in CIDR range + # within consumer allocated ranges. This returned range is not reserved, + # and not guaranteed to remain unused. It will validate previously provided + # allocated ranges, find non-conflicting sub-range of requested size + # (expressed in number of leading bits of ipv4 network mask, as in CIDR range # notation). - # Operation # @param [String] parent # Required. This is in a form services/`service`. `service` the name of the # private @@ -363,7 +360,7 @@ module Google end # Service producers use this method to validate if the consumer provided - # network, project and the requested range is valid. This allows them to use + # network, project and requested range are valid. This allows them to use # a fail-fast mechanism for consumer requests, and not have to wait for # AddSubnetwork operation completion to determine if user request is invalid. # @param [String] parent @@ -407,9 +404,7 @@ module Google # method. The administrator must assign one or more allocated IP ranges for # provisioning subnetworks in the service producer's VPC network. This # connection is used for all supported services in the service producer's - # organization, so it only needs to be invoked once. The response from the - # `get` operation will be of type `Connection` if the operation successfully - # completes. + # organization, so it only needs to be invoked once. # @param [String] parent # The service that is managing peering connectivity for a service producer's # organization. For Google services that support this functionality, this @@ -489,8 +484,6 @@ module Google end # Updates the allocated ranges that are assigned to a connection. - # The response from the `get` operation will be of type `Connection` if the - # operation successfully completes. # @param [String] name # The private service connection that connects to a service producer # organization. The name includes both the private service name and the VPC @@ -536,6 +529,45 @@ module Google command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end + + # Service producers can use this method to add roles in the shared VPC host + # project. Each role is bound to the provided member. Each role must be + # selected from within a whitelisted set of roles. Each role is applied at + # only the granularity specified in the whitelist. + # @param [String] parent + # Required. This is in a form services/`service` where `service` is the name of + # the + # private access management service. For example + # 'service-peering.example.com'. + # @param [Google::Apis::ServicenetworkingV1::AddRolesRequest] add_roles_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServicenetworkingV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServicenetworkingV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def add_roles(parent, add_roles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/roles:add', options) + command.request_representation = Google::Apis::ServicenetworkingV1::AddRolesRequest::Representation + command.request_object = add_roles_request_object + command.response_representation = Google::Apis::ServicenetworkingV1::Operation::Representation + command.response_class = Google::Apis::ServicenetworkingV1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end protected diff --git a/generated/google/apis/servicenetworking_v1beta.rb b/generated/google/apis/servicenetworking_v1beta.rb index 7e553960f..db9365a81 100644 --- a/generated/google/apis/servicenetworking_v1beta.rb +++ b/generated/google/apis/servicenetworking_v1beta.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started module ServicenetworkingV1beta VERSION = 'V1beta' - REVISION = '20200305' + REVISION = '20200401' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicenetworking_v1beta/classes.rb b/generated/google/apis/servicenetworking_v1beta/classes.rb index 5f48dda37..b8cff7894 100644 --- a/generated/google/apis/servicenetworking_v1beta/classes.rb +++ b/generated/google/apis/servicenetworking_v1beta/classes.rb @@ -22,6 +22,40 @@ module Google module Apis module ServicenetworkingV1beta + # Metadata provided through GetOperation request for the LRO generated by + # AddRoles API + class AddRolesMetadata + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Represents IAM roles added to the shared VPC host project. + class AddRolesResponse + include Google::Apis::Core::Hashable + + # Required. List of policy bindings that were added to the shared VPC host + # project. + # Corresponds to the JSON property `policyBinding` + # @return [Array] + attr_accessor :policy_binding + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @policy_binding = args[:policy_binding] if args.key?(:policy_binding) + end + end + # Request to create a subnetwork in a previously peered service network. class AddSubnetworkRequest include Google::Apis::Core::Hashable @@ -193,12 +227,16 @@ module Google # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# # section-4.1.3). # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, only JWTs with audience - # "https://Service_name/API_name" - # will be accepted. For example, if no audiences are in the setting, - # LibraryService API will only accept JWTs with the following audience - # "https://library-example.googleapis.com/google.example.library.v1. - # LibraryService". + # be accepted. When this setting is absent, JWTs with audiences: + # - "https://[service.name]/[google.protobuf.Api.name]" + # - "https://[service.name]/" + # will be accepted. + # For example, if no audiences are in the setting, LibraryService API will + # accept JWTs with the following audiences: + # - + # https://library-example.googleapis.com/google.example.library.v1. + # LibraryService + # - https://library-example.googleapis.com/ # Example: # audiences: bookstore_android.apps.googleusercontent.com, # bookstore_web.apps.googleusercontent.com @@ -518,6 +556,36 @@ module Google # @return [String] attr_accessor :protocol + # Unimplemented. Do not use. + # The new name the selected proto elements should be renamed to. + # The package, the service and the method can all be renamed. + # The backend server should implement the renamed proto. However, clients + # should call the original method, and ESF routes the traffic to the renamed + # method. + # HTTP clients should call the URL mapped to the original method. + # gRPC and Stubby clients should call the original method with package name. + # For legacy reasons, ESF allows Stubby clients to call with the + # short name (without the package name). However, for API Versioning(or + # multiple methods mapped to the same short name), all Stubby clients must + # call the method's full name with the package name, otherwise the first one + # (selector) wins. + # If this `rename_to` is specified with a trailing `*`, the `selector` must + # be specified with a trailing `*` as well. The all element short names + # matched by the `*` in the selector will be kept in the `rename_to`. + # For example, + # rename_rules: + # - selector: |- + # google.example.library.v1.* + # rename_to: google.example.library.* + # The selector matches `google.example.library.v1.Library.CreateShelf` and + # `google.example.library.v1.Library.CreateBook`, they will be renamed to + # `google.example.library.Library.CreateShelf` and + # `google.example.library.Library.CreateBook`. It essentially renames the + # proto package name section of the matched proto service and methods. + # Corresponds to the JSON property `renameTo` + # @return [String] + attr_accessor :rename_to + # Selects the methods to which this rule applies. # Refer to selector for syntax details. # Corresponds to the JSON property `selector` @@ -538,6 +606,7 @@ module Google @operation_deadline = args[:operation_deadline] if args.key?(:operation_deadline) @path_translation = args[:path_translation] if args.key?(:path_translation) @protocol = args[:protocol] if args.key?(:protocol) + @rename_to = args[:rename_to] if args.key?(:rename_to) @selector = args[:selector] if args.key?(:selector) end end @@ -2590,6 +2659,38 @@ module Google end end + # Grouping of IAM role and IAM member. + class PolicyBinding + include Google::Apis::Core::Hashable + + # Required. Member to bind the role with. See + # /iam/docs/reference/rest/v1/Policy#Binding for how to format each member. + # Eg. + # - user:myuser@mydomain.com + # - serviceAccount:my-service-account@app.gserviceaccount.com + # Corresponds to the JSON property `member` + # @return [String] + attr_accessor :member + + # Required. Role to apply. Only whitelisted roles can be used at the specified + # granularity. The role must be one of the following: + # - 'roles/container.hostServiceAgentUser' applied on the shared VPC host + # project + # 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) + @member = args[:member] if args.key?(:member) + @role = args[:role] if args.key?(:role) + end + end + # Quota configuration helps to achieve fairness and budgeting in service # usage. # The metric based quota configuration works this way: @@ -2796,6 +2897,48 @@ module Google end end + # Represents a route that was created or discovered by a private access + # management service. + class Route + include Google::Apis::Core::Hashable + + # Destination CIDR range that this route applies to. + # Corresponds to the JSON property `destRange` + # @return [String] + attr_accessor :dest_range + + # Route name. See https://cloud.google.com/vpc/docs/routes + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Fully-qualified URL of the VPC network in the producer host tenant project + # that this route applies to. For example: + # `projects/123456/global/networks/host-network` + # Corresponds to the JSON property `network` + # @return [String] + attr_accessor :network + + # Fully-qualified URL of the gateway that should handle matching packets that + # this route applies to. For example: + # `projects/123456/global/gateways/default-internet-gateway` + # Corresponds to the JSON property `nextHopGateway` + # @return [String] + attr_accessor :next_hop_gateway + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dest_range = args[:dest_range] if args.key?(:dest_range) + @name = args[:name] if args.key?(:name) + @network = args[:network] if args.key?(:network) + @next_hop_gateway = args[:next_hop_gateway] if args.key?(:next_hop_gateway) + end + end + # Request to search for an unused range within allocated ranges. class SearchRangeRequest include Google::Apis::Core::Hashable diff --git a/generated/google/apis/servicenetworking_v1beta/representations.rb b/generated/google/apis/servicenetworking_v1beta/representations.rb index 3245d8a4d..269d88c7d 100644 --- a/generated/google/apis/servicenetworking_v1beta/representations.rb +++ b/generated/google/apis/servicenetworking_v1beta/representations.rb @@ -22,6 +22,18 @@ module Google module Apis module ServicenetworkingV1beta + class AddRolesMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AddRolesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class AddSubnetworkRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -286,6 +298,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class PolicyBinding + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Quota class Representation < Google::Apis::Core::JsonRepresentation; end @@ -304,6 +322,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Route + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SearchRangeRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -382,6 +406,20 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class AddRolesMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class AddRolesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :policy_binding, as: 'policyBinding', class: Google::Apis::ServicenetworkingV1beta::PolicyBinding, decorator: Google::Apis::ServicenetworkingV1beta::PolicyBinding::Representation + + end + end + class AddSubnetworkRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -475,6 +513,7 @@ module Google property :operation_deadline, as: 'operationDeadline' property :path_translation, as: 'pathTranslation' property :protocol, as: 'protocol' + property :rename_to, as: 'renameTo' property :selector, as: 'selector' end end @@ -850,6 +889,14 @@ module Google end end + class PolicyBinding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :member, as: 'member' + property :role, as: 'role' + end + end + class Quota # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -884,6 +931,16 @@ module Google end end + class Route + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dest_range, as: 'destRange' + property :name, as: 'name' + property :network, as: 'network' + property :next_hop_gateway, as: 'nextHopGateway' + end + end + class SearchRangeRequest # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/serviceusage_v1.rb b/generated/google/apis/serviceusage_v1.rb index ed49309ad..26a962d77 100644 --- a/generated/google/apis/serviceusage_v1.rb +++ b/generated/google/apis/serviceusage_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/service-usage/ module ServiceusageV1 VERSION = 'V1' - REVISION = '20200305' + REVISION = '20200331' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/serviceusage_v1/classes.rb b/generated/google/apis/serviceusage_v1/classes.rb index b49c7170a..3e0612dbf 100644 --- a/generated/google/apis/serviceusage_v1/classes.rb +++ b/generated/google/apis/serviceusage_v1/classes.rb @@ -112,12 +112,16 @@ module Google # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# # section-4.1.3). # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, only JWTs with audience - # "https://Service_name/API_name" - # will be accepted. For example, if no audiences are in the setting, - # LibraryService API will only accept JWTs with the following audience - # "https://library-example.googleapis.com/google.example.library.v1. - # LibraryService". + # be accepted. When this setting is absent, JWTs with audiences: + # - "https://[service.name]/[google.protobuf.Api.name]" + # - "https://[service.name]/" + # will be accepted. + # For example, if no audiences are in the setting, LibraryService API will + # accept JWTs with the following audiences: + # - + # https://library-example.googleapis.com/google.example.library.v1. + # LibraryService + # - https://library-example.googleapis.com/ # Example: # audiences: bookstore_android.apps.googleusercontent.com, # bookstore_web.apps.googleusercontent.com @@ -437,6 +441,36 @@ module Google # @return [String] attr_accessor :protocol + # Unimplemented. Do not use. + # The new name the selected proto elements should be renamed to. + # The package, the service and the method can all be renamed. + # The backend server should implement the renamed proto. However, clients + # should call the original method, and ESF routes the traffic to the renamed + # method. + # HTTP clients should call the URL mapped to the original method. + # gRPC and Stubby clients should call the original method with package name. + # For legacy reasons, ESF allows Stubby clients to call with the + # short name (without the package name). However, for API Versioning(or + # multiple methods mapped to the same short name), all Stubby clients must + # call the method's full name with the package name, otherwise the first one + # (selector) wins. + # If this `rename_to` is specified with a trailing `*`, the `selector` must + # be specified with a trailing `*` as well. The all element short names + # matched by the `*` in the selector will be kept in the `rename_to`. + # For example, + # rename_rules: + # - selector: |- + # google.example.library.v1.* + # rename_to: google.example.library.* + # The selector matches `google.example.library.v1.Library.CreateShelf` and + # `google.example.library.v1.Library.CreateBook`, they will be renamed to + # `google.example.library.Library.CreateShelf` and + # `google.example.library.Library.CreateBook`. It essentially renames the + # proto package name section of the matched proto service and methods. + # Corresponds to the JSON property `renameTo` + # @return [String] + attr_accessor :rename_to + # Selects the methods to which this rule applies. # Refer to selector for syntax details. # Corresponds to the JSON property `selector` @@ -457,6 +491,7 @@ module Google @operation_deadline = args[:operation_deadline] if args.key?(:operation_deadline) @path_translation = args[:path_translation] if args.key?(:path_translation) @protocol = args[:protocol] if args.key?(:protocol) + @rename_to = args[:rename_to] if args.key?(:rename_to) @selector = args[:selector] if args.key?(:selector) end end @@ -553,6 +588,25 @@ module Google end end + # Response message for the `BatchGetServices` method. + class BatchGetServicesResponse + include Google::Apis::Core::Hashable + + # The requested Service states. + # Corresponds to the JSON property `services` + # @return [Array] + attr_accessor :services + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @services = args[:services] if args.key?(:services) + end + end + # Billing related configuration of the service. # The following example shows how to configure monitored resources and metrics # for billing: @@ -2472,6 +2526,44 @@ module Google end end + # Response message for ImportAdminOverrides + class ImportAdminOverridesResponse + include Google::Apis::Core::Hashable + + # The overrides that were created from the imported data. + # Corresponds to the JSON property `overrides` + # @return [Array] + attr_accessor :overrides + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @overrides = args[:overrides] if args.key?(:overrides) + end + end + + # Response message for ImportConsumerOverrides + class ImportConsumerOverridesResponse + include Google::Apis::Core::Hashable + + # The overrides that were created from the imported data. + # Corresponds to the JSON property `overrides` + # @return [Array] + attr_accessor :overrides + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @overrides = args[:overrides] if args.key?(:overrides) + end + end + # Specifies a location to extract JWT from an API request. class JwtLocation include Google::Apis::Core::Hashable @@ -3690,6 +3782,13 @@ module Google # @return [Hash] attr_accessor :dimensions + # The name of the metric to which this override applies. + # An example name would be: + # `compute.googleapis.com/cpus` + # Corresponds to the JSON property `metric` + # @return [String] + attr_accessor :metric + # The resource name of the override. # This name is generated by the server when the override is created. # Example names would be: @@ -3709,6 +3808,15 @@ module Google # @return [Fixnum] attr_accessor :override_value + # The limit unit of the limit to which this override applies. + # An example unit would be: + # `1/`project`/`region`` + # Note that ``project`` and ``region`` are not placeholders in this example; + # the literal characters ``` and ``` occur in the string. + # Corresponds to the JSON property `unit` + # @return [String] + attr_accessor :unit + def initialize(**args) update!(**args) end @@ -3716,8 +3824,10 @@ module Google # Update properties of this object def update!(**args) @dimensions = args[:dimensions] if args.key?(:dimensions) + @metric = args[:metric] if args.key?(:metric) @name = args[:name] if args.key?(:name) @override_value = args[:override_value] if args.key?(:override_value) + @unit = args[:unit] if args.key?(:unit) end end diff --git a/generated/google/apis/serviceusage_v1/representations.rb b/generated/google/apis/serviceusage_v1/representations.rb index 5ed3e2566..5587cf541 100644 --- a/generated/google/apis/serviceusage_v1/representations.rb +++ b/generated/google/apis/serviceusage_v1/representations.rb @@ -88,6 +88,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class BatchGetServicesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Billing class Representation < Google::Apis::Core::JsonRepresentation; end @@ -274,6 +280,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ImportAdminOverridesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ImportConsumerOverridesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class JwtLocation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -551,6 +569,7 @@ module Google property :operation_deadline, as: 'operationDeadline' property :path_translation, as: 'pathTranslation' property :protocol, as: 'protocol' + property :rename_to, as: 'renameTo' property :selector, as: 'selector' end end @@ -588,6 +607,14 @@ module Google end end + class BatchGetServicesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :services, as: 'services', class: Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service, decorator: Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service::Representation + + end + end + class Billing # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -935,6 +962,22 @@ module Google end end + class ImportAdminOverridesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :overrides, as: 'overrides', class: Google::Apis::ServiceusageV1::QuotaOverride, decorator: Google::Apis::ServiceusageV1::QuotaOverride::Representation + + end + end + + class ImportConsumerOverridesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :overrides, as: 'overrides', class: Google::Apis::ServiceusageV1::QuotaOverride, decorator: Google::Apis::ServiceusageV1::QuotaOverride::Representation + + end + end + class JwtLocation # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1163,8 +1206,10 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation hash :dimensions, as: 'dimensions' + property :metric, as: 'metric' property :name, as: 'name' property :override_value, :numeric_string => true, as: 'overrideValue' + property :unit, as: 'unit' end end diff --git a/generated/google/apis/serviceusage_v1/service.rb b/generated/google/apis/serviceusage_v1/service.rb index 1884e5348..38dc7c046 100644 --- a/generated/google/apis/serviceusage_v1/service.rb +++ b/generated/google/apis/serviceusage_v1/service.rb @@ -241,6 +241,48 @@ module Google execute_or_queue_command(command, &block) end + # Returns the service configurations and enabled states for a given list of + # services. + # @param [String] parent + # Parent to retrieve services from. + # If this is set, the parent of all of the services specified in `names` must + # match this field. An example name would be: `projects/123` where `123` is + # the project number. The `BatchGetServices` method currently only supports + # projects. + # @param [Array, String] names + # Names of the services to retrieve. + # An example name would be: + # `projects/123/services/serviceusage.googleapis.com` where `123` is the + # project number. + # A single request can get a maximum of 20 services at a time. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceusageV1::BatchGetServicesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceusageV1::BatchGetServicesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def batch_service_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/services:batchGet', options) + command.response_representation = Google::Apis::ServiceusageV1::BatchGetServicesResponse::Representation + command.response_class = Google::Apis::ServiceusageV1::BatchGetServicesResponse + command.params['parent'] = parent unless parent.nil? + command.query['names'] = names unless names.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Disable a service so that it can no longer be used with a project. # This prevents unintended usage that may cause unexpected billing # charges or security leaks. diff --git a/generated/google/apis/serviceusage_v1beta1.rb b/generated/google/apis/serviceusage_v1beta1.rb index 461300f15..2acd337d7 100644 --- a/generated/google/apis/serviceusage_v1beta1.rb +++ b/generated/google/apis/serviceusage_v1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/service-usage/ module ServiceusageV1beta1 VERSION = 'V1beta1' - REVISION = '20200308' + REVISION = '20200331' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/serviceusage_v1beta1/classes.rb b/generated/google/apis/serviceusage_v1beta1/classes.rb index eb22e4d5a..eb5e0ce12 100644 --- a/generated/google/apis/serviceusage_v1beta1/classes.rb +++ b/generated/google/apis/serviceusage_v1beta1/classes.rb @@ -112,12 +112,16 @@ module Google # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# # section-4.1.3). # that are allowed to access. A JWT containing any of these audiences will - # be accepted. When this setting is absent, only JWTs with audience - # "https://Service_name/API_name" - # will be accepted. For example, if no audiences are in the setting, - # LibraryService API will only accept JWTs with the following audience - # "https://library-example.googleapis.com/google.example.library.v1. - # LibraryService". + # be accepted. When this setting is absent, JWTs with audiences: + # - "https://[service.name]/[google.protobuf.Api.name]" + # - "https://[service.name]/" + # will be accepted. + # For example, if no audiences are in the setting, LibraryService API will + # accept JWTs with the following audiences: + # - + # https://library-example.googleapis.com/google.example.library.v1. + # LibraryService + # - https://library-example.googleapis.com/ # Example: # audiences: bookstore_android.apps.googleusercontent.com, # bookstore_web.apps.googleusercontent.com @@ -437,6 +441,36 @@ module Google # @return [String] attr_accessor :protocol + # Unimplemented. Do not use. + # The new name the selected proto elements should be renamed to. + # The package, the service and the method can all be renamed. + # The backend server should implement the renamed proto. However, clients + # should call the original method, and ESF routes the traffic to the renamed + # method. + # HTTP clients should call the URL mapped to the original method. + # gRPC and Stubby clients should call the original method with package name. + # For legacy reasons, ESF allows Stubby clients to call with the + # short name (without the package name). However, for API Versioning(or + # multiple methods mapped to the same short name), all Stubby clients must + # call the method's full name with the package name, otherwise the first one + # (selector) wins. + # If this `rename_to` is specified with a trailing `*`, the `selector` must + # be specified with a trailing `*` as well. The all element short names + # matched by the `*` in the selector will be kept in the `rename_to`. + # For example, + # rename_rules: + # - selector: |- + # google.example.library.v1.* + # rename_to: google.example.library.* + # The selector matches `google.example.library.v1.Library.CreateShelf` and + # `google.example.library.v1.Library.CreateBook`, they will be renamed to + # `google.example.library.Library.CreateShelf` and + # `google.example.library.Library.CreateBook`. It essentially renames the + # proto package name section of the matched proto service and methods. + # Corresponds to the JSON property `renameTo` + # @return [String] + attr_accessor :rename_to + # Selects the methods to which this rule applies. # Refer to selector for syntax details. # Corresponds to the JSON property `selector` @@ -457,6 +491,7 @@ module Google @operation_deadline = args[:operation_deadline] if args.key?(:operation_deadline) @path_translation = args[:path_translation] if args.key?(:path_translation) @protocol = args[:protocol] if args.key?(:protocol) + @rename_to = args[:rename_to] if args.key?(:rename_to) @selector = args[:selector] if args.key?(:selector) end end @@ -2560,6 +2595,44 @@ module Google end end + # Response message for ImportAdminOverrides + class ImportAdminOverridesResponse + include Google::Apis::Core::Hashable + + # The overrides that were created from the imported data. + # Corresponds to the JSON property `overrides` + # @return [Array] + attr_accessor :overrides + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @overrides = args[:overrides] if args.key?(:overrides) + end + end + + # Response message for ImportConsumerOverrides + class ImportConsumerOverridesResponse + include Google::Apis::Core::Hashable + + # The overrides that were created from the imported data. + # Corresponds to the JSON property `overrides` + # @return [Array] + attr_accessor :overrides + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @overrides = args[:overrides] if args.key?(:overrides) + end + end + # Specifies a location to extract JWT from an API request. class JwtLocation include Google::Apis::Core::Hashable @@ -2731,32 +2804,6 @@ module Google end end - # Response message for ListProducerOverrides. - class ListProducerOverridesResponse - include Google::Apis::Core::Hashable - - # Token identifying which result to start with; returned by a previous list - # call. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # Producer overrides on this limit. - # Corresponds to the JSON property `overrides` - # @return [Array] - attr_accessor :overrides - - 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) - @overrides = args[:overrides] if args.key?(:overrides) - end - end - # Response message for the `ListServices` method. class ListServicesResponse include Google::Apis::Core::Hashable @@ -3940,6 +3987,13 @@ module Google # @return [Hash] attr_accessor :dimensions + # The name of the metric to which this override applies. + # An example name would be: + # `compute.googleapis.com/cpus` + # Corresponds to the JSON property `metric` + # @return [String] + attr_accessor :metric + # The resource name of the override. # This name is generated by the server when the override is created. # Example names would be: @@ -3959,6 +4013,15 @@ module Google # @return [Fixnum] attr_accessor :override_value + # The limit unit of the limit to which this override applies. + # An example unit would be: + # `1/`project`/`region`` + # Note that ``project`` and ``region`` are not placeholders in this example; + # the literal characters ``` and ``` occur in the string. + # Corresponds to the JSON property `unit` + # @return [String] + attr_accessor :unit + def initialize(**args) update!(**args) end @@ -3966,8 +4029,10 @@ module Google # Update properties of this object def update!(**args) @dimensions = args[:dimensions] if args.key?(:dimensions) + @metric = args[:metric] if args.key?(:metric) @name = args[:name] if args.key?(:name) @override_value = args[:override_value] if args.key?(:override_value) + @unit = args[:unit] if args.key?(:unit) end end diff --git a/generated/google/apis/serviceusage_v1beta1/representations.rb b/generated/google/apis/serviceusage_v1beta1/representations.rb index 8755ba6b1..d1e975251 100644 --- a/generated/google/apis/serviceusage_v1beta1/representations.rb +++ b/generated/google/apis/serviceusage_v1beta1/representations.rb @@ -280,6 +280,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ImportAdminOverridesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ImportConsumerOverridesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class JwtLocation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -316,12 +328,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class ListProducerOverridesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class ListServicesResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -599,6 +605,7 @@ module Google property :operation_deadline, as: 'operationDeadline' property :path_translation, as: 'pathTranslation' property :protocol, as: 'protocol' + property :rename_to, as: 'renameTo' property :selector, as: 'selector' end end @@ -1000,6 +1007,22 @@ module Google end end + class ImportAdminOverridesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :overrides, as: 'overrides', class: Google::Apis::ServiceusageV1beta1::QuotaOverride, decorator: Google::Apis::ServiceusageV1beta1::QuotaOverride::Representation + + end + end + + class ImportConsumerOverridesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :overrides, as: 'overrides', class: Google::Apis::ServiceusageV1beta1::QuotaOverride, decorator: Google::Apis::ServiceusageV1beta1::QuotaOverride::Representation + + end + end + class JwtLocation # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1054,15 +1077,6 @@ module Google end end - class ListProducerOverridesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :overrides, as: 'overrides', class: Google::Apis::ServiceusageV1beta1::QuotaOverride, decorator: Google::Apis::ServiceusageV1beta1::QuotaOverride::Representation - - end - end - class ListServicesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1279,8 +1293,10 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation hash :dimensions, as: 'dimensions' + property :metric, as: 'metric' property :name, as: 'name' property :override_value, :numeric_string => true, as: 'overrideValue' + property :unit, as: 'unit' end end diff --git a/generated/google/apis/serviceusage_v1beta1/service.rb b/generated/google/apis/serviceusage_v1beta1/service.rb index 551dcbbfb..deabe80c8 100644 --- a/generated/google/apis/serviceusage_v1beta1/service.rb +++ b/generated/google/apis/serviceusage_v1beta1/service.rb @@ -807,49 +807,6 @@ module Google command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - - # Lists all producer overrides on this limit. - # Unlike other types of overrides, producer overrides are under the control - # of the service producer and cannot be modified using this API. - # @param [String] parent - # The resource name of the parent quota limit, returned by a - # ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. - # An example name would be: - # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute. - # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` - # @param [Fixnum] page_size - # Requested size of the next page of data. - # @param [String] page_token - # Token identifying which result to start with; returned by a previous list - # call. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::ServiceusageV1beta1::ListProducerOverridesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ServiceusageV1beta1::ListProducerOverridesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_service_consumer_quota_metric_limit_producer_overrides(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1beta1/{+parent}/producerOverrides', options) - command.response_representation = Google::Apis::ServiceusageV1beta1::ListProducerOverridesResponse::Representation - command.response_class = Google::Apis::ServiceusageV1beta1::ListProducerOverridesResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end protected diff --git a/generated/google/apis/sheets_v4.rb b/generated/google/apis/sheets_v4.rb index 1a8ca68f3..e66031ef3 100644 --- a/generated/google/apis/sheets_v4.rb +++ b/generated/google/apis/sheets_v4.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/sheets/ module SheetsV4 VERSION = 'V4' - REVISION = '20200225' + REVISION = '20200312' # See, edit, create, and delete all of your Google Drive files AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' diff --git a/generated/google/apis/sheets_v4/classes.rb b/generated/google/apis/sheets_v4/classes.rb index 7e1aa85c0..bd925e3ad 100644 --- a/generated/google/apis/sheets_v4/classes.rb +++ b/generated/google/apis/sheets_v4/classes.rb @@ -1977,7 +1977,7 @@ module Google attr_accessor :requests # True if grid data should be returned. Meaningful only if - # if include_spreadsheet_in_response is 'true'. + # include_spreadsheet_in_response is 'true'. # This parameter is ignored if a field mask was set in the request. # Corresponds to the JSON property `responseIncludeGridData` # @return [Boolean] @@ -1985,7 +1985,7 @@ module Google alias_method :response_include_grid_data?, :response_include_grid_data # Limits the ranges included in the response spreadsheet. - # Meaningful only if include_spreadsheet_response is 'true'. + # Meaningful only if include_spreadsheet_in_response is 'true'. # Corresponds to the JSON property `responseRanges` # @return [Array] attr_accessor :response_ranges diff --git a/generated/google/apis/spanner_v1.rb b/generated/google/apis/spanner_v1.rb index e0b95f4af..4b9b973c4 100644 --- a/generated/google/apis/spanner_v1.rb +++ b/generated/google/apis/spanner_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/spanner/ module SpannerV1 VERSION = 'V1' - REVISION = '20200224' + REVISION = '20200313' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/spanner_v1/classes.rb b/generated/google/apis/spanner_v1/classes.rb index 0b23703b2..a0b9b6008 100644 --- a/generated/google/apis/spanner_v1/classes.rb +++ b/generated/google/apis/spanner_v1/classes.rb @@ -22,6 +22,121 @@ module Google module Apis module SpannerV1 + # A backup of a Cloud Spanner database. + class Backup + include Google::Apis::Core::Hashable + + # Output only. The backup will contain an externally consistent + # copy of the database at the timestamp specified by + # `create_time`. `create_time` is approximately the time the + # CreateBackup request is received. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Required for the CreateBackup operation. + # Name of the database from which this backup was + # created. This needs to be in the same instance as the backup. + # Values are of the form + # `projects//instances//databases/`. + # Corresponds to the JSON property `database` + # @return [String] + attr_accessor :database + + # Required for the CreateBackup + # operation. The expiration time of the backup, with microseconds + # granularity that must be at least 6 hours and at most 366 days + # from the time the CreateBackup request is processed. Once the `expire_time` + # has passed, the backup is eligible to be automatically deleted by Cloud + # Spanner to free the resources used by the backup. + # Corresponds to the JSON property `expireTime` + # @return [String] + attr_accessor :expire_time + + # Output only for the CreateBackup operation. + # Required for the UpdateBackup operation. + # A globally unique identifier for the backup which cannot be + # changed. Values are of the form + # `projects//instances//backups/a-z*[a-z0-9]` + # The final segment of the name must be between 2 and 60 characters + # in length. + # The backup is stored in the location(s) specified in the instance + # configuration of the instance containing the backup, identified + # by the prefix of the backup name of the form + # `projects//instances/`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. The names of the restored databases that reference the backup. + # The database names are of + # the form `projects//instances//databases/`. + # Referencing databases may exist in different instances. The existence of + # any referencing database prevents the backup from being deleted. When a + # restored database from the backup enters the `READY` state, the reference + # to the backup is removed. + # Corresponds to the JSON property `referencingDatabases` + # @return [Array] + attr_accessor :referencing_databases + + # Output only. Size of the backup in bytes. + # Corresponds to the JSON property `sizeBytes` + # @return [Fixnum] + attr_accessor :size_bytes + + # Output only. The current state of the backup. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @create_time = args[:create_time] if args.key?(:create_time) + @database = args[:database] if args.key?(:database) + @expire_time = args[:expire_time] if args.key?(:expire_time) + @name = args[:name] if args.key?(:name) + @referencing_databases = args[:referencing_databases] if args.key?(:referencing_databases) + @size_bytes = args[:size_bytes] if args.key?(:size_bytes) + @state = args[:state] if args.key?(:state) + end + end + + # Information about a backup. + class BackupInfo + include Google::Apis::Core::Hashable + + # Name of the backup. + # Corresponds to the JSON property `backup` + # @return [String] + attr_accessor :backup + + # The backup contains an externally consistent copy of `source_database` at + # the timestamp specified by `create_time`. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Name of the database the backup was created from. + # Corresponds to the JSON property `sourceDatabase` + # @return [String] + attr_accessor :source_database + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @backup = args[:backup] if args.key?(:backup) + @create_time = args[:create_time] if args.key?(:create_time) + @source_database = args[:source_database] if args.key?(:source_database) + end + end + # The request for BatchCreateSessions. class BatchCreateSessionsRequest include Google::Apis::Core::Hashable @@ -695,6 +810,55 @@ module Google end end + # Metadata type for the operation returned by + # CreateBackup. + class CreateBackupMetadata + include Google::Apis::Core::Hashable + + # The time at which cancellation of this operation was received. + # Operations.CancelOperation + # starts asynchronous cancellation on a long-running operation. The server + # makes a best effort to cancel the operation, but success is not guaranteed. + # Clients can use + # Operations.GetOperation or + # other methods to check whether the cancellation succeeded or whether the + # operation completed despite cancellation. On successful cancellation, + # the operation is not deleted; instead, it becomes an operation with + # an Operation.error value with a google.rpc.Status.code of 1, + # corresponding to `Code.CANCELLED`. + # Corresponds to the JSON property `cancelTime` + # @return [String] + attr_accessor :cancel_time + + # The name of the database the backup is created from. + # Corresponds to the JSON property `database` + # @return [String] + attr_accessor :database + + # The name of the backup being created. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Encapsulates progress related information for a Cloud Spanner long + # running operation. + # Corresponds to the JSON property `progress` + # @return [Google::Apis::SpannerV1::OperationProgress] + attr_accessor :progress + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cancel_time = args[:cancel_time] if args.key?(:cancel_time) + @database = args[:database] if args.key?(:database) + @name = args[:name] if args.key?(:name) + @progress = args[:progress] if args.key?(:progress) + end + end + # Metadata type for the operation returned by # CreateDatabase. class CreateDatabaseMetadata @@ -728,7 +892,7 @@ module Google # @return [String] attr_accessor :create_statement - # An optional list of DDL statements to run inside the newly created + # Optional. A list of DDL statements to run inside the newly created # database. Statements can create tables, indexes, etc. These # statements execute atomically with the creation of the database: # if there is an error in any statement, the database is not created. @@ -839,6 +1003,11 @@ module Google class Database include Google::Apis::Core::Hashable + # Output only. If exists, the time at which the database creation started. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + # Required. The name of the database. Values are of the form # `projects//instances//databases/`, # where `` is as specified in the `CREATE DATABASE` @@ -848,6 +1017,11 @@ module Google # @return [String] attr_accessor :name + # Information about the database restore. + # Corresponds to the JSON property `restoreInfo` + # @return [Google::Apis::SpannerV1::RestoreInfo] + attr_accessor :restore_info + # Output only. The current database state. # Corresponds to the JSON property `state` # @return [String] @@ -859,7 +1033,9 @@ module Google # Update properties of this object def update!(**args) + @create_time = args[:create_time] if args.key?(:create_time) @name = args[:name] if args.key?(:name) + @restore_info = args[:restore_info] if args.key?(:restore_info) @state = args[:state] if args.key?(:state) end end @@ -1538,6 +1714,102 @@ module Google end end + # The response for + # ListBackupOperations. + class ListBackupOperationsResponse + include Google::Apis::Core::Hashable + + # `next_page_token` can be sent in a subsequent + # ListBackupOperations + # call to fetch more of the matching metadata. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The list of matching backup long-running + # operations. Each operation's name will be + # prefixed by the backup's name and the operation's + # metadata will be of type + # CreateBackupMetadata. Operations returned include those that are + # pending or have completed/failed/canceled within the last 7 days. + # Operations returned are ordered by + # `operation.metadata.value.progress.start_time` in descending order starting + # from the most recently started operation. + # Corresponds to the JSON property `operations` + # @return [Array] + 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 + + # The response for ListBackups. + class ListBackupsResponse + include Google::Apis::Core::Hashable + + # The list of matching backups. Backups returned are ordered by `create_time` + # in descending order, starting from the most recent `create_time`. + # Corresponds to the JSON property `backups` + # @return [Array] + attr_accessor :backups + + # `next_page_token` can be sent in a subsequent + # ListBackups call to fetch more + # of the matching backups. + # 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) + @backups = args[:backups] if args.key?(:backups) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # The response for + # ListDatabaseOperations. + class ListDatabaseOperationsResponse + include Google::Apis::Core::Hashable + + # `next_page_token` can be sent in a subsequent + # ListDatabaseOperations + # call to fetch more of the matching metadata. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The list of matching database long-running + # operations. Each operation's name will be + # prefixed by the database's name. The operation's + # metadata field type + # `metadata.type_url` describes the type of the metadata. + # Corresponds to the JSON property `operations` + # @return [Array] + 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 + # The response for ListDatabases. class ListDatabasesResponse include Google::Apis::Core::Hashable @@ -1784,6 +2056,69 @@ module Google end end + # Encapsulates progress related information for a Cloud Spanner long + # running operation. + class OperationProgress + include Google::Apis::Core::Hashable + + # If set, the time at which this operation failed or was completed + # successfully. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Percent completion of the operation. + # Values are between 0 and 100 inclusive. + # Corresponds to the JSON property `progressPercent` + # @return [Fixnum] + attr_accessor :progress_percent + + # Time the request was received. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_time = args[:end_time] if args.key?(:end_time) + @progress_percent = args[:progress_percent] if args.key?(:progress_percent) + @start_time = args[:start_time] if args.key?(:start_time) + end + end + + # Metadata type for the long-running operation used to track the progress + # of optimizations performed on a newly restored database. This long-running + # operation is automatically created by the system after the successful + # completion of a database restore, and cannot be cancelled. + class OptimizeRestoredDatabaseMetadata + include Google::Apis::Core::Hashable + + # Name of the restored database being optimized. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Encapsulates progress related information for a Cloud Spanner long + # running operation. + # Corresponds to the JSON property `progress` + # @return [Google::Apis::SpannerV1::OperationProgress] + attr_accessor :progress + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @progress = args[:progress] if args.key?(:progress) + end + end + # Partial results from a streaming read or SQL query. Streaming reads and # SQL queries better tolerate large result sets, large rows, and large # values, but are a little trickier to consume. @@ -2578,6 +2913,133 @@ module Google end end + # Metadata type for the long-running operation returned by + # RestoreDatabase. + class RestoreDatabaseMetadata + include Google::Apis::Core::Hashable + + # Information about a backup. + # Corresponds to the JSON property `backupInfo` + # @return [Google::Apis::SpannerV1::BackupInfo] + attr_accessor :backup_info + + # The time at which cancellation of this operation was received. + # Operations.CancelOperation + # starts asynchronous cancellation on a long-running operation. The server + # makes a best effort to cancel the operation, but success is not guaranteed. + # Clients can use + # Operations.GetOperation or + # other methods to check whether the cancellation succeeded or whether the + # operation completed despite cancellation. On successful cancellation, + # the operation is not deleted; instead, it becomes an operation with + # an Operation.error value with a + # google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + # Corresponds to the JSON property `cancelTime` + # @return [String] + attr_accessor :cancel_time + + # Name of the database being created and restored to. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # If exists, the name of the long-running operation that will be used to + # track the post-restore optimization process to optimize the performance of + # the restored database, and remove the dependency on the restore source. + # The name is of the form + # `projects//instances//databases//operations/< + # operation>` + # where the is the name of database being created and restored to. + # The metadata type of the long-running operation is + # OptimizeRestoredDatabaseMetadata. This long-running operation will be + # automatically created by the system after the RestoreDatabase long-running + # operation completes successfully. This operation will not be created if the + # restore was not successful. + # Corresponds to the JSON property `optimizeDatabaseOperationName` + # @return [String] + attr_accessor :optimize_database_operation_name + + # Encapsulates progress related information for a Cloud Spanner long + # running operation. + # Corresponds to the JSON property `progress` + # @return [Google::Apis::SpannerV1::OperationProgress] + attr_accessor :progress + + # The type of the restore source. + # Corresponds to the JSON property `sourceType` + # @return [String] + attr_accessor :source_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @backup_info = args[:backup_info] if args.key?(:backup_info) + @cancel_time = args[:cancel_time] if args.key?(:cancel_time) + @name = args[:name] if args.key?(:name) + @optimize_database_operation_name = args[:optimize_database_operation_name] if args.key?(:optimize_database_operation_name) + @progress = args[:progress] if args.key?(:progress) + @source_type = args[:source_type] if args.key?(:source_type) + end + end + + # The request for + # RestoreDatabase. + class RestoreDatabaseRequest + include Google::Apis::Core::Hashable + + # Name of the backup from which to restore. Values are of the form + # `projects//instances//backups/`. + # Corresponds to the JSON property `backup` + # @return [String] + attr_accessor :backup + + # Required. The id of the database to create and restore to. This + # database must not already exist. The `database_id` appended to + # `parent` forms the full database name of the form + # `projects//instances//databases/`. + # Corresponds to the JSON property `databaseId` + # @return [String] + attr_accessor :database_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @backup = args[:backup] if args.key?(:backup) + @database_id = args[:database_id] if args.key?(:database_id) + end + end + + # Information about the database restore. + class RestoreInfo + include Google::Apis::Core::Hashable + + # Information about a backup. + # Corresponds to the JSON property `backupInfo` + # @return [Google::Apis::SpannerV1::BackupInfo] + attr_accessor :backup_info + + # The type of the restore source. + # Corresponds to the JSON property `sourceType` + # @return [String] + attr_accessor :source_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @backup_info = args[:backup_info] if args.key?(:backup_info) + @source_type = args[:source_type] if args.key?(:source_type) + end + end + # Results from Read or # ExecuteSql. class ResultSet diff --git a/generated/google/apis/spanner_v1/representations.rb b/generated/google/apis/spanner_v1/representations.rb index f31a8f8de..cce12c227 100644 --- a/generated/google/apis/spanner_v1/representations.rb +++ b/generated/google/apis/spanner_v1/representations.rb @@ -22,6 +22,18 @@ module Google module Apis module SpannerV1 + class Backup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BackupInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class BatchCreateSessionsRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -64,6 +76,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class CreateBackupMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CreateDatabaseMetadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -184,6 +202,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ListBackupOperationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListBackupsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListDatabaseOperationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ListDatabasesResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -226,6 +262,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class OperationProgress + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OptimizeRestoredDatabaseMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class PartialResultSet class Representation < Google::Apis::Core::JsonRepresentation; end @@ -316,6 +364,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class RestoreDatabaseMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RestoreDatabaseRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RestoreInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ResultSet class Representation < Google::Apis::Core::JsonRepresentation; end @@ -442,6 +508,28 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Backup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :database, as: 'database' + property :expire_time, as: 'expireTime' + property :name, as: 'name' + collection :referencing_databases, as: 'referencingDatabases' + property :size_bytes, :numeric_string => true, as: 'sizeBytes' + property :state, as: 'state' + end + end + + class BackupInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :backup, as: 'backup' + property :create_time, as: 'createTime' + property :source_database, as: 'sourceDatabase' + end + end + class BatchCreateSessionsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -504,6 +592,17 @@ module Google end end + class CreateBackupMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cancel_time, as: 'cancelTime' + property :database, as: 'database' + property :name, as: 'name' + property :progress, as: 'progress', class: Google::Apis::SpannerV1::OperationProgress, decorator: Google::Apis::SpannerV1::OperationProgress::Representation + + end + end + class CreateDatabaseMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -550,7 +649,10 @@ module Google class Database # @private class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' property :name, as: 'name' + property :restore_info, as: 'restoreInfo', class: Google::Apis::SpannerV1::RestoreInfo, decorator: Google::Apis::SpannerV1::RestoreInfo::Representation + property :state, as: 'state' end end @@ -697,6 +799,33 @@ module Google end end + class ListBackupOperationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :operations, as: 'operations', class: Google::Apis::SpannerV1::Operation, decorator: Google::Apis::SpannerV1::Operation::Representation + + end + end + + class ListBackupsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :backups, as: 'backups', class: Google::Apis::SpannerV1::Backup, decorator: Google::Apis::SpannerV1::Backup::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListDatabaseOperationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :operations, as: 'operations', class: Google::Apis::SpannerV1::Operation, decorator: Google::Apis::SpannerV1::Operation::Representation + + end + end + class ListDatabasesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -770,6 +899,24 @@ module Google end end + class OperationProgress + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_time, as: 'endTime' + property :progress_percent, as: 'progressPercent' + property :start_time, as: 'startTime' + end + end + + class OptimizeRestoredDatabaseMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :progress, as: 'progress', class: Google::Apis::SpannerV1::OperationProgress, decorator: Google::Apis::SpannerV1::OperationProgress::Representation + + end + end + class PartialResultSet # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -926,6 +1073,37 @@ module Google end end + class RestoreDatabaseMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :backup_info, as: 'backupInfo', class: Google::Apis::SpannerV1::BackupInfo, decorator: Google::Apis::SpannerV1::BackupInfo::Representation + + property :cancel_time, as: 'cancelTime' + property :name, as: 'name' + property :optimize_database_operation_name, as: 'optimizeDatabaseOperationName' + property :progress, as: 'progress', class: Google::Apis::SpannerV1::OperationProgress, decorator: Google::Apis::SpannerV1::OperationProgress::Representation + + property :source_type, as: 'sourceType' + end + end + + class RestoreDatabaseRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :backup, as: 'backup' + property :database_id, as: 'databaseId' + end + end + + class RestoreInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :backup_info, as: 'backupInfo', class: Google::Apis::SpannerV1::BackupInfo, decorator: Google::Apis::SpannerV1::BackupInfo::Representation + + property :source_type, as: 'sourceType' + end + end + class ResultSet # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/spanner_v1/service.rb b/generated/google/apis/spanner_v1/service.rb index 4897aa8b5..23f81a2a5 100644 --- a/generated/google/apis/spanner_v1/service.rb +++ b/generated/google/apis/spanner_v1/service.rb @@ -496,11 +496,219 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a database resource. - # Returns an empty policy if a database exists but does - # not have a policy set. + # Lists the backup long-running operations in + # the given instance. A backup operation has a name of the form + # `projects//instances//backups//operations/< + # operation>`. + # The long-running operation + # metadata field type + # `metadata.type_url` describes the type of the metadata. Operations returned + # include those that have completed/failed/canceled within the last 7 days, + # and pending operations. Operations returned are ordered by + # `operation.metadata.value.progress.start_time` in descending order starting + # from the most recently started operation. + # @param [String] parent + # Required. The instance of the backup operations. Values are of + # the form `projects//instances/`. + # @param [String] filter + # An expression that filters the list of returned backup operations. + # A filter expression consists of a field name, a + # comparison operator, and a value for filtering. + # The value must be a string, a number, or a boolean. The comparison operator + # must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. + # Colon `:` is the contains operator. Filter rules are not case sensitive. + # The following fields in the operation + # are eligible for filtering: + # * `name` - The name of the long-running operation + # * `done` - False if the operation is in progress, else true. + # * `metadata.@type` - the type of metadata. For example, the type string + # for CreateBackupMetadata is + # `type.googleapis.com/google.spanner.admin.database.v1. + # CreateBackupMetadata`. + # * `metadata.` - any field in metadata.value. + # * `error` - Error associated with the long-running operation. + # * `response.@type` - the type of response. + # * `response.` - any field in response.value. + # You can combine multiple expressions by enclosing each expression in + # parentheses. By default, expressions are combined with AND logic, but + # you can specify AND, OR, and NOT logic explicitly. + # Here are a few examples: + # * `done:true` - The operation is complete. + # * `metadata.database:prod` - The database the backup was taken from has + # a name containing the string "prod". + # * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1. + # CreateBackupMetadata) AND`
    + # `(metadata.name:howl) AND`
    + # `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND`
    + # `(error:*)` - Returns operations where: + # * The operation's metadata type is CreateBackupMetadata. + # * The backup name contains the string "howl". + # * The operation started before 2018-03-28T14:50:00Z. + # * The operation resulted in an error. + # @param [Fixnum] page_size + # Number of operations to be returned in the response. If 0 or + # less, defaults to the server's maximum allowed page size. + # @param [String] page_token + # If non-empty, `page_token` should contain a + # next_page_token + # from a previous ListBackupOperationsResponse to the + # same `parent` and with the same `filter`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SpannerV1::ListBackupOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SpannerV1::ListBackupOperationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_instance_backupoperations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/backupOperations', options) + command.response_representation = Google::Apis::SpannerV1::ListBackupOperationsResponse::Representation + command.response_class = Google::Apis::SpannerV1::ListBackupOperationsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Starts creating a new Cloud Spanner Backup. + # The returned backup long-running operation + # will have a name of the format + # `projects//instances//backups//operations/< + # operation_id>` + # and can be used to track creation of the backup. The + # metadata field type is + # CreateBackupMetadata. The + # response field type is + # Backup, if successful. Cancelling the returned operation will stop the + # creation and delete the backup. + # There can be only one pending backup creation per database. Backup creation + # of different databases can run concurrently. + # @param [String] parent + # Required. The name of the instance in which the backup will be + # created. This must be the same instance that contains the database the + # backup will be created from. The backup will be stored in the + # location(s) specified in the instance configuration of this + # instance. Values are of the form + # `projects//instances/`. + # @param [Google::Apis::SpannerV1::Backup] backup_object + # @param [String] backup_id + # Required. The id of the backup to be created. The `backup_id` appended to + # `parent` forms the full backup name of the form + # `projects//instances//backups/`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SpannerV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SpannerV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_instance_backup(parent, backup_object = nil, backup_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/backups', options) + command.request_representation = Google::Apis::SpannerV1::Backup::Representation + command.request_object = backup_object + command.response_representation = Google::Apis::SpannerV1::Operation::Representation + command.response_class = Google::Apis::SpannerV1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['backupId'] = backup_id unless backup_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a pending or completed Backup. + # @param [String] name + # Required. Name of the backup to delete. + # Values are of the form + # `projects//instances//backups/`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SpannerV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SpannerV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_instance_backup(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::SpannerV1::Empty::Representation + command.response_class = Google::Apis::SpannerV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets metadata on a pending or completed Backup. + # @param [String] name + # Required. Name of the backup. + # Values are of the form + # `projects//instances//backups/`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SpannerV1::Backup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SpannerV1::Backup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_instance_backup(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::SpannerV1::Backup::Representation + command.response_class = Google::Apis::SpannerV1::Backup + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the access control policy for a database or backup resource. + # Returns an empty policy if a database or backup exists but does not have a + # policy set. # Authorization requires `spanner.databases.getIamPolicy` permission on # resource. + # For backups, authorization requires `spanner.backups.getIamPolicy` + # permission on resource. # @param [String] resource # REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. # The format is `projects//instances/` for instance @@ -536,10 +744,135 @@ module Google execute_or_queue_command(command, &block) end - # Sets the access control policy on a database resource. + # Lists completed and pending backups. + # Backups returned are ordered by `create_time` in descending order, + # starting from the most recent `create_time`. + # @param [String] parent + # Required. The instance to list backups from. Values are of the + # form `projects//instances/`. + # @param [String] filter + # An expression that filters the list of returned backups. + # A filter expression consists of a field name, a comparison operator, and a + # value for filtering. + # The value must be a string, a number, or a boolean. The comparison operator + # must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. + # Colon `:` is the contains operator. Filter rules are not case sensitive. + # The following fields in the Backup are eligible for filtering: + # * `name` + # * `database` + # * `state` + # * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) + # * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) + # * `size_bytes` + # You can combine multiple expressions by enclosing each expression in + # parentheses. By default, expressions are combined with AND logic, but + # you can specify AND, OR, and NOT logic explicitly. + # Here are a few examples: + # * `name:Howl` - The backup's name contains the string "howl". + # * `database:prod` + # - The database's name contains the string "prod". + # * `state:CREATING` - The backup is pending creation. + # * `state:READY` - The backup is fully created and ready for use. + # * `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")` + # - The backup name contains the string "howl" and `create_time` + # of the backup is before 2018-03-28T14:50:00Z. + # * `expire_time < \"2018-03-28T14:50:00Z\"` + # - The backup `expire_time` is before 2018-03-28T14:50:00Z. + # * `size_bytes > 10000000000` - The backup's size is greater than 10GB + # @param [Fixnum] page_size + # Number of backups to be returned in the response. If 0 or + # less, defaults to the server's maximum allowed page size. + # @param [String] page_token + # If non-empty, `page_token` should contain a + # next_page_token from a + # previous ListBackupsResponse to the same `parent` and with the same + # `filter`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SpannerV1::ListBackupsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SpannerV1::ListBackupsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_instance_backups(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/backups', options) + command.response_representation = Google::Apis::SpannerV1::ListBackupsResponse::Representation + command.response_class = Google::Apis::SpannerV1::ListBackupsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a pending or completed Backup. + # @param [String] name + # Output only for the CreateBackup operation. + # Required for the UpdateBackup operation. + # A globally unique identifier for the backup which cannot be + # changed. Values are of the form + # `projects//instances//backups/a-z*[a-z0-9]` + # The final segment of the name must be between 2 and 60 characters + # in length. + # The backup is stored in the location(s) specified in the instance + # configuration of the instance containing the backup, identified + # by the prefix of the backup name of the form + # `projects//instances/`. + # @param [Google::Apis::SpannerV1::Backup] backup_object + # @param [String] update_mask + # Required. A mask specifying which fields (e.g. `expire_time`) in the + # Backup resource should be updated. This mask is relative to the Backup + # resource, not to the request message. The field mask must always be + # specified; this prevents any future fields from being erased accidentally + # by clients that do not know about them. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SpannerV1::Backup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SpannerV1::Backup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_instance_backup(name, backup_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+name}', options) + command.request_representation = Google::Apis::SpannerV1::Backup::Representation + command.request_object = backup_object + command.response_representation = Google::Apis::SpannerV1::Backup::Representation + command.response_class = Google::Apis::SpannerV1::Backup + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on a database or backup resource. # Replaces any existing policy. # Authorization requires `spanner.databases.setIamPolicy` # permission on resource. + # For backups, authorization requires `spanner.backups.setIamPolicy` + # permission on resource. # @param [String] resource # REQUIRED: The Cloud Spanner resource for which the policy is being set. The # format is `projects//instances/` for instance @@ -575,11 +908,15 @@ module Google execute_or_queue_command(command, &block) end - # Returns permissions that the caller has on the specified database resource. + # Returns permissions that the caller has on the specified database or backup + # resource. # Attempting this RPC on a non-existent Cloud Spanner database will # result in a NOT_FOUND error if the user has # `spanner.databases.list` permission on the containing Cloud # Spanner instance. Otherwise returns an empty set of permissions. + # Calling this method on a backup that does not exist will + # result in a NOT_FOUND error if the user has + # `spanner.backups.list` permission on the containing instance. # @param [String] resource # REQUIRED: The Cloud Spanner resource for which permissions are being tested. # The format is `projects//instances/` for instance @@ -766,6 +1103,93 @@ module Google execute_or_queue_command(command, &block) end + # Lists database longrunning-operations. + # A database operation has a name of the form + # `projects//instances//databases//operations/< + # operation>`. + # The long-running operation + # metadata field type + # `metadata.type_url` describes the type of the metadata. Operations returned + # include those that have completed/failed/canceled within the last 7 days, + # and pending operations. + # @param [String] parent + # Required. The instance of the database operations. + # Values are of the form `projects//instances/`. + # @param [String] filter + # An expression that filters the list of returned operations. + # A filter expression consists of a field name, a + # comparison operator, and a value for filtering. + # The value must be a string, a number, or a boolean. The comparison operator + # must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. + # Colon `:` is the contains operator. Filter rules are not case sensitive. + # The following fields in the Operation + # are eligible for filtering: + # * `name` - The name of the long-running operation + # * `done` - False if the operation is in progress, else true. + # * `metadata.@type` - the type of metadata. For example, the type string + # for RestoreDatabaseMetadata is + # `type.googleapis.com/google.spanner.admin.database.v1. + # RestoreDatabaseMetadata`. + # * `metadata.` - any field in metadata.value. + # * `error` - Error associated with the long-running operation. + # * `response.@type` - the type of response. + # * `response.` - any field in response.value. + # You can combine multiple expressions by enclosing each expression in + # parentheses. By default, expressions are combined with AND logic. However, + # you can specify AND, OR, and NOT logic explicitly. + # Here are a few examples: + # * `done:true` - The operation is complete. + # * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1. + # RestoreDatabaseMetadata) AND`
    + # `(metadata.source_type:BACKUP) AND`
    + # `(metadata.backup_info.backup:backup_howl) AND`
    + # `(metadata.name:restored_howl) AND`
    + # `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND`
    + # `(error:*)` - Return operations where: + # * The operation's metadata type is RestoreDatabaseMetadata. + # * The database is restored from a backup. + # * The backup name contains "backup_howl". + # * The restored database's name contains "restored_howl". + # * The operation started before 2018-03-28T14:50:00Z. + # * The operation resulted in an error. + # @param [Fixnum] page_size + # Number of operations to be returned in the response. If 0 or + # less, defaults to the server's maximum allowed page size. + # @param [String] page_token + # If non-empty, `page_token` should contain a + # next_page_token + # from a previous ListDatabaseOperationsResponse to the + # same `parent` and with the same `filter`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SpannerV1::ListDatabaseOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SpannerV1::ListDatabaseOperationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_instance_databaseoperations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/databaseOperations', options) + command.response_representation = Google::Apis::SpannerV1::ListDatabaseOperationsResponse::Representation + command.response_class = Google::Apis::SpannerV1::ListDatabaseOperationsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a new Cloud Spanner database and starts to prepare it for serving. # The returned long-running operation will # have a name of the format `/operations/` and @@ -808,6 +1232,8 @@ module Google end # Drops (aka deletes) a Cloud Spanner database. + # Completed backups for the database will be retained according to their + # `expire_time`. # @param [String] database # Required. The database to be dropped. # @param [String] fields @@ -900,11 +1326,13 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a database resource. - # Returns an empty policy if a database exists but does - # not have a policy set. + # Gets the access control policy for a database or backup resource. + # Returns an empty policy if a database or backup exists but does not have a + # policy set. # Authorization requires `spanner.databases.getIamPolicy` permission on # resource. + # For backups, authorization requires `spanner.backups.getIamPolicy` + # permission on resource. # @param [String] resource # REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. # The format is `projects//instances/` for instance @@ -980,10 +1408,66 @@ module Google execute_or_queue_command(command, &block) end - # Sets the access control policy on a database resource. + # Create a new database by restoring from a completed backup. The new + # database must be in the same project and in an instance with the same + # instance configuration as the instance containing + # the backup. The returned database long-running + # operation has a name of the format + # `projects//instances//databases//operations/< + # operation_id>`, + # and can be used to track the progress of the operation, and to cancel it. + # The metadata field type is + # RestoreDatabaseMetadata. + # The response type + # is Database, if + # successful. Cancelling the returned operation will stop the restore and + # delete the database. + # There can be only one database being restored into an instance at a time. + # Once the restore operation completes, a new restore operation can be + # initiated, without waiting for the optimize operation associated with the + # first restore to complete. + # @param [String] parent + # Required. The name of the instance in which to create the + # restored database. This instance must be in the same project and + # have the same instance configuration as the instance containing + # the source backup. Values are of the form + # `projects//instances/`. + # @param [Google::Apis::SpannerV1::RestoreDatabaseRequest] restore_database_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SpannerV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SpannerV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def restore_database(parent, restore_database_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/databases:restore', options) + command.request_representation = Google::Apis::SpannerV1::RestoreDatabaseRequest::Representation + command.request_object = restore_database_request_object + command.response_representation = Google::Apis::SpannerV1::Operation::Representation + command.response_class = Google::Apis::SpannerV1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the access control policy on a database or backup resource. # Replaces any existing policy. # Authorization requires `spanner.databases.setIamPolicy` # permission on resource. + # For backups, authorization requires `spanner.backups.setIamPolicy` + # permission on resource. # @param [String] resource # REQUIRED: The Cloud Spanner resource for which the policy is being set. The # format is `projects//instances/` for instance @@ -1019,11 +1503,15 @@ module Google execute_or_queue_command(command, &block) end - # Returns permissions that the caller has on the specified database resource. + # Returns permissions that the caller has on the specified database or backup + # resource. # Attempting this RPC on a non-existent Cloud Spanner database will # result in a NOT_FOUND error if the user has # `spanner.databases.list` permission on the containing Cloud # Spanner instance. Otherwise returns an empty set of permissions. + # Calling this method on a backup that does not exist will + # result in a NOT_FOUND error if the user has + # `spanner.backups.list` permission on the containing instance. # @param [String] resource # REQUIRED: The Cloud Spanner resource for which permissions are being tested. # The format is `projects//instances/` for instance diff --git a/generated/google/apis/speech_v1.rb b/generated/google/apis/speech_v1.rb index 93fe1e1c6..a95da2f80 100644 --- a/generated/google/apis/speech_v1.rb +++ b/generated/google/apis/speech_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/speech-to-text/docs/quickstart-protocol module SpeechV1 VERSION = 'V1' - REVISION = '20200220' + REVISION = '20200406' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/speech_v1/classes.rb b/generated/google/apis/speech_v1/classes.rb index 286d9e489..c8a96b3a0 100644 --- a/generated/google/apis/speech_v1/classes.rb +++ b/generated/google/apis/speech_v1/classes.rb @@ -69,6 +69,12 @@ module Google # @return [String] attr_accessor :start_time + # The URI of the audio file being transcribed. Empty if the audio was sent + # as byte content. + # Corresponds to the JSON property `uri` + # @return [String] + attr_accessor :uri + def initialize(**args) update!(**args) end @@ -78,6 +84,7 @@ module Google @last_update_time = args[:last_update_time] if args.key?(:last_update_time) @progress_percent = args[:progress_percent] if args.key?(:progress_percent) @start_time = args[:start_time] if args.key?(:start_time) + @uri = args[:uri] if args.key?(:uri) end end @@ -263,9 +270,6 @@ module Google # This feature is only available in select languages. Setting this for # requests in other languages has no effect at all. # The default 'false' value does not add punctuation to result hypotheses. - # Note: This is currently offered as an experimental service, complimentary - # to all users. In the future this may be exclusively available as a - # premium feature. # Corresponds to the JSON property `enableAutomaticPunctuation` # @return [Boolean] attr_accessor :enable_automatic_punctuation diff --git a/generated/google/apis/speech_v1/representations.rb b/generated/google/apis/speech_v1/representations.rb index cb66fa48b..56edfa2bc 100644 --- a/generated/google/apis/speech_v1/representations.rb +++ b/generated/google/apis/speech_v1/representations.rb @@ -133,6 +133,7 @@ module Google property :last_update_time, as: 'lastUpdateTime' property :progress_percent, as: 'progressPercent' property :start_time, as: 'startTime' + property :uri, as: 'uri' end end diff --git a/generated/google/apis/speech_v1p1beta1.rb b/generated/google/apis/speech_v1p1beta1.rb index 845ff438a..41e3b5c96 100644 --- a/generated/google/apis/speech_v1p1beta1.rb +++ b/generated/google/apis/speech_v1p1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/speech-to-text/docs/quickstart-protocol module SpeechV1p1beta1 VERSION = 'V1p1beta1' - REVISION = '20200220' + REVISION = '20200406' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/speech_v1p1beta1/classes.rb b/generated/google/apis/speech_v1p1beta1/classes.rb index fce8204d4..0913bec22 100644 --- a/generated/google/apis/speech_v1p1beta1/classes.rb +++ b/generated/google/apis/speech_v1p1beta1/classes.rb @@ -69,6 +69,12 @@ module Google # @return [String] attr_accessor :start_time + # The URI of the audio file being transcribed. Empty if the audio was sent + # as byte content. + # Corresponds to the JSON property `uri` + # @return [String] + attr_accessor :uri + def initialize(**args) update!(**args) end @@ -78,6 +84,7 @@ module Google @last_update_time = args[:last_update_time] if args.key?(:last_update_time) @progress_percent = args[:progress_percent] if args.key?(:progress_percent) @start_time = args[:start_time] if args.key?(:start_time) + @uri = args[:uri] if args.key?(:uri) end end @@ -286,9 +293,6 @@ module Google # This feature is only available in select languages. Setting this for # requests in other languages has no effect at all. # The default 'false' value does not add punctuation to result hypotheses. - # Note: This is currently offered as an experimental service, complimentary - # to all users. In the future this may be exclusively available as a - # premium feature. # Corresponds to the JSON property `enableAutomaticPunctuation` # @return [Boolean] attr_accessor :enable_automatic_punctuation diff --git a/generated/google/apis/speech_v1p1beta1/representations.rb b/generated/google/apis/speech_v1p1beta1/representations.rb index 061f7e1d4..4de7848ac 100644 --- a/generated/google/apis/speech_v1p1beta1/representations.rb +++ b/generated/google/apis/speech_v1p1beta1/representations.rb @@ -133,6 +133,7 @@ module Google property :last_update_time, as: 'lastUpdateTime' property :progress_percent, as: 'progressPercent' property :start_time, as: 'startTime' + property :uri, as: 'uri' end end diff --git a/generated/google/apis/speech_v2beta1.rb b/generated/google/apis/speech_v2beta1.rb index 3df5d85df..657fec73b 100644 --- a/generated/google/apis/speech_v2beta1.rb +++ b/generated/google/apis/speech_v2beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/speech-to-text/docs/quickstart-protocol module SpeechV2beta1 VERSION = 'V2beta1' - REVISION = '20200220' + REVISION = '20200326' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/speech_v2beta1/classes.rb b/generated/google/apis/speech_v2beta1/classes.rb index 5ce17ec80..dd9d50105 100644 --- a/generated/google/apis/speech_v2beta1/classes.rb +++ b/generated/google/apis/speech_v2beta1/classes.rb @@ -70,6 +70,12 @@ module Google # @return [String] attr_accessor :start_time + # The URI of the audio file being transcribed. Empty if the audio was sent + # as byte content. + # Corresponds to the JSON property `uri` + # @return [String] + attr_accessor :uri + def initialize(**args) update!(**args) end @@ -79,6 +85,7 @@ module Google @last_update_time = args[:last_update_time] if args.key?(:last_update_time) @progress_percent = args[:progress_percent] if args.key?(:progress_percent) @start_time = args[:start_time] if args.key?(:start_time) + @uri = args[:uri] if args.key?(:uri) end end diff --git a/generated/google/apis/speech_v2beta1/representations.rb b/generated/google/apis/speech_v2beta1/representations.rb index 41a3531ae..b61070a92 100644 --- a/generated/google/apis/speech_v2beta1/representations.rb +++ b/generated/google/apis/speech_v2beta1/representations.rb @@ -85,6 +85,7 @@ module Google property :last_update_time, as: 'lastUpdateTime' property :progress_percent, as: 'progressPercent' property :start_time, as: 'startTime' + property :uri, as: 'uri' end end diff --git a/generated/google/apis/sql_v1beta4.rb b/generated/google/apis/sql_v1beta4.rb index eb9a97ecc..2f8423e96 100644 --- a/generated/google/apis/sql_v1beta4.rb +++ b/generated/google/apis/sql_v1beta4.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/cloud-sql/ module SqlV1beta4 VERSION = 'V1beta4' - REVISION = '20200203' + REVISION = '20200310' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/sql_v1beta4/classes.rb b/generated/google/apis/sql_v1beta4/classes.rb index 655880a2b..8286e1c21 100644 --- a/generated/google/apis/sql_v1beta4/classes.rb +++ b/generated/google/apis/sql_v1beta4/classes.rb @@ -90,8 +90,8 @@ module Google class BackupConfiguration include Google::Apis::Core::Hashable - # Whether binary log is enabled. If backup configuration is disabled, binary - # log must be disabled as well. + # (MySQL only) Whether binary log is enabled. If backup configuration is + # disabled, binarylog must be disabled as well. # Corresponds to the JSON property `binaryLogEnabled` # @return [Boolean] attr_accessor :binary_log_enabled @@ -2236,7 +2236,7 @@ module Google # @return [Array] attr_accessor :authorized_gae_applications - # Availability type (PostgreSQL instances only). Potential values: + # Availability type (PostgreSQL and MySQL instances only). Potential values: #
    ZONAL: The instance serves data from only one zone. # Outages in that zone affect data accessibility.
    REGIONAL: # The instance can serve data from more than one zone in a region (it is diff --git a/generated/google/apis/sql_v1beta4/service.rb b/generated/google/apis/sql_v1beta4/service.rb index af092270b..93d166ba3 100644 --- a/generated/google/apis/sql_v1beta4/service.rb +++ b/generated/google/apis/sql_v1beta4/service.rb @@ -56,11 +56,6 @@ module Google # The ID of the Backup Run to delete. To find a Backup Run ID, use the list # method. - # @param [String] resource_name - # The name of the backupRun to delete. - # Format: - # projects/`project`/locations/`location`/instances/`instance`/backupRuns/` - # backupRun` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -78,14 +73,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_backup_run(project, instance, id, resource_name: nil, fields: nil, quota_user: nil, options: nil, &block) + def delete_backup_run(project, instance, id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}', options) command.response_representation = Google::Apis::SqlV1beta4::Operation::Representation command.response_class = Google::Apis::SqlV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? command.params['id'] = id unless id.nil? - command.query['resourceName'] = resource_name unless resource_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) @@ -98,11 +92,6 @@ module Google # Cloud SQL instance ID. This does not include the project ID. # @param [Fixnum] id # The ID of this Backup Run. - # @param [String] resource_name - # Name of the resource backupRun. - # Format: - # projects/`project`/locations/`location`/instances/`instance`/backupRuns/` - # backupRun` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -120,14 +109,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_backup_run(project, instance, id, resource_name: nil, fields: nil, quota_user: nil, options: nil, &block) + def get_backup_run(project, instance, id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'sql/v1beta4/projects/{project}/instances/{instance}/backupRuns/{id}', options) command.response_representation = Google::Apis::SqlV1beta4::BackupRun::Representation command.response_class = Google::Apis::SqlV1beta4::BackupRun command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? command.params['id'] = id unless id.nil? - command.query['resourceName'] = resource_name unless resource_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) @@ -140,9 +128,6 @@ module Google # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. # @param [Google::Apis::SqlV1beta4::BackupRun] backup_run_object - # @param [String] parent - # The parent resource where Cloud SQL should create this backupRun. - # Format: projects/`project`/locations/`location`/instances/`instance` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -160,7 +145,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_backup_run(project, instance, backup_run_object = nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block) + def insert_backup_run(project, instance, backup_run_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'sql/v1beta4/projects/{project}/instances/{instance}/backupRuns', options) command.request_representation = Google::Apis::SqlV1beta4::BackupRun::Representation command.request_object = backup_run_object @@ -168,7 +153,6 @@ module Google command.response_class = Google::Apis::SqlV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? - command.query['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) @@ -185,9 +169,6 @@ module Google # @param [String] page_token # A previously-returned page token representing part of the larger set of # results to view. - # @param [String] parent - # The parent, which owns this collection of backupRuns. - # Format: projects/`project`/locations/`location`/instances/`instance` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -205,7 +186,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_backup_runs(project, instance, max_results: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_backup_runs(project, instance, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'sql/v1beta4/projects/{project}/instances/{instance}/backupRuns', options) command.response_representation = Google::Apis::SqlV1beta4::BackupRunsListResponse::Representation command.response_class = Google::Apis::SqlV1beta4::BackupRunsListResponse @@ -213,7 +194,6 @@ module Google command.params['instance'] = instance unless instance.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? - command.query['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) @@ -226,11 +206,6 @@ module Google # Database instance ID. This does not include the project ID. # @param [String] database # Name of the database to be deleted in the instance. - # @param [String] resource_name - # The name of the database to delete. - # Format: - # projects/`project`/locations/`location`/instances/`instance`/databases/` - # database` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -248,14 +223,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_database(project, instance, database, resource_name: nil, fields: nil, quota_user: nil, options: nil, &block) + def delete_database(project, instance, database, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}', options) command.response_representation = Google::Apis::SqlV1beta4::Operation::Representation command.response_class = Google::Apis::SqlV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? command.params['database'] = database unless database.nil? - command.query['resourceName'] = resource_name unless resource_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) @@ -269,11 +243,6 @@ module Google # Database instance ID. This does not include the project ID. # @param [String] database # Name of the database in the instance. - # @param [String] resource_name - # Name of the resource database. - # Format: - # projects/`project`/locations/`location`/instances/`instance`/databases/` - # database` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -291,14 +260,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_database(project, instance, database, resource_name: nil, fields: nil, quota_user: nil, options: nil, &block) + def get_database(project, instance, database, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'sql/v1beta4/projects/{project}/instances/{instance}/databases/{database}', options) command.response_representation = Google::Apis::SqlV1beta4::Database::Representation command.response_class = Google::Apis::SqlV1beta4::Database command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? command.params['database'] = database unless database.nil? - command.query['resourceName'] = resource_name unless resource_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) @@ -311,9 +279,6 @@ module Google # @param [String] instance # Database instance ID. This does not include the project ID. # @param [Google::Apis::SqlV1beta4::Database] database_object - # @param [String] parent - # The parent resource where Cloud SQL should add this database. - # Format: projects/`project`/locations/`location`/instances/`instance` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -331,7 +296,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_database(project, instance, database_object = nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block) + def insert_database(project, instance, database_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'sql/v1beta4/projects/{project}/instances/{instance}/databases', options) command.request_representation = Google::Apis::SqlV1beta4::Database::Representation command.request_object = database_object @@ -339,7 +304,6 @@ module Google command.response_class = Google::Apis::SqlV1beta4::Operation command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? - command.query['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) @@ -350,9 +314,6 @@ module Google # Project ID of the project that contains the instance. # @param [String] instance # Cloud SQL instance ID. This does not include the project ID. - # @param [String] parent - # The parent, which owns this collection of databases. - # Format: projects/`project`/locations/`location`/instances/`instance` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -370,13 +331,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_databases(project, instance, parent: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_databases(project, instance, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'sql/v1beta4/projects/{project}/instances/{instance}/databases', options) command.response_representation = Google::Apis::SqlV1beta4::DatabasesListResponse::Representation command.response_class = Google::Apis::SqlV1beta4::DatabasesListResponse command.params['project'] = project unless project.nil? command.params['instance'] = instance unless instance.nil? - command.query['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) @@ -384,12 +344,6 @@ module Google # Partially updates a resource containing information about a database inside # a Cloud SQL instance. This method supports patch semantics. - #