chiu
/
google-api-ruby-client
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Autogenerated update (2020-08-20) 

Delete:
- site_verification_v1

Update:
- admin_directory_v1
- admin_reports_v1
- cloudkms_v1
- cloudscheduler_v1
- cloudscheduler_v1beta1
- gmail_v1
- kgsearch_v1
- oslogin_v1alpha
- serviceconsumermanagement_v1
- serviceconsumermanagement_v1beta1
- servicenetworking_v1
- servicenetworking_v1beta
- serviceusage_v1
- serviceusage_v1beta1
This commit is contained in:
Google APIs 2020-08-20 00:38:21 +00:00
parent e5cce9ef8d
commit ccf85d8cda
36 changed files with 748 additions and 1565 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
api_names_out.yaml
View File

@ -21955,6 +21955,13 @@
"/cloudkms:v1/Binding/members": members "/cloudkms:v1/Binding/members": members
"/cloudkms:v1/Binding/members/member": member "/cloudkms:v1/Binding/members/member": member
"/cloudkms:v1/Binding/role": role "/cloudkms:v1/Binding/role": role
"/cloudkms:v1/CertificateChains": certificate_chains
"/cloudkms:v1/CertificateChains/caviumCerts": cavium_certs
"/cloudkms:v1/CertificateChains/caviumCerts/cavium_cert": cavium_cert
"/cloudkms:v1/CertificateChains/googleCardCerts": google_card_certs
"/cloudkms:v1/CertificateChains/googleCardCerts/google_card_cert": google_card_cert
"/cloudkms:v1/CertificateChains/googlePartitionCerts": google_partition_certs
"/cloudkms:v1/CertificateChains/googlePartitionCerts/google_partition_cert": google_partition_cert
"/cloudkms:v1/CloudAuditOptions": cloud_audit_options "/cloudkms:v1/CloudAuditOptions": cloud_audit_options
"/cloudkms:v1/CloudAuditOptions/logName": log_name "/cloudkms:v1/CloudAuditOptions/logName": log_name
"/cloudkms:v1/Condition": condition "/cloudkms:v1/Condition": condition
@ -22044,6 +22051,7 @@
"/cloudkms:v1/ImportJob/publicKey": public_key "/cloudkms:v1/ImportJob/publicKey": public_key
"/cloudkms:v1/ImportJob/state": state "/cloudkms:v1/ImportJob/state": state
"/cloudkms:v1/KeyOperationAttestation": key_operation_attestation "/cloudkms:v1/KeyOperationAttestation": key_operation_attestation
"/cloudkms:v1/KeyOperationAttestation/certChains": cert_chains
"/cloudkms:v1/KeyOperationAttestation/content": content "/cloudkms:v1/KeyOperationAttestation/content": content
"/cloudkms:v1/KeyOperationAttestation/format": format "/cloudkms:v1/KeyOperationAttestation/format": format
"/cloudkms:v1/KeyRing": key_ring "/cloudkms:v1/KeyRing": key_ring
@ -112062,6 +112070,7 @@
"/oslogin:v1/quotaUser": quota_user "/oslogin:v1/quotaUser": quota_user
"/oslogin:v1alpha/Empty": empty "/oslogin:v1alpha/Empty": empty
"/oslogin:v1alpha/ImportSshPublicKeyResponse": import_ssh_public_key_response "/oslogin:v1alpha/ImportSshPublicKeyResponse": import_ssh_public_key_response
"/oslogin:v1alpha/ImportSshPublicKeyResponse/details": details
"/oslogin:v1alpha/ImportSshPublicKeyResponse/loginProfile": login_profile "/oslogin:v1alpha/ImportSshPublicKeyResponse/loginProfile": login_profile
"/oslogin:v1alpha/LoginProfile": login_profile "/oslogin:v1alpha/LoginProfile": login_profile
"/oslogin:v1alpha/LoginProfile/name": name "/oslogin:v1alpha/LoginProfile/name": name

2
generated/google/apis/admin_directory_v1.rb
View File

@ -27,7 +27,7 @@ module Google
# @see http://developers.google.com/admin-sdk/ # @see http://developers.google.com/admin-sdk/
module AdminDirectoryV1 module AdminDirectoryV1
VERSION = 'DirectoryV1' VERSION = 'DirectoryV1'
REVISION = '20200810' REVISION = '20200819'
# View and manage customer related information # View and manage customer related information
AUTH_ADMIN_DIRECTORY_CUSTOMER = 'https://www.googleapis.com/auth/admin.directory.customer' AUTH_ADMIN_DIRECTORY_CUSTOMER = 'https://www.googleapis.com/auth/admin.directory.customer'

2
generated/google/apis/admin_reports_v1.rb
View File

@ -27,7 +27,7 @@ module Google
# @see http://developers.google.com/admin-sdk/ # @see http://developers.google.com/admin-sdk/
module AdminReportsV1 module AdminReportsV1
VERSION = 'ReportsV1' VERSION = 'ReportsV1'
REVISION = '20200810' REVISION = '20200819'
# View audit reports for your G Suite domain # View audit reports for your G Suite domain
AUTH_ADMIN_REPORTS_AUDIT_READONLY = 'https://www.googleapis.com/auth/admin.reports.audit.readonly' AUTH_ADMIN_REPORTS_AUDIT_READONLY = 'https://www.googleapis.com/auth/admin.reports.audit.readonly'

2
generated/google/apis/cloudkms_v1.rb
View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/kms/ # @see https://cloud.google.com/kms/
module CloudkmsV1 module CloudkmsV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200803' REVISION = '20200814'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

41
generated/google/apis/cloudkms_v1/classes.rb
View File

@ -345,6 +345,39 @@ module Google
end end
end end
# Certificate chains needed to verify the attestation. Certificates in chains
# are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#
# section-7.4.2.
class CertificateChains
include Google::Apis::Core::Hashable
# Cavium certificate chain corresponding to the attestation.
# Corresponds to the JSON property `caviumCerts`
# @return [Array<String>]
attr_accessor :cavium_certs
# Google card certificate chain corresponding to the attestation.
# Corresponds to the JSON property `googleCardCerts`
# @return [Array<String>]
attr_accessor :google_card_certs
# Google partition certificate chain corresponding to the attestation.
# Corresponds to the JSON property `googlePartitionCerts`
# @return [Array<String>]
attr_accessor :google_partition_certs
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cavium_certs = args[:cavium_certs] if args.key?(:cavium_certs)
@google_card_certs = args[:google_card_certs] if args.key?(:google_card_certs)
@google_partition_certs = args[:google_partition_certs] if args.key?(:google_partition_certs)
end
end
# A CryptoKey represents a logical key that can be used for cryptographic # A CryptoKey represents a logical key that can be used for cryptographic
# operations. A CryptoKey is made up of zero or more versions, which represent # operations. A CryptoKey is made up of zero or more versions, which represent
# the actual key material used in cryptographic operations. # the actual key material used in cryptographic operations.
@ -1066,6 +1099,13 @@ module Google
class KeyOperationAttestation class KeyOperationAttestation
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Certificate chains needed to verify the attestation. Certificates in chains
# are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#
# section-7.4.2.
# Corresponds to the JSON property `certChains`
# @return [Google::Apis::CloudkmsV1::CertificateChains]
attr_accessor :cert_chains
# Output only. The attestation data provided by the HSM when the key operation # Output only. The attestation data provided by the HSM when the key operation
# was performed. # was performed.
# Corresponds to the JSON property `content` # Corresponds to the JSON property `content`
@ -1084,6 +1124,7 @@ module Google
# Update properties of this object # Update properties of this object
def update!(**args) def update!(**args)
@cert_chains = args[:cert_chains] if args.key?(:cert_chains)
@content = args[:content] if args.key?(:content) @content = args[:content] if args.key?(:content)
@format = args[:format] if args.key?(:format) @format = args[:format] if args.key?(:format)
end end

17
generated/google/apis/cloudkms_v1/representations.rb
View File

@ -64,6 +64,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport include Google::Apis::Core::JsonObjectSupport
end end
class CertificateChains
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CryptoKey class CryptoKey
class Representation < Google::Apis::Core::JsonRepresentation; end class Representation < Google::Apis::Core::JsonRepresentation; end
@ -307,6 +313,15 @@ module Google
end end
end end
class CertificateChains
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :cavium_certs, as: 'caviumCerts'
collection :google_card_certs, as: 'googleCardCerts'
collection :google_partition_certs, as: 'googlePartitionCerts'
end
end
class CryptoKey class CryptoKey
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
@ -453,6 +468,8 @@ module Google
class KeyOperationAttestation class KeyOperationAttestation
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
property :cert_chains, as: 'certChains', class: Google::Apis::CloudkmsV1::CertificateChains, decorator: Google::Apis::CloudkmsV1::CertificateChains::Representation
property :content, :base64 => true, as: 'content' property :content, :base64 => true, as: 'content'
property :format, as: 'format' property :format, as: 'format'
end end

2
generated/google/apis/cloudscheduler_v1.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/scheduler/ # @see https://cloud.google.com/scheduler/
module CloudschedulerV1 module CloudschedulerV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200716' REVISION = '20200814'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

655
generated/google/apis/cloudscheduler_v1/classes.rb
View File

@ -22,83 +22,65 @@ module Google
module Apis module Apis
module CloudschedulerV1 module CloudschedulerV1
# App Engine target. The job will be pushed to a job handler by means # App Engine target. The job will be pushed to a job handler by means of an HTTP
# of an HTTP request via an http_method such # request via an http_method such as HTTP POST, HTTP GET, etc. The job is
# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an # acknowledged by means of an HTTP response code in the range [200 - 299]. Error
# HTTP response code in the range [200 - 299]. Error 503 is # 503 is considered an App Engine system error instead of an application error.
# considered an App Engine system error instead of an application # Requests returning error 503 will be retried regardless of retry configuration
# error. Requests returning error 503 will be retried regardless of # and not counted against retry counts. Any other response code, or a failure to
# retry configuration and not counted against retry counts. Any other # receive a response before the deadline, constitutes a failed attempt.
# response code, or a failure to receive a response before the
# deadline, constitutes a failed attempt.
class AppEngineHttpTarget class AppEngineHttpTarget
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# App Engine Routing. # App Engine Routing. For more information about services, versions, and
# For more information about services, versions, and instances see # instances see [An Overview of App Engine](https://cloud.google.com/appengine/
# [An Overview of App # docs/python/an-overview-of-app-engine), [Microservices Architecture on Google
# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app- # App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-
# engine), # app-engine), [App Engine Standard request routing](https://cloud.google.com/
# [Microservices Architecture on Google App # appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex
# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app- # request routing](https://cloud.google.com/appengine/docs/flexible/python/how-
# engine), # requests-are-routed).
# [App Engine Standard request
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-
# are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-
# are-routed).
# Corresponds to the JSON property `appEngineRouting` # Corresponds to the JSON property `appEngineRouting`
# @return [Google::Apis::CloudschedulerV1::AppEngineRouting] # @return [Google::Apis::CloudschedulerV1::AppEngineRouting]
attr_accessor :app_engine_routing attr_accessor :app_engine_routing
# Body. # Body. HTTP request body. A request body is allowed only if the HTTP method is
# HTTP request body. A request body is allowed only if the HTTP method is # POST or PUT. It will result in invalid argument error to set a body on a job
# POST or PUT. It will result in invalid argument error to set a body on a # with an incompatible HttpMethod.
# job with an incompatible HttpMethod.
# Corresponds to the JSON property `body` # Corresponds to the JSON property `body`
# NOTE: Values are automatically base64 encoded/decoded in the client library. # NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String] # @return [String]
attr_accessor :body attr_accessor :body
# HTTP request headers. # HTTP request headers. This map contains the header field names and values.
# This map contains the header field names and values. Headers can be set # Headers can be set when the job is created. Cloud Scheduler sets some headers
# when the job is created. # to default values: * `User-Agent`: By default, this header is `"AppEngine-
# Cloud Scheduler sets some headers to default values: # Google; (+http://code.google.com/appengine)"`. This header can be modified,
# * `User-Agent`: By default, this header is # but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/
# `"AppEngine-Google; (+http://code.google.com/appengine)"`. # appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header
# This header can be modified, but Cloud Scheduler will append # will be set to true. If the job has an body, Cloud Scheduler sets the
# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the # following headers: * `Content-Type`: By default, the `Content-Type` header is
# modified `User-Agent`. # set to `"application/octet-stream"`. The default can be overridden by
# * `X-CloudScheduler`: This header will be set to true. # explictly setting `Content-Type` to a particular media type when the job is
# If the job has an body, Cloud Scheduler sets # created. For example, `Content-Type` can be set to `"application/json"`. * `
# the following headers: # Content-Length`: This is computed by Cloud Scheduler. This value is output
# * `Content-Type`: By default, the `Content-Type` header is set to # only. It cannot be changed. The headers below are output only. They cannot be
# `"application/octet-stream"`. The default can be overridden by explictly # set or overridden: * `X-Google-*`: For Google internal use only. * `X-
# setting `Content-Type` to a particular media type when the job is # AppEngine-*`: For Google internal use only. In addition, some App Engine
# created. # headers, which contain job-specific information, are also be sent to the job
# For example, `Content-Type` can be set to `"application/json"`. # handler.
# * `Content-Length`: This is computed by Cloud Scheduler. This value is
# output only. It cannot be changed.
# The headers below are output only. They cannot be set or overridden:
# * `X-Google-*`: For Google internal use only.
# * `X-AppEngine-*`: For Google internal use only.
# In addition, some App Engine headers, which contain
# job-specific information, are also be sent to the job handler.
# Corresponds to the JSON property `headers` # Corresponds to the JSON property `headers`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :headers attr_accessor :headers
# The HTTP method to use for the request. PATCH and OPTIONS are not # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
# permitted.
# Corresponds to the JSON property `httpMethod` # Corresponds to the JSON property `httpMethod`
# @return [String] # @return [String]
attr_accessor :http_method attr_accessor :http_method
# The relative URI. # The relative URI. The relative URL must begin with "/" and must be a valid
# The relative URL must begin with "/" and must be a valid HTTP relative URL. # HTTP relative URL. It can contain a path, query string arguments, and `#`
# It can contain a path, query string arguments, and `#` fragments. # fragments. If the relative URL is empty, then the root path "/" will be used.
# If the relative URL is empty, then the root path "/" will be used.
# No spaces are allowed, and the maximum length allowed is 2083 characters. # No spaces are allowed, and the maximum length allowed is 2083 characters.
# Corresponds to the JSON property `relativeUri` # Corresponds to the JSON property `relativeUri`
# @return [String] # @return [String]
@ -118,96 +100,63 @@ module Google
end end
end end
# App Engine Routing. # App Engine Routing. For more information about services, versions, and
# For more information about services, versions, and instances see # instances see [An Overview of App Engine](https://cloud.google.com/appengine/
# [An Overview of App # docs/python/an-overview-of-app-engine), [Microservices Architecture on Google
# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app- # App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-
# engine), # app-engine), [App Engine Standard request routing](https://cloud.google.com/
# [Microservices Architecture on Google App # appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex
# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app- # request routing](https://cloud.google.com/appengine/docs/flexible/python/how-
# engine), # requests-are-routed).
# [App Engine Standard request
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-
# are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-
# are-routed).
class AppEngineRouting class AppEngineRouting
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Output only. The host that the job is sent to. # Output only. The host that the job is sent to. For more information about how
# For more information about how App Engine requests are routed, see # App Engine requests are routed, see [here](https://cloud.google.com/appengine/
# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests- # docs/standard/python/how-requests-are-routed). The host is constructed as: * `
# are-routed). # host = [application_domain_name]` `| [service] + '.' + [
# The host is constructed as: # application_domain_name]` `| [version] + '.' + [application_domain_name]` `| [
# * `host = [application_domain_name]`</br> # version_dot_service]+ '.' + [application_domain_name]` `| [instance] + '.' + [
# `| [service] + '.' + [application_domain_name]`</br> # application_domain_name]` `| [instance_dot_service] + '.' + [
# `| [version] + '.' + [application_domain_name]`</br> # application_domain_name]` `| [instance_dot_version] + '.' + [
# `| [version_dot_service]+ '.' + [application_domain_name]`</br> # application_domain_name]` `| [instance_dot_version_dot_service] + '.' + [
# `| [instance] + '.' + [application_domain_name]`</br> # application_domain_name]` * `application_domain_name` = The domain name of the
# `| [instance_dot_service] + '.' + [application_domain_name]`</br> # app, for example .appspot.com, which is associated with the job's project ID. *
# `| [instance_dot_version] + '.' + [application_domain_name]`</br> # `service =` service * `version =` version * `version_dot_service =` version `+
# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` # '.' +` service * `instance =` instance * `instance_dot_service =` instance `+
# * `application_domain_name` = The domain name of the app, for # '.' +` service * `instance_dot_version =` instance `+ '.' +` version * `
# example <app-id>.appspot.com, which is associated with the # instance_dot_version_dot_service =` instance `+ '.' +` version `+ '.' +`
# job's project ID. # service If service is empty, then the job will be sent to the service which is
# * `service =` service # the default service when the job is attempted. If version is empty, then the
# * `version =` version # job will be sent to the version which is the default version when the job is
# * `version_dot_service =` # attempted. If instance is empty, then the job will be sent to an instance
# version `+ '.' +` # which is available when the job is attempted. If service, version, or instance
# service # is invalid, then the job will be sent to the default version of the default
# * `instance =` instance # service when the job is attempted.
# * `instance_dot_service =`
# instance `+ '.' +`
# service
# * `instance_dot_version =`
# instance `+ '.' +`
# version
# * `instance_dot_version_dot_service =`
# instance `+ '.' +`
# version `+ '.' +`
# service
# If service is empty, then the job will be sent
# to the service which is the default service when the job is attempted.
# If version is empty, then the job will be sent
# to the version which is the default version when the job is attempted.
# If instance is empty, then the job will be
# sent to an instance which is available when the job is attempted.
# If service,
# version, or
# instance is invalid, then the job will be sent
# to the default version of the default service when the job is attempted.
# Corresponds to the JSON property `host` # Corresponds to the JSON property `host`
# @return [String] # @return [String]
attr_accessor :host attr_accessor :host
# App instance. # App instance. By default, the job is sent to an instance which is available
# By default, the job is sent to an instance which is available when # when the job is attempted. Requests can only be sent to a specific instance if
# the job is attempted. # [manual scaling is used in App Engine Standard](https://cloud.google.com/
# Requests can only be sent to a specific instance if # appengine/docs/python/an-overview-of-app-engine?hl=en_US#
# [manual scaling is used in App Engine # scaling_types_and_instance_classes). App Engine Flex does not support
# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app- # instances. For more information, see [App Engine Standard request routing](
# engine?hl=en_US#scaling_types_and_instance_classes). # https://cloud.google.com/appengine/docs/standard/python/how-requests-are-
# App Engine Flex does not support instances. For more information, see # routed) and [App Engine Flex request routing](https://cloud.google.com/
# [App Engine Standard request # appengine/docs/flexible/python/how-requests-are-routed).
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-
# are-routed)
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-
# are-routed).
# Corresponds to the JSON property `instance` # Corresponds to the JSON property `instance`
# @return [String] # @return [String]
attr_accessor :instance attr_accessor :instance
# App service. # App service. By default, the job is sent to the service which is the default
# By default, the job is sent to the service which is the default
# service when the job is attempted. # service when the job is attempted.
# Corresponds to the JSON property `service` # Corresponds to the JSON property `service`
# @return [String] # @return [String]
attr_accessor :service attr_accessor :service
# App version. # App version. By default, the job is sent to the version which is the default
# By default, the job is sent to the version which is the default
# version when the job is attempted. # version when the job is attempted.
# Corresponds to the JSON property `version` # Corresponds to the JSON property `version`
# @return [String] # @return [String]
@ -226,13 +175,11 @@ module Google
end end
end end
# A generic empty message that you can re-use to avoid defining duplicated # A generic empty message that you can re-use to avoid defining duplicated empty
# empty messages in your APIs. A typical example is to use it as the request # messages in your APIs. A typical example is to use it as the request or the
# or the response type of an API method. For instance: # response type of an API method. For instance: service Foo ` rpc Bar(google.
# service Foo ` # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); # `Empty` is empty JSON object ````.
# `
# The JSON representation for `Empty` is empty JSON object ````.
class Empty class Empty
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -245,37 +192,32 @@ module Google
end end
end end
# Http target. The job will be pushed to the job handler by means of # Http target. The job will be pushed to the job handler by means of an HTTP
# an HTTP request via an http_method such as HTTP # request via an http_method such as HTTP POST, HTTP GET, etc. The job is
# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP # acknowledged by means of an HTTP response code in the range [200 - 299]. A
# response code in the range [200 - 299]. A failure to receive a response # failure to receive a response constitutes a failed execution. For a redirected
# constitutes a failed execution. For a redirected request, the response # request, the response returned by the redirected request is considered.
# returned by the redirected request is considered.
class HttpTarget class HttpTarget
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# HTTP request body. A request body is allowed only if the HTTP # HTTP request body. A request body is allowed only if the HTTP method is POST,
# method is POST, PUT, or PATCH. It is an error to set body on a job with an # PUT, or PATCH. It is an error to set body on a job with an incompatible
# incompatible HttpMethod. # HttpMethod.
# Corresponds to the JSON property `body` # Corresponds to the JSON property `body`
# NOTE: Values are automatically base64 encoded/decoded in the client library. # NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String] # @return [String]
attr_accessor :body attr_accessor :body
# The user can specify HTTP request headers to send with the job's # The user can specify HTTP request headers to send with the job's HTTP request.
# HTTP request. This map contains the header field names and # This map contains the header field names and values. Repeated headers are not
# values. Repeated headers are not supported, but a header value can # supported, but a header value can contain commas. These headers represent a
# contain commas. These headers represent a subset of the headers # subset of the headers that will accompany the job's HTTP request. Some HTTP
# that will accompany the job's HTTP request. Some HTTP request # request headers will be ignored or replaced. A partial list of headers that
# headers will be ignored or replaced. A partial list of headers that # will be ignored or replaced is below: - Host: This will be computed by Cloud
# will be ignored or replaced is below: # Scheduler and derived from uri. * `Content-Length`: This will be computed by
# - Host: This will be computed by Cloud Scheduler and derived from # Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`
# uri. # . * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal
# * `Content-Length`: This will be computed by Cloud Scheduler. # use only. The total size of headers must be less than 80KB.
# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.
# * `X-Google-*`: Google internal use only.
# * `X-AppEngine-*`: Google internal use only.
# The total size of headers must be less than 80KB.
# Corresponds to the JSON property `headers` # Corresponds to the JSON property `headers`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :headers attr_accessor :headers
@ -285,29 +227,25 @@ module Google
# @return [String] # @return [String]
attr_accessor :http_method attr_accessor :http_method
# Contains information needed for generating an # Contains information needed for generating an [OAuth token](https://developers.
# [OAuth token](https://developers.google.com/identity/protocols/OAuth2). # google.com/identity/protocols/OAuth2). This type of authorization should
# This type of authorization should generally only be used when calling Google # generally only be used when calling Google APIs hosted on *.googleapis.com.
# APIs hosted on *.googleapis.com.
# Corresponds to the JSON property `oauthToken` # Corresponds to the JSON property `oauthToken`
# @return [Google::Apis::CloudschedulerV1::OAuthToken] # @return [Google::Apis::CloudschedulerV1::OAuthToken]
attr_accessor :oauth_token attr_accessor :oauth_token
# Contains information needed for generating an # Contains information needed for generating an [OpenID Connect token](https://
# [OpenID Connect # developers.google.com/identity/protocols/OpenIDConnect). This type of
# token](https://developers.google.com/identity/protocols/OpenIDConnect). # authorization can be used for many scenarios, including calling Cloud Run, or
# This type of authorization can be used for many scenarios, including # endpoints where you intend to validate the token yourself.
# calling Cloud Run, or endpoints where you intend to validate the token
# yourself.
# Corresponds to the JSON property `oidcToken` # Corresponds to the JSON property `oidcToken`
# @return [Google::Apis::CloudschedulerV1::OidcToken] # @return [Google::Apis::CloudschedulerV1::OidcToken]
attr_accessor :oidc_token attr_accessor :oidc_token
# Required. The full URI path that the request will be sent to. This string # Required. The full URI path that the request will be sent to. This string must
# must begin with either "http://" or "https://". Some examples of # begin with either "http://" or "https://". Some examples of valid values for
# valid values for uri are: # uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler
# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will # will encode some characters for safety and compatibility. The maximum allowed
# encode some characters for safety and compatibility. The maximum allowed
# URL length is 2083 characters after encoding. # URL length is 2083 characters after encoding.
# Corresponds to the JSON property `uri` # Corresponds to the JSON property `uri`
# @return [String] # @return [String]
@ -328,51 +266,42 @@ module Google
end end
end end
# Configuration for a job. # Configuration for a job. The maximum allowed size for a job is 100KB.
# The maximum allowed size for a job is 100KB.
class Job class Job
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# App Engine target. The job will be pushed to a job handler by means # App Engine target. The job will be pushed to a job handler by means of an HTTP
# of an HTTP request via an http_method such # request via an http_method such as HTTP POST, HTTP GET, etc. The job is
# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an # acknowledged by means of an HTTP response code in the range [200 - 299]. Error
# HTTP response code in the range [200 - 299]. Error 503 is # 503 is considered an App Engine system error instead of an application error.
# considered an App Engine system error instead of an application # Requests returning error 503 will be retried regardless of retry configuration
# error. Requests returning error 503 will be retried regardless of # and not counted against retry counts. Any other response code, or a failure to
# retry configuration and not counted against retry counts. Any other # receive a response before the deadline, constitutes a failed attempt.
# response code, or a failure to receive a response before the
# deadline, constitutes a failed attempt.
# Corresponds to the JSON property `appEngineHttpTarget` # Corresponds to the JSON property `appEngineHttpTarget`
# @return [Google::Apis::CloudschedulerV1::AppEngineHttpTarget] # @return [Google::Apis::CloudschedulerV1::AppEngineHttpTarget]
attr_accessor :app_engine_http_target attr_accessor :app_engine_http_target
# The deadline for job attempts. If the request handler does not respond by # The deadline for job attempts. If the request handler does not respond by this
# this deadline then the request is cancelled and the attempt is marked as a # deadline then the request is cancelled and the attempt is marked as a `
# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in # DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in execution logs.
# execution logs. Cloud Scheduler will retry the job according # Cloud Scheduler will retry the job according to the RetryConfig. The allowed
# to the RetryConfig. # duration for this deadline is: * For HTTP targets, between 15 seconds and 30
# The allowed duration for this deadline is: # minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours.
# * For HTTP targets, between 15 seconds and 30 minutes.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
# Corresponds to the JSON property `attemptDeadline` # Corresponds to the JSON property `attemptDeadline`
# @return [String] # @return [String]
attr_accessor :attempt_deadline attr_accessor :attempt_deadline
# Optionally caller-specified in CreateJob or # Optionally caller-specified in CreateJob or UpdateJob. A human-readable
# UpdateJob. # description for the job. This string must not contain more than 500 characters.
# A human-readable description for the job. This string must not contain
# more than 500 characters.
# Corresponds to the JSON property `description` # Corresponds to the JSON property `description`
# @return [String] # @return [String]
attr_accessor :description attr_accessor :description
# Http target. The job will be pushed to the job handler by means of # Http target. The job will be pushed to the job handler by means of an HTTP
# an HTTP request via an http_method such as HTTP # request via an http_method such as HTTP POST, HTTP GET, etc. The job is
# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP # acknowledged by means of an HTTP response code in the range [200 - 299]. A
# response code in the range [200 - 299]. A failure to receive a response # failure to receive a response constitutes a failed execution. For a redirected
# constitutes a failed execution. For a redirected request, the response # request, the response returned by the redirected request is considered.
# returned by the redirected request is considered.
# Corresponds to the JSON property `httpTarget` # Corresponds to the JSON property `httpTarget`
# @return [Google::Apis::CloudschedulerV1::HttpTarget] # @return [Google::Apis::CloudschedulerV1::HttpTarget]
attr_accessor :http_target attr_accessor :http_target
@ -382,66 +311,54 @@ module Google
# @return [String] # @return [String]
attr_accessor :last_attempt_time attr_accessor :last_attempt_time
# Optionally caller-specified in CreateJob, after # Optionally caller-specified in CreateJob, after which it becomes output only.
# which it becomes output only. # The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/
# The job name. For example: # JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. # hyphens (-), colons (:), or periods (.). For more information, see [
# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), # Identifying projects](https://cloud.google.com/resource-manager/docs/creating-
# hyphens (-), colons (:), or periods (.). # managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID
# For more information, see # for the job's location. The list of available locations can be obtained by
# [Identifying # calling ListLocations. For more information, see https://cloud.google.com/
# projects](https://cloud.google.com/resource-manager/docs/creating-managing- # about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-
# projects#identifying_projects) # 9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
# * `LOCATION_ID` is the canonical ID for the job's location.
# The list of available locations can be obtained by calling
# ListLocations.
# For more information, see https://cloud.google.com/about/locations/.
# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
# hyphens (-), or underscores (_). The maximum length is 500 characters.
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
# Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target. The job will be delivered by publishing a message to the given
# the given Pub/Sub topic. # Pub/Sub topic.
# Corresponds to the JSON property `pubsubTarget` # Corresponds to the JSON property `pubsubTarget`
# @return [Google::Apis::CloudschedulerV1::PubsubTarget] # @return [Google::Apis::CloudschedulerV1::PubsubTarget]
attr_accessor :pubsub_target attr_accessor :pubsub_target
# Settings that determine the retry behavior. # Settings that determine the retry behavior. By default, if a job does not
# By default, if a job does not complete successfully (meaning that # complete successfully (meaning that an acknowledgement is not received from
# an acknowledgement is not received from the handler, then it will be retried # the handler, then it will be retried with exponential backoff according to the
# with exponential backoff according to the settings in RetryConfig. # settings in RetryConfig.
# Corresponds to the JSON property `retryConfig` # Corresponds to the JSON property `retryConfig`
# @return [Google::Apis::CloudschedulerV1::RetryConfig] # @return [Google::Apis::CloudschedulerV1::RetryConfig]
attr_accessor :retry_config attr_accessor :retry_config
# Required, except when used with UpdateJob. # Required, except when used with UpdateJob. Describes the schedule on which the
# Describes the schedule on which the job will be executed. # job will be executed. The schedule can be either of the following types: * [
# The schedule can be either of the following types: # Crontab](http://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](
# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) # https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a
# * English-like # general rule, execution `n + 1` of a job will not begin until execution `n`
# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job- # has finished. Cloud Scheduler will never allow two simultaneously outstanding
# schedules) # executions. For example, this implies that if the `n+1`th execution is
# As a general rule, execution `n + 1` of a job will not begin # scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`
# until execution `n` has finished. Cloud Scheduler will never # th execution will not start until `16:15`. A scheduled start time will be
# allow two simultaneously outstanding executions. For example, # delayed if the previous execution has not ended when its scheduled time occurs.
# this implies that if the `n+1`th execution is scheduled to run at # If retry_count > 0 and a job attempt fails, the job will be tried a total of
# 16:00 but the `n`th execution takes until 16:15, the `n+1`th # retry_count times, with exponential backoff, until the next scheduled start
# execution will not start until `16:15`.
# A scheduled start time will be delayed if the previous
# execution has not ended when its scheduled time occurs.
# If retry_count > 0 and a job attempt fails,
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time. # time.
# Corresponds to the JSON property `schedule` # Corresponds to the JSON property `schedule`
# @return [String] # @return [String]
attr_accessor :schedule attr_accessor :schedule
# Output only. The next time the job is scheduled. Note that this may be a # Output only. The next time the job is scheduled. Note that this may be a retry
# retry of a previously failed attempt or the next execution time # of a previously failed attempt or the next execution time according to the
# according to the schedule. # schedule.
# Corresponds to the JSON property `scheduleTime` # Corresponds to the JSON property `scheduleTime`
# @return [String] # @return [String]
attr_accessor :schedule_time attr_accessor :schedule_time
@ -451,24 +368,22 @@ module Google
# @return [String] # @return [String]
attr_accessor :state attr_accessor :state
# The `Status` type defines a logical error model that is suitable for # The `Status` type defines a logical error model that is suitable for different
# different programming environments, including REST APIs and RPC APIs. It is # programming environments, including REST APIs and RPC APIs. It is used by [
# used by [gRPC](https://github.com/grpc). Each `Status` message contains # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
# three pieces of data: error code, error message, and error details. # data: error code, error message, and error details. You can find out more
# You can find out more about this error model and how to work with it in the # about this error model and how to work with it in the [API Design Guide](https:
# [API Design Guide](https://cloud.google.com/apis/design/errors). # //cloud.google.com/apis/design/errors).
# Corresponds to the JSON property `status` # Corresponds to the JSON property `status`
# @return [Google::Apis::CloudschedulerV1::Status] # @return [Google::Apis::CloudschedulerV1::Status]
attr_accessor :status attr_accessor :status
# Specifies the time zone to be used in interpreting # Specifies the time zone to be used in interpreting schedule. The value of this
# schedule. The value of this field must be a time # field must be a time zone name from the [tz database](http://en.wikipedia.org/
# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). # wiki/Tz_database). Note that some time zones include a provision for daylight
# Note that some time zones include a provision for # savings time. The rules for daylight saving time are determined by the chosen
# daylight savings time. The rules for daylight saving time are # tz. For UTC use the string "utc". If a time zone is not specified, the default
# determined by the chosen tz. For UTC use the string "utc". If a # will be in UTC (also known as GMT).
# time zone is not specified, the default will be in UTC (also known
# as GMT).
# Corresponds to the JSON property `timeZone` # Corresponds to the JSON property `timeZone`
# @return [String] # @return [String]
attr_accessor :time_zone attr_accessor :time_zone
@ -510,12 +425,10 @@ module Google
# @return [Array<Google::Apis::CloudschedulerV1::Job>] # @return [Array<Google::Apis::CloudschedulerV1::Job>]
attr_accessor :jobs attr_accessor :jobs
# A token to retrieve next page of results. Pass this value in the # A token to retrieve next page of results. Pass this value in the page_token
# page_token field in the subsequent call to # field in the subsequent call to ListJobs to retrieve the next page of results.
# ListJobs to retrieve the next page of results. # If this is empty it indicates that there are no more results through which to
# If this is empty it indicates that there are no more results # paginate. The page token is valid for only 2 hours.
# through which to paginate.
# The page token is valid for only 2 hours.
# Corresponds to the JSON property `nextPageToken` # Corresponds to the JSON property `nextPageToken`
# @return [String] # @return [String]
attr_accessor :next_page_token attr_accessor :next_page_token
@ -560,14 +473,14 @@ module Google
class Location class Location
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The friendly name for this location, typically a nearby city name. # The friendly name for this location, typically a nearby city name. For example,
# For example, "Tokyo". # "Tokyo".
# Corresponds to the JSON property `displayName` # Corresponds to the JSON property `displayName`
# @return [String] # @return [String]
attr_accessor :display_name attr_accessor :display_name
# Cross-service attributes for the location. For example # Cross-service attributes for the location. For example `"cloud.googleapis.com/
# `"cloud.googleapis.com/region": "us-east1"` # region": "us-east1"`
# Corresponds to the JSON property `labels` # Corresponds to the JSON property `labels`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :labels attr_accessor :labels
@ -583,8 +496,8 @@ module Google
# @return [Hash<String,Object>] # @return [Hash<String,Object>]
attr_accessor :metadata attr_accessor :metadata
# Resource name for the location, which may vary between implementations. # Resource name for the location, which may vary between implementations. For
# For example: `"projects/example-project/locations/us-east1"` # example: `"projects/example-project/locations/us-east1"`
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
@ -603,24 +516,22 @@ module Google
end end
end end
# Contains information needed for generating an # Contains information needed for generating an [OAuth token](https://developers.
# [OAuth token](https://developers.google.com/identity/protocols/OAuth2). # google.com/identity/protocols/OAuth2). This type of authorization should
# This type of authorization should generally only be used when calling Google # generally only be used when calling Google APIs hosted on *.googleapis.com.
# APIs hosted on *.googleapis.com.
class OAuthToken class OAuthToken
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# OAuth scope to be used for generating OAuth access token. # OAuth scope to be used for generating OAuth access token. If not specified, "
# If not specified, "https://www.googleapis.com/auth/cloud-platform" # https://www.googleapis.com/auth/cloud-platform" will be used.
# will be used.
# Corresponds to the JSON property `scope` # Corresponds to the JSON property `scope`
# @return [String] # @return [String]
attr_accessor :scope attr_accessor :scope
# [Service account email](https://cloud.google.com/iam/docs/service-accounts) # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to
# to be used for generating OAuth token. # be used for generating OAuth token. The service account must be within the
# The service account must be within the same project as the job. The caller # same project as the job. The caller must have iam.serviceAccounts.actAs
# must have iam.serviceAccounts.actAs permission for the service account. # permission for the service account.
# Corresponds to the JSON property `serviceAccountEmail` # Corresponds to the JSON property `serviceAccountEmail`
# @return [String] # @return [String]
attr_accessor :service_account_email attr_accessor :service_account_email
@ -636,12 +547,10 @@ module Google
end end
end end
# Contains information needed for generating an # Contains information needed for generating an [OpenID Connect token](https://
# [OpenID Connect # developers.google.com/identity/protocols/OpenIDConnect). This type of
# token](https://developers.google.com/identity/protocols/OpenIDConnect). # authorization can be used for many scenarios, including calling Cloud Run, or
# This type of authorization can be used for many scenarios, including # endpoints where you intend to validate the token yourself.
# calling Cloud Run, or endpoints where you intend to validate the token
# yourself.
class OidcToken class OidcToken
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -651,10 +560,10 @@ module Google
# @return [String] # @return [String]
attr_accessor :audience attr_accessor :audience
# [Service account email](https://cloud.google.com/iam/docs/service-accounts) # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to
# to be used for generating OIDC token. # be used for generating OIDC token. The service account must be within the same
# The service account must be within the same project as the job. The caller # project as the job. The caller must have iam.serviceAccounts.actAs permission
# must have iam.serviceAccounts.actAs permission for the service account. # for the service account.
# Corresponds to the JSON property `serviceAccountEmail` # Corresponds to the JSON property `serviceAccountEmail`
# @return [String] # @return [String]
attr_accessor :service_account_email attr_accessor :service_account_email
@ -685,24 +594,22 @@ module Google
# A message that is published by publishers and consumed by subscribers. The # A message that is published by publishers and consumed by subscribers. The
# message must contain either a non-empty data field or at least one attribute. # message must contain either a non-empty data field or at least one attribute.
# Note that client libraries represent this object differently # Note that client libraries represent this object differently depending on the
# depending on the language. See the corresponding [client library # language. See the corresponding [client library documentation](https://cloud.
# documentation](https://cloud.google.com/pubsub/docs/reference/libraries) for # google.com/pubsub/docs/reference/libraries) for more information. See [quotas
# more information. See [quotas and limits] # and limits] (https://cloud.google.com/pubsub/quotas) for more information
# (https://cloud.google.com/pubsub/quotas) for more information about message # about message limits.
# limits.
class PubsubMessage class PubsubMessage
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Attributes for this message. If this field is empty, the message must # Attributes for this message. If this field is empty, the message must contain
# contain non-empty data. This can be used to filter messages on the # non-empty data. This can be used to filter messages on the subscription.
# subscription.
# Corresponds to the JSON property `attributes` # Corresponds to the JSON property `attributes`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :attributes attr_accessor :attributes
# The message data field. If this field is empty, the message must contain # The message data field. If this field is empty, the message must contain at
# at least one attribute. # least one attribute.
# Corresponds to the JSON property `data` # Corresponds to the JSON property `data`
# NOTE: Values are automatically base64 encoded/decoded in the client library. # NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String] # @return [String]
@ -719,16 +626,16 @@ module Google
# If non-empty, identifies related messages for which publish order should be # If non-empty, identifies related messages for which publish order should be
# respected. If a `Subscription` has `enable_message_ordering` set to `true`, # respected. If a `Subscription` has `enable_message_ordering` set to `true`,
# messages published with the same non-empty `ordering_key` value will be # messages published with the same non-empty `ordering_key` value will be
# delivered to subscribers in the order in which they are received by the # delivered to subscribers in the order in which they are received by the Pub/
# Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` # Sub system. All `PubsubMessage`s published in a given `PublishRequest` must
# must specify the same `ordering_key` value. # specify the same `ordering_key` value.
# Corresponds to the JSON property `orderingKey` # Corresponds to the JSON property `orderingKey`
# @return [String] # @return [String]
attr_accessor :ordering_key attr_accessor :ordering_key
# The time at which the message was published, populated by the server when # The time at which the message was published, populated by the server when it
# it receives the `Publish` call. It must not be populated by the # receives the `Publish` call. It must not be populated by the publisher in a `
# publisher in a `Publish` call. # Publish` call.
# Corresponds to the JSON property `publishTime` # Corresponds to the JSON property `publishTime`
# @return [String] # @return [String]
attr_accessor :publish_time attr_accessor :publish_time
@ -747,33 +654,30 @@ module Google
end end
end end
# Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target. The job will be delivered by publishing a message to the given
# the given Pub/Sub topic. # Pub/Sub topic.
class PubsubTarget class PubsubTarget
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Attributes for PubsubMessage. # Attributes for PubsubMessage. Pubsub message must contain either non-empty
# Pubsub message must contain either non-empty data, or at least one # data, or at least one attribute.
# attribute.
# Corresponds to the JSON property `attributes` # Corresponds to the JSON property `attributes`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :attributes attr_accessor :attributes
# The message payload for PubsubMessage. # The message payload for PubsubMessage. Pubsub message must contain either non-
# Pubsub message must contain either non-empty data, or at least one # empty data, or at least one attribute.
# attribute.
# Corresponds to the JSON property `data` # Corresponds to the JSON property `data`
# NOTE: Values are automatically base64 encoded/decoded in the client library. # NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String] # @return [String]
attr_accessor :data attr_accessor :data
# Required. The name of the Cloud Pub/Sub topic to which messages will # Required. The name of the Cloud Pub/Sub topic to which messages will be
# be published when a job is delivered. The topic name must be in the # published when a job is delivered. The topic name must be in the same format
# same format as required by PubSub's # as required by PubSub's [PublishRequest.name](https://cloud.google.com/pubsub/
# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/ # docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/
# google.pubsub.v1#publishrequest), # PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the
# for example `projects/PROJECT_ID/topics/TOPIC_ID`. # Cloud Scheduler job.
# The topic must be in the same project as the Cloud Scheduler job.
# Corresponds to the JSON property `topicName` # Corresponds to the JSON property `topicName`
# @return [String] # @return [String]
attr_accessor :topic_name attr_accessor :topic_name
@ -803,69 +707,55 @@ module Google
end end
end end
# Settings that determine the retry behavior. # Settings that determine the retry behavior. By default, if a job does not
# By default, if a job does not complete successfully (meaning that # complete successfully (meaning that an acknowledgement is not received from
# an acknowledgement is not received from the handler, then it will be retried # the handler, then it will be retried with exponential backoff according to the
# with exponential backoff according to the settings in RetryConfig. # settings in RetryConfig.
class RetryConfig class RetryConfig
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The maximum amount of time to wait before retrying a job after # The maximum amount of time to wait before retrying a job after it fails. The
# it fails. # default value of this field is 1 hour.
# The default value of this field is 1 hour.
# Corresponds to the JSON property `maxBackoffDuration` # Corresponds to the JSON property `maxBackoffDuration`
# @return [String] # @return [String]
attr_accessor :max_backoff_duration attr_accessor :max_backoff_duration
# The time between retries will double `max_doublings` times. # The time between retries will double `max_doublings` times. A job's retry
# A job's retry interval starts at # interval starts at min_backoff_duration, then doubles `max_doublings` times,
# min_backoff_duration, then doubles # then increases linearly, and finally retries at intervals of
# `max_doublings` times, then increases linearly, and finally # max_backoff_duration up to retry_count times. For example, if
# retries at intervals of # min_backoff_duration is 10s, max_backoff_duration is 300s, and `max_doublings`
# max_backoff_duration up to # is 3, then the a job will first be retried in 10s. The retry interval will
# retry_count times. # double three times, and then increase linearly by 2^3 * 10s. Finally, the job
# For example, if min_backoff_duration is # will retry at intervals of max_backoff_duration until the job has been
# 10s, max_backoff_duration is 300s, and # attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s,
# `max_doublings` is 3, then the a job will first be retried in 10s. The # 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5.
# retry interval will double three times, and then increase linearly by
# 2^3 * 10s. Finally, the job will retry at intervals of
# max_backoff_duration until the job has
# been attempted retry_count times. Thus, the
# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
# The default value of this field is 5.
# Corresponds to the JSON property `maxDoublings` # Corresponds to the JSON property `maxDoublings`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :max_doublings attr_accessor :max_doublings
# The time limit for retrying a failed job, measured from time when an # The time limit for retrying a failed job, measured from time when an execution
# execution was first attempted. If specified with # was first attempted. If specified with retry_count, the job will be retried
# retry_count, the job will be retried until both # until both limits are reached. The default value for max_retry_duration is
# limits are reached. # zero, which means retry duration is unlimited.
# The default value for max_retry_duration is zero, which means retry
# duration is unlimited.
# Corresponds to the JSON property `maxRetryDuration` # Corresponds to the JSON property `maxRetryDuration`
# @return [String] # @return [String]
attr_accessor :max_retry_duration attr_accessor :max_retry_duration
# The minimum amount of time to wait before retrying a job after # The minimum amount of time to wait before retrying a job after it fails. The
# it fails. # default value of this field is 5 seconds.
# The default value of this field is 5 seconds.
# Corresponds to the JSON property `minBackoffDuration` # Corresponds to the JSON property `minBackoffDuration`
# @return [String] # @return [String]
attr_accessor :min_backoff_duration attr_accessor :min_backoff_duration
# The number of attempts that the system will make to run a job using the # The number of attempts that the system will make to run a job using the
# exponential backoff procedure described by # exponential backoff procedure described by max_doublings. The default value of
# max_doublings. # retry_count is zero. If retry_count is zero, a job attempt will *not* be
# The default value of retry_count is zero. # retried if it fails. Instead the Cloud Scheduler system will wait for the next
# If retry_count is zero, a job attempt will *not* be retried if # scheduled execution time. If retry_count is set to a non-zero number then
# it fails. Instead the Cloud Scheduler system will wait for the # Cloud Scheduler will retry failed attempts, using exponential backoff,
# next scheduled execution time. # retry_count times, or until the next scheduled execution time, whichever comes
# If retry_count is set to a non-zero number then Cloud Scheduler # first. Values greater than 5 and negative values are not allowed.
# will retry failed attempts, using exponential backoff,
# retry_count times, or until the next scheduled execution time,
# whichever comes first.
# Values greater than 5 and negative values are not allowed.
# Corresponds to the JSON property `retryCount` # Corresponds to the JSON property `retryCount`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :retry_count attr_accessor :retry_count
@ -884,8 +774,7 @@ module Google
end end
end end
# Request message for forcing a job to run now using # Request message for forcing a job to run now using RunJob.
# RunJob.
class RunJobRequest class RunJobRequest
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -898,12 +787,12 @@ module Google
end end
end end
# The `Status` type defines a logical error model that is suitable for # The `Status` type defines a logical error model that is suitable for different
# different programming environments, including REST APIs and RPC APIs. It is # programming environments, including REST APIs and RPC APIs. It is used by [
# used by [gRPC](https://github.com/grpc). Each `Status` message contains # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
# three pieces of data: error code, error message, and error details. # data: error code, error message, and error details. You can find out more
# You can find out more about this error model and how to work with it in the # about this error model and how to work with it in the [API Design Guide](https:
# [API Design Guide](https://cloud.google.com/apis/design/errors). # //cloud.google.com/apis/design/errors).
class Status class Status
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -912,15 +801,15 @@ module Google
# @return [Fixnum] # @return [Fixnum]
attr_accessor :code attr_accessor :code
# A list of messages that carry the error details. There is a common set of # A list of messages that carry the error details. There is a common set of
# message types for APIs to use. # message types for APIs to use.
# Corresponds to the JSON property `details` # Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>] # @return [Array<Hash<String,Object>>]
attr_accessor :details attr_accessor :details
# A developer-facing error message, which should be in English. Any # A developer-facing error message, which should be in English. Any user-facing
# user-facing error message should be localized and sent in the # error message should be localized and sent in the google.rpc.Status.details
# google.rpc.Status.details field, or localized by the client. # field, or localized by the client.
# Corresponds to the JSON property `message` # Corresponds to the JSON property `message`
# @return [String] # @return [String]
attr_accessor :message attr_accessor :message

107
generated/google/apis/cloudscheduler_v1/service.rb
View File

@ -118,8 +118,8 @@ module Google
# Creates a job. # Creates a job.
# @param [String] parent # @param [String] parent
# Required. The location name. For example: # Required. The location name. For example: `projects/PROJECT_ID/locations/
# `projects/PROJECT_ID/locations/LOCATION_ID`. # LOCATION_ID`.
# @param [Google::Apis::CloudschedulerV1::Job] job_object # @param [Google::Apis::CloudschedulerV1::Job] job_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -152,8 +152,8 @@ module Google
# Deletes a job. # Deletes a job.
# @param [String] name # @param [String] name
# Required. The job name. For example: # Required. The job name. For example: `projects/PROJECT_ID/locations/
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. # LOCATION_ID/jobs/JOB_ID`.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -183,8 +183,8 @@ module Google
# Gets a job. # Gets a job.
# @param [String] name # @param [String] name
# Required. The job name. For example: # Required. The job name. For example: `projects/PROJECT_ID/locations/
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. # LOCATION_ID/jobs/JOB_ID`.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -214,21 +214,17 @@ module Google
# Lists jobs. # Lists jobs.
# @param [String] parent # @param [String] parent
# Required. The location name. For example: # Required. The location name. For example: `projects/PROJECT_ID/locations/
# `projects/PROJECT_ID/locations/LOCATION_ID`. # LOCATION_ID`.
# @param [Fixnum] page_size # @param [Fixnum] page_size
# Requested page size. # Requested page size. The maximum page size is 500. If unspecified, the page
# The maximum page size is 500. If unspecified, the page size will # size will be the maximum. Fewer jobs than requested might be returned, even if
# be the maximum. Fewer jobs than requested might be returned, # more jobs exist; use next_page_token to determine if more jobs exist.
# even if more jobs exist; use next_page_token to determine if more
# jobs exist.
# @param [String] page_token # @param [String] page_token
# A token identifying a page of results the server will return. To # A token identifying a page of results the server will return. To request the
# request the first page results, page_token must be empty. To # first page results, page_token must be empty. To request the next page of
# request the next page of results, page_token must be the value of # results, page_token must be the value of next_page_token returned from the
# next_page_token returned from # previous call to ListJobs. It is an error to switch the value of filter or
# the previous call to ListJobs. It is an error to
# switch the value of filter or
# order_by while iterating through pages. # order_by while iterating through pages.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -259,33 +255,25 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Updates a job. # Updates a job. If successful, the updated Job is returned. If the job does not
# If successful, the updated Job is returned. If the job does # exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it
# not exist, `NOT_FOUND` is returned. # is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in
# If UpdateJob does not successfully return, it is possible for the # this state may not be executed. If this happens, retry the UpdateJob request
# job to be in an Job.State.UPDATE_FAILED state. A job in this state may
# not be executed. If this happens, retry the UpdateJob request
# until a successful response is received. # until a successful response is received.
# @param [String] name # @param [String] name
# Optionally caller-specified in CreateJob, after # Optionally caller-specified in CreateJob, after which it becomes output only.
# which it becomes output only. # The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/
# The job name. For example: # JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. # hyphens (-), colons (:), or periods (.). For more information, see [
# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), # Identifying projects](https://cloud.google.com/resource-manager/docs/creating-
# hyphens (-), colons (:), or periods (.). # managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID
# For more information, see # for the job's location. The list of available locations can be obtained by
# [Identifying # calling ListLocations. For more information, see https://cloud.google.com/
# projects](https://cloud.google.com/resource-manager/docs/creating-managing- # about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-
# projects#identifying_projects) # 9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
# * `LOCATION_ID` is the canonical ID for the job's location.
# The list of available locations can be obtained by calling
# ListLocations.
# For more information, see https://cloud.google.com/about/locations/.
# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
# hyphens (-), or underscores (_). The maximum length is 500 characters.
# @param [Google::Apis::CloudschedulerV1::Job] job_object # @param [Google::Apis::CloudschedulerV1::Job] job_object
# @param [String] update_mask # @param [String] update_mask
# A mask used to specify which fields of the job are being updated. # A mask used to specify which fields of the job are being updated.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -316,15 +304,13 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Pauses a job. # Pauses a job. If a job is paused then the system will stop executing the job
# If a job is paused then the system will stop executing the job # until it is re-enabled via ResumeJob. The state of the job is stored in state;
# until it is re-enabled via ResumeJob. The # if paused it will be set to Job.State.PAUSED. A job must be in Job.State.
# state of the job is stored in state; if paused it # ENABLED to be paused.
# will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED
# to be paused.
# @param [String] name # @param [String] name
# Required. The job name. For example: # Required. The job name. For example: `projects/PROJECT_ID/locations/
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. # LOCATION_ID/jobs/JOB_ID`.
# @param [Google::Apis::CloudschedulerV1::PauseJobRequest] pause_job_request_object # @param [Google::Apis::CloudschedulerV1::PauseJobRequest] pause_job_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -355,14 +341,12 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Resume a job. # Resume a job. This method reenables a job after it has been Job.State.PAUSED.
# This method reenables a job after it has been Job.State.PAUSED. The # The state of a job is stored in Job.state; after calling this method it will
# state of a job is stored in Job.state; after calling this method it # be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed.
# will be set to Job.State.ENABLED. A job must be in
# Job.State.PAUSED to be resumed.
# @param [String] name # @param [String] name
# Required. The job name. For example: # Required. The job name. For example: `projects/PROJECT_ID/locations/
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. # LOCATION_ID/jobs/JOB_ID`.
# @param [Google::Apis::CloudschedulerV1::ResumeJobRequest] resume_job_request_object # @param [Google::Apis::CloudschedulerV1::ResumeJobRequest] resume_job_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -393,12 +377,11 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Forces a job to run now. # Forces a job to run now. When this method is called, Cloud Scheduler will
# When this method is called, Cloud Scheduler will dispatch the job, even # dispatch the job, even if the job is already running.
# if the job is already running.
# @param [String] name # @param [String] name
# Required. The job name. For example: # Required. The job name. For example: `projects/PROJECT_ID/locations/
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. # LOCATION_ID/jobs/JOB_ID`.
# @param [Google::Apis::CloudschedulerV1::RunJobRequest] run_job_request_object # @param [Google::Apis::CloudschedulerV1::RunJobRequest] run_job_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.

2
generated/google/apis/cloudscheduler_v1beta1.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/scheduler/ # @see https://cloud.google.com/scheduler/
module CloudschedulerV1beta1 module CloudschedulerV1beta1
VERSION = 'V1beta1' VERSION = 'V1beta1'
REVISION = '20200716' REVISION = '20200814'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

657
generated/google/apis/cloudscheduler_v1beta1/classes.rb
View File

@ -22,83 +22,65 @@ module Google
module Apis module Apis
module CloudschedulerV1beta1 module CloudschedulerV1beta1
# App Engine target. The job will be pushed to a job handler by means # App Engine target. The job will be pushed to a job handler by means of an HTTP
# of an HTTP request via an http_method such # request via an http_method such as HTTP POST, HTTP GET, etc. The job is
# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an # acknowledged by means of an HTTP response code in the range [200 - 299]. Error
# HTTP response code in the range [200 - 299]. Error 503 is # 503 is considered an App Engine system error instead of an application error.
# considered an App Engine system error instead of an application # Requests returning error 503 will be retried regardless of retry configuration
# error. Requests returning error 503 will be retried regardless of # and not counted against retry counts. Any other response code, or a failure to
# retry configuration and not counted against retry counts. Any other # receive a response before the deadline, constitutes a failed attempt.
# response code, or a failure to receive a response before the
# deadline, constitutes a failed attempt.
class AppEngineHttpTarget class AppEngineHttpTarget
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# App Engine Routing. # App Engine Routing. For more information about services, versions, and
# For more information about services, versions, and instances see # instances see [An Overview of App Engine](https://cloud.google.com/appengine/
# [An Overview of App # docs/python/an-overview-of-app-engine), [Microservices Architecture on Google
# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app- # App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-
# engine), # app-engine), [App Engine Standard request routing](https://cloud.google.com/
# [Microservices Architecture on Google App # appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex
# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app- # request routing](https://cloud.google.com/appengine/docs/flexible/python/how-
# engine), # requests-are-routed).
# [App Engine Standard request
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-
# are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-
# are-routed).
# Corresponds to the JSON property `appEngineRouting` # Corresponds to the JSON property `appEngineRouting`
# @return [Google::Apis::CloudschedulerV1beta1::AppEngineRouting] # @return [Google::Apis::CloudschedulerV1beta1::AppEngineRouting]
attr_accessor :app_engine_routing attr_accessor :app_engine_routing
# Body. # Body. HTTP request body. A request body is allowed only if the HTTP method is
# HTTP request body. A request body is allowed only if the HTTP method is # POST or PUT. It will result in invalid argument error to set a body on a job
# POST or PUT. It will result in invalid argument error to set a body on a # with an incompatible HttpMethod.
# job with an incompatible HttpMethod.
# Corresponds to the JSON property `body` # Corresponds to the JSON property `body`
# NOTE: Values are automatically base64 encoded/decoded in the client library. # NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String] # @return [String]
attr_accessor :body attr_accessor :body
# HTTP request headers. # HTTP request headers. This map contains the header field names and values.
# This map contains the header field names and values. Headers can be set # Headers can be set when the job is created. Cloud Scheduler sets some headers
# when the job is created. # to default values: * `User-Agent`: By default, this header is `"AppEngine-
# Cloud Scheduler sets some headers to default values: # Google; (+http://code.google.com/appengine)"`. This header can be modified,
# * `User-Agent`: By default, this header is # but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/
# `"AppEngine-Google; (+http://code.google.com/appengine)"`. # appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header
# This header can be modified, but Cloud Scheduler will append # will be set to true. If the job has an body, Cloud Scheduler sets the
# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the # following headers: * `Content-Type`: By default, the `Content-Type` header is
# modified `User-Agent`. # set to `"application/octet-stream"`. The default can be overridden by
# * `X-CloudScheduler`: This header will be set to true. # explictly setting `Content-Type` to a particular media type when the job is
# If the job has an body, Cloud Scheduler sets # created. For example, `Content-Type` can be set to `"application/json"`. * `
# the following headers: # Content-Length`: This is computed by Cloud Scheduler. This value is output
# * `Content-Type`: By default, the `Content-Type` header is set to # only. It cannot be changed. The headers below are output only. They cannot be
# `"application/octet-stream"`. The default can be overridden by explictly # set or overridden: * `X-Google-*`: For Google internal use only. * `X-
# setting `Content-Type` to a particular media type when the job is # AppEngine-*`: For Google internal use only. In addition, some App Engine
# created. # headers, which contain job-specific information, are also be sent to the job
# For example, `Content-Type` can be set to `"application/json"`. # handler.
# * `Content-Length`: This is computed by Cloud Scheduler. This value is
# output only. It cannot be changed.
# The headers below are output only. They cannot be set or overridden:
# * `X-Google-*`: For Google internal use only.
# * `X-AppEngine-*`: For Google internal use only.
# In addition, some App Engine headers, which contain
# job-specific information, are also be sent to the job handler.
# Corresponds to the JSON property `headers` # Corresponds to the JSON property `headers`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :headers attr_accessor :headers
# The HTTP method to use for the request. PATCH and OPTIONS are not # The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
# permitted.
# Corresponds to the JSON property `httpMethod` # Corresponds to the JSON property `httpMethod`
# @return [String] # @return [String]
attr_accessor :http_method attr_accessor :http_method
# The relative URI. # The relative URI. The relative URL must begin with "/" and must be a valid
# The relative URL must begin with "/" and must be a valid HTTP relative URL. # HTTP relative URL. It can contain a path, query string arguments, and `#`
# It can contain a path, query string arguments, and `#` fragments. # fragments. If the relative URL is empty, then the root path "/" will be used.
# If the relative URL is empty, then the root path "/" will be used.
# No spaces are allowed, and the maximum length allowed is 2083 characters. # No spaces are allowed, and the maximum length allowed is 2083 characters.
# Corresponds to the JSON property `relativeUri` # Corresponds to the JSON property `relativeUri`
# @return [String] # @return [String]
@ -118,96 +100,63 @@ module Google
end end
end end
# App Engine Routing. # App Engine Routing. For more information about services, versions, and
# For more information about services, versions, and instances see # instances see [An Overview of App Engine](https://cloud.google.com/appengine/
# [An Overview of App # docs/python/an-overview-of-app-engine), [Microservices Architecture on Google
# Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app- # App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-
# engine), # app-engine), [App Engine Standard request routing](https://cloud.google.com/
# [Microservices Architecture on Google App # appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex
# Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app- # request routing](https://cloud.google.com/appengine/docs/flexible/python/how-
# engine), # requests-are-routed).
# [App Engine Standard request
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-
# are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-
# are-routed).
class AppEngineRouting class AppEngineRouting
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Output only. The host that the job is sent to. # Output only. The host that the job is sent to. For more information about how
# For more information about how App Engine requests are routed, see # App Engine requests are routed, see [here](https://cloud.google.com/appengine/
# [here](https://cloud.google.com/appengine/docs/standard/python/how-requests- # docs/standard/python/how-requests-are-routed). The host is constructed as: * `
# are-routed). # host = [application_domain_name]` `| [service] + '.' + [
# The host is constructed as: # application_domain_name]` `| [version] + '.' + [application_domain_name]` `| [
# * `host = [application_domain_name]`</br> # version_dot_service]+ '.' + [application_domain_name]` `| [instance] + '.' + [
# `| [service] + '.' + [application_domain_name]`</br> # application_domain_name]` `| [instance_dot_service] + '.' + [
# `| [version] + '.' + [application_domain_name]`</br> # application_domain_name]` `| [instance_dot_version] + '.' + [
# `| [version_dot_service]+ '.' + [application_domain_name]`</br> # application_domain_name]` `| [instance_dot_version_dot_service] + '.' + [
# `| [instance] + '.' + [application_domain_name]`</br> # application_domain_name]` * `application_domain_name` = The domain name of the
# `| [instance_dot_service] + '.' + [application_domain_name]`</br> # app, for example .appspot.com, which is associated with the job's project ID. *
# `| [instance_dot_version] + '.' + [application_domain_name]`</br> # `service =` service * `version =` version * `version_dot_service =` version `+
# `| [instance_dot_version_dot_service] + '.' + [application_domain_name]` # '.' +` service * `instance =` instance * `instance_dot_service =` instance `+
# * `application_domain_name` = The domain name of the app, for # '.' +` service * `instance_dot_version =` instance `+ '.' +` version * `
# example <app-id>.appspot.com, which is associated with the # instance_dot_version_dot_service =` instance `+ '.' +` version `+ '.' +`
# job's project ID. # service If service is empty, then the job will be sent to the service which is
# * `service =` service # the default service when the job is attempted. If version is empty, then the
# * `version =` version # job will be sent to the version which is the default version when the job is
# * `version_dot_service =` # attempted. If instance is empty, then the job will be sent to an instance
# version `+ '.' +` # which is available when the job is attempted. If service, version, or instance
# service # is invalid, then the job will be sent to the default version of the default
# * `instance =` instance # service when the job is attempted.
# * `instance_dot_service =`
# instance `+ '.' +`
# service
# * `instance_dot_version =`
# instance `+ '.' +`
# version
# * `instance_dot_version_dot_service =`
# instance `+ '.' +`
# version `+ '.' +`
# service
# If service is empty, then the job will be sent
# to the service which is the default service when the job is attempted.
# If version is empty, then the job will be sent
# to the version which is the default version when the job is attempted.
# If instance is empty, then the job will be
# sent to an instance which is available when the job is attempted.
# If service,
# version, or
# instance is invalid, then the job will be sent
# to the default version of the default service when the job is attempted.
# Corresponds to the JSON property `host` # Corresponds to the JSON property `host`
# @return [String] # @return [String]
attr_accessor :host attr_accessor :host
# App instance. # App instance. By default, the job is sent to an instance which is available
# By default, the job is sent to an instance which is available when # when the job is attempted. Requests can only be sent to a specific instance if
# the job is attempted. # [manual scaling is used in App Engine Standard](https://cloud.google.com/
# Requests can only be sent to a specific instance if # appengine/docs/python/an-overview-of-app-engine?hl=en_US#
# [manual scaling is used in App Engine # scaling_types_and_instance_classes). App Engine Flex does not support
# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app- # instances. For more information, see [App Engine Standard request routing](
# engine?hl=en_US#scaling_types_and_instance_classes). # https://cloud.google.com/appengine/docs/standard/python/how-requests-are-
# App Engine Flex does not support instances. For more information, see # routed) and [App Engine Flex request routing](https://cloud.google.com/
# [App Engine Standard request # appengine/docs/flexible/python/how-requests-are-routed).
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-
# are-routed)
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-
# are-routed).
# Corresponds to the JSON property `instance` # Corresponds to the JSON property `instance`
# @return [String] # @return [String]
attr_accessor :instance attr_accessor :instance
# App service. # App service. By default, the job is sent to the service which is the default
# By default, the job is sent to the service which is the default
# service when the job is attempted. # service when the job is attempted.
# Corresponds to the JSON property `service` # Corresponds to the JSON property `service`
# @return [String] # @return [String]
attr_accessor :service attr_accessor :service
# App version. # App version. By default, the job is sent to the version which is the default
# By default, the job is sent to the version which is the default
# version when the job is attempted. # version when the job is attempted.
# Corresponds to the JSON property `version` # Corresponds to the JSON property `version`
# @return [String] # @return [String]
@ -226,13 +175,11 @@ module Google
end end
end end
# A generic empty message that you can re-use to avoid defining duplicated # A generic empty message that you can re-use to avoid defining duplicated empty
# empty messages in your APIs. A typical example is to use it as the request # messages in your APIs. A typical example is to use it as the request or the
# or the response type of an API method. For instance: # response type of an API method. For instance: service Foo ` rpc Bar(google.
# service Foo ` # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); # `Empty` is empty JSON object ````.
# `
# The JSON representation for `Empty` is empty JSON object ````.
class Empty class Empty
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -245,37 +192,32 @@ module Google
end end
end end
# Http target. The job will be pushed to the job handler by means of # Http target. The job will be pushed to the job handler by means of an HTTP
# an HTTP request via an http_method such as HTTP # request via an http_method such as HTTP POST, HTTP GET, etc. The job is
# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP # acknowledged by means of an HTTP response code in the range [200 - 299]. A
# response code in the range [200 - 299]. A failure to receive a response # failure to receive a response constitutes a failed execution. For a redirected
# constitutes a failed execution. For a redirected request, the response # request, the response returned by the redirected request is considered.
# returned by the redirected request is considered.
class HttpTarget class HttpTarget
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# HTTP request body. A request body is allowed only if the HTTP # HTTP request body. A request body is allowed only if the HTTP method is POST,
# method is POST, PUT, or PATCH. It is an error to set body on a job with an # PUT, or PATCH. It is an error to set body on a job with an incompatible
# incompatible HttpMethod. # HttpMethod.
# Corresponds to the JSON property `body` # Corresponds to the JSON property `body`
# NOTE: Values are automatically base64 encoded/decoded in the client library. # NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String] # @return [String]
attr_accessor :body attr_accessor :body
# The user can specify HTTP request headers to send with the job's # The user can specify HTTP request headers to send with the job's HTTP request.
# HTTP request. This map contains the header field names and # This map contains the header field names and values. Repeated headers are not
# values. Repeated headers are not supported, but a header value can # supported, but a header value can contain commas. These headers represent a
# contain commas. These headers represent a subset of the headers # subset of the headers that will accompany the job's HTTP request. Some HTTP
# that will accompany the job's HTTP request. Some HTTP request # request headers will be ignored or replaced. A partial list of headers that
# headers will be ignored or replaced. A partial list of headers that # will be ignored or replaced is below: - Host: This will be computed by Cloud
# will be ignored or replaced is below: # Scheduler and derived from uri. * `Content-Length`: This will be computed by
# - Host: This will be computed by Cloud Scheduler and derived from # Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`
# uri. # . * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal
# * `Content-Length`: This will be computed by Cloud Scheduler. # use only. The total size of headers must be less than 80KB.
# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.
# * `X-Google-*`: Google internal use only.
# * `X-AppEngine-*`: Google internal use only.
# The total size of headers must be less than 80KB.
# Corresponds to the JSON property `headers` # Corresponds to the JSON property `headers`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :headers attr_accessor :headers
@ -285,29 +227,25 @@ module Google
# @return [String] # @return [String]
attr_accessor :http_method attr_accessor :http_method
# Contains information needed for generating an # Contains information needed for generating an [OAuth token](https://developers.
# [OAuth token](https://developers.google.com/identity/protocols/OAuth2). # google.com/identity/protocols/OAuth2). This type of authorization should
# This type of authorization should generally only be used when calling Google # generally only be used when calling Google APIs hosted on *.googleapis.com.
# APIs hosted on *.googleapis.com.
# Corresponds to the JSON property `oauthToken` # Corresponds to the JSON property `oauthToken`
# @return [Google::Apis::CloudschedulerV1beta1::OAuthToken] # @return [Google::Apis::CloudschedulerV1beta1::OAuthToken]
attr_accessor :oauth_token attr_accessor :oauth_token
# Contains information needed for generating an # Contains information needed for generating an [OpenID Connect token](https://
# [OpenID Connect # developers.google.com/identity/protocols/OpenIDConnect). This type of
# token](https://developers.google.com/identity/protocols/OpenIDConnect). # authorization can be used for many scenarios, including calling Cloud Run, or
# This type of authorization can be used for many scenarios, including # endpoints where you intend to validate the token yourself.
# calling Cloud Run, or endpoints where you intend to validate the token
# yourself.
# Corresponds to the JSON property `oidcToken` # Corresponds to the JSON property `oidcToken`
# @return [Google::Apis::CloudschedulerV1beta1::OidcToken] # @return [Google::Apis::CloudschedulerV1beta1::OidcToken]
attr_accessor :oidc_token attr_accessor :oidc_token
# Required. The full URI path that the request will be sent to. This string # Required. The full URI path that the request will be sent to. This string must
# must begin with either "http://" or "https://". Some examples of # begin with either "http://" or "https://". Some examples of valid values for
# valid values for uri are: # uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler
# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will # will encode some characters for safety and compatibility. The maximum allowed
# encode some characters for safety and compatibility. The maximum allowed
# URL length is 2083 characters after encoding. # URL length is 2083 characters after encoding.
# Corresponds to the JSON property `uri` # Corresponds to the JSON property `uri`
# @return [String] # @return [String]
@ -328,52 +266,43 @@ module Google
end end
end end
# Configuration for a job. # Configuration for a job. The maximum allowed size for a job is 100KB.
# The maximum allowed size for a job is 100KB.
class Job class Job
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# App Engine target. The job will be pushed to a job handler by means # App Engine target. The job will be pushed to a job handler by means of an HTTP
# of an HTTP request via an http_method such # request via an http_method such as HTTP POST, HTTP GET, etc. The job is
# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an # acknowledged by means of an HTTP response code in the range [200 - 299]. Error
# HTTP response code in the range [200 - 299]. Error 503 is # 503 is considered an App Engine system error instead of an application error.
# considered an App Engine system error instead of an application # Requests returning error 503 will be retried regardless of retry configuration
# error. Requests returning error 503 will be retried regardless of # and not counted against retry counts. Any other response code, or a failure to
# retry configuration and not counted against retry counts. Any other # receive a response before the deadline, constitutes a failed attempt.
# response code, or a failure to receive a response before the
# deadline, constitutes a failed attempt.
# Corresponds to the JSON property `appEngineHttpTarget` # Corresponds to the JSON property `appEngineHttpTarget`
# @return [Google::Apis::CloudschedulerV1beta1::AppEngineHttpTarget] # @return [Google::Apis::CloudschedulerV1beta1::AppEngineHttpTarget]
attr_accessor :app_engine_http_target attr_accessor :app_engine_http_target
# The deadline for job attempts. If the request handler does not respond by # The deadline for job attempts. If the request handler does not respond by this
# this deadline then the request is cancelled and the attempt is marked as a # deadline then the request is cancelled and the attempt is marked as a `
# `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in # DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in execution logs.
# execution logs. Cloud Scheduler will retry the job according # Cloud Scheduler will retry the job according to the RetryConfig. The allowed
# to the RetryConfig. # duration for this deadline is: * For HTTP targets, between 15 seconds and 30
# The allowed duration for this deadline is: # minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours. * For
# * For HTTP targets, between 15 seconds and 30 minutes. # PubSub targets, this field is ignored.
# * For App Engine HTTP targets, between 15
# seconds and 24 hours.
# * For PubSub targets, this field is ignored.
# Corresponds to the JSON property `attemptDeadline` # Corresponds to the JSON property `attemptDeadline`
# @return [String] # @return [String]
attr_accessor :attempt_deadline attr_accessor :attempt_deadline
# Optionally caller-specified in CreateJob or # Optionally caller-specified in CreateJob or UpdateJob. A human-readable
# UpdateJob. # description for the job. This string must not contain more than 500 characters.
# A human-readable description for the job. This string must not contain
# more than 500 characters.
# Corresponds to the JSON property `description` # Corresponds to the JSON property `description`
# @return [String] # @return [String]
attr_accessor :description attr_accessor :description
# Http target. The job will be pushed to the job handler by means of # Http target. The job will be pushed to the job handler by means of an HTTP
# an HTTP request via an http_method such as HTTP # request via an http_method such as HTTP POST, HTTP GET, etc. The job is
# POST, HTTP GET, etc. The job is acknowledged by means of an HTTP # acknowledged by means of an HTTP response code in the range [200 - 299]. A
# response code in the range [200 - 299]. A failure to receive a response # failure to receive a response constitutes a failed execution. For a redirected
# constitutes a failed execution. For a redirected request, the response # request, the response returned by the redirected request is considered.
# returned by the redirected request is considered.
# Corresponds to the JSON property `httpTarget` # Corresponds to the JSON property `httpTarget`
# @return [Google::Apis::CloudschedulerV1beta1::HttpTarget] # @return [Google::Apis::CloudschedulerV1beta1::HttpTarget]
attr_accessor :http_target attr_accessor :http_target
@ -383,66 +312,54 @@ module Google
# @return [String] # @return [String]
attr_accessor :last_attempt_time attr_accessor :last_attempt_time
# Optionally caller-specified in CreateJob, after # Optionally caller-specified in CreateJob, after which it becomes output only.
# which it becomes output only. # The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/
# The job name. For example: # JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. # hyphens (-), colons (:), or periods (.). For more information, see [
# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), # Identifying projects](https://cloud.google.com/resource-manager/docs/creating-
# hyphens (-), colons (:), or periods (.). # managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID
# For more information, see # for the job's location. The list of available locations can be obtained by
# [Identifying # calling ListLocations. For more information, see https://cloud.google.com/
# projects](https://cloud.google.com/resource-manager/docs/creating-managing- # about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-
# projects#identifying_projects) # 9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
# * `LOCATION_ID` is the canonical ID for the job's location.
# The list of available locations can be obtained by calling
# ListLocations.
# For more information, see https://cloud.google.com/about/locations/.
# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
# hyphens (-), or underscores (_). The maximum length is 500 characters.
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
# Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target. The job will be delivered by publishing a message to the given
# the given Pub/Sub topic. # Pub/Sub topic.
# Corresponds to the JSON property `pubsubTarget` # Corresponds to the JSON property `pubsubTarget`
# @return [Google::Apis::CloudschedulerV1beta1::PubsubTarget] # @return [Google::Apis::CloudschedulerV1beta1::PubsubTarget]
attr_accessor :pubsub_target attr_accessor :pubsub_target
# Settings that determine the retry behavior. # Settings that determine the retry behavior. By default, if a job does not
# By default, if a job does not complete successfully (meaning that # complete successfully (meaning that an acknowledgement is not received from
# an acknowledgement is not received from the handler, then it will be retried # the handler, then it will be retried with exponential backoff according to the
# with exponential backoff according to the settings in RetryConfig. # settings in RetryConfig.
# Corresponds to the JSON property `retryConfig` # Corresponds to the JSON property `retryConfig`
# @return [Google::Apis::CloudschedulerV1beta1::RetryConfig] # @return [Google::Apis::CloudschedulerV1beta1::RetryConfig]
attr_accessor :retry_config attr_accessor :retry_config
# Required, except when used with UpdateJob. # Required, except when used with UpdateJob. Describes the schedule on which the
# Describes the schedule on which the job will be executed. # job will be executed. The schedule can be either of the following types: * [
# The schedule can be either of the following types: # Crontab](http://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](
# * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) # https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a
# * English-like # general rule, execution `n + 1` of a job will not begin until execution `n`
# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job- # has finished. Cloud Scheduler will never allow two simultaneously outstanding
# schedules) # executions. For example, this implies that if the `n+1`th execution is
# As a general rule, execution `n + 1` of a job will not begin # scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`
# until execution `n` has finished. Cloud Scheduler will never # th execution will not start until `16:15`. A scheduled start time will be
# allow two simultaneously outstanding executions. For example, # delayed if the previous execution has not ended when its scheduled time occurs.
# this implies that if the `n+1`th execution is scheduled to run at # If retry_count > 0 and a job attempt fails, the job will be tried a total of
# 16:00 but the `n`th execution takes until 16:15, the `n+1`th # retry_count times, with exponential backoff, until the next scheduled start
# execution will not start until `16:15`.
# A scheduled start time will be delayed if the previous
# execution has not ended when its scheduled time occurs.
# If retry_count > 0 and a job attempt fails,
# the job will be tried a total of retry_count
# times, with exponential backoff, until the next scheduled start
# time. # time.
# Corresponds to the JSON property `schedule` # Corresponds to the JSON property `schedule`
# @return [String] # @return [String]
attr_accessor :schedule attr_accessor :schedule
# Output only. The next time the job is scheduled. Note that this may be a # Output only. The next time the job is scheduled. Note that this may be a retry
# retry of a previously failed attempt or the next execution time # of a previously failed attempt or the next execution time according to the
# according to the schedule. # schedule.
# Corresponds to the JSON property `scheduleTime` # Corresponds to the JSON property `scheduleTime`
# @return [String] # @return [String]
attr_accessor :schedule_time attr_accessor :schedule_time
@ -452,24 +369,22 @@ module Google
# @return [String] # @return [String]
attr_accessor :state attr_accessor :state
# The `Status` type defines a logical error model that is suitable for # The `Status` type defines a logical error model that is suitable for different
# different programming environments, including REST APIs and RPC APIs. It is # programming environments, including REST APIs and RPC APIs. It is used by [
# used by [gRPC](https://github.com/grpc). Each `Status` message contains # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
# three pieces of data: error code, error message, and error details. # data: error code, error message, and error details. You can find out more
# You can find out more about this error model and how to work with it in the # about this error model and how to work with it in the [API Design Guide](https:
# [API Design Guide](https://cloud.google.com/apis/design/errors). # //cloud.google.com/apis/design/errors).
# Corresponds to the JSON property `status` # Corresponds to the JSON property `status`
# @return [Google::Apis::CloudschedulerV1beta1::Status] # @return [Google::Apis::CloudschedulerV1beta1::Status]
attr_accessor :status attr_accessor :status
# Specifies the time zone to be used in interpreting # Specifies the time zone to be used in interpreting schedule. The value of this
# schedule. The value of this field must be a time # field must be a time zone name from the [tz database](http://en.wikipedia.org/
# zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). # wiki/Tz_database). Note that some time zones include a provision for daylight
# Note that some time zones include a provision for # savings time. The rules for daylight saving time are determined by the chosen
# daylight savings time. The rules for daylight saving time are # tz. For UTC use the string "utc". If a time zone is not specified, the default
# determined by the chosen tz. For UTC use the string "utc". If a # will be in UTC (also known as GMT).
# time zone is not specified, the default will be in UTC (also known
# as GMT).
# Corresponds to the JSON property `timeZone` # Corresponds to the JSON property `timeZone`
# @return [String] # @return [String]
attr_accessor :time_zone attr_accessor :time_zone
@ -511,12 +426,10 @@ module Google
# @return [Array<Google::Apis::CloudschedulerV1beta1::Job>] # @return [Array<Google::Apis::CloudschedulerV1beta1::Job>]
attr_accessor :jobs attr_accessor :jobs
# A token to retrieve next page of results. Pass this value in the # A token to retrieve next page of results. Pass this value in the page_token
# page_token field in the subsequent call to # field in the subsequent call to ListJobs to retrieve the next page of results.
# ListJobs to retrieve the next page of results. # If this is empty it indicates that there are no more results through which to
# If this is empty it indicates that there are no more results # paginate. The page token is valid for only 2 hours.
# through which to paginate.
# The page token is valid for only 2 hours.
# Corresponds to the JSON property `nextPageToken` # Corresponds to the JSON property `nextPageToken`
# @return [String] # @return [String]
attr_accessor :next_page_token attr_accessor :next_page_token
@ -561,14 +474,14 @@ module Google
class Location class Location
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The friendly name for this location, typically a nearby city name. # The friendly name for this location, typically a nearby city name. For example,
# For example, "Tokyo". # "Tokyo".
# Corresponds to the JSON property `displayName` # Corresponds to the JSON property `displayName`
# @return [String] # @return [String]
attr_accessor :display_name attr_accessor :display_name
# Cross-service attributes for the location. For example # Cross-service attributes for the location. For example `"cloud.googleapis.com/
# `"cloud.googleapis.com/region": "us-east1"` # region": "us-east1"`
# Corresponds to the JSON property `labels` # Corresponds to the JSON property `labels`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :labels attr_accessor :labels
@ -584,8 +497,8 @@ module Google
# @return [Hash<String,Object>] # @return [Hash<String,Object>]
attr_accessor :metadata attr_accessor :metadata
# Resource name for the location, which may vary between implementations. # Resource name for the location, which may vary between implementations. For
# For example: `"projects/example-project/locations/us-east1"` # example: `"projects/example-project/locations/us-east1"`
# Corresponds to the JSON property `name` # Corresponds to the JSON property `name`
# @return [String] # @return [String]
attr_accessor :name attr_accessor :name
@ -604,24 +517,22 @@ module Google
end end
end end
# Contains information needed for generating an # Contains information needed for generating an [OAuth token](https://developers.
# [OAuth token](https://developers.google.com/identity/protocols/OAuth2). # google.com/identity/protocols/OAuth2). This type of authorization should
# This type of authorization should generally only be used when calling Google # generally only be used when calling Google APIs hosted on *.googleapis.com.
# APIs hosted on *.googleapis.com.
class OAuthToken class OAuthToken
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# OAuth scope to be used for generating OAuth access token. # OAuth scope to be used for generating OAuth access token. If not specified, "
# If not specified, "https://www.googleapis.com/auth/cloud-platform" # https://www.googleapis.com/auth/cloud-platform" will be used.
# will be used.
# Corresponds to the JSON property `scope` # Corresponds to the JSON property `scope`
# @return [String] # @return [String]
attr_accessor :scope attr_accessor :scope
# [Service account email](https://cloud.google.com/iam/docs/service-accounts) # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to
# to be used for generating OAuth token. # be used for generating OAuth token. The service account must be within the
# The service account must be within the same project as the job. The caller # same project as the job. The caller must have iam.serviceAccounts.actAs
# must have iam.serviceAccounts.actAs permission for the service account. # permission for the service account.
# Corresponds to the JSON property `serviceAccountEmail` # Corresponds to the JSON property `serviceAccountEmail`
# @return [String] # @return [String]
attr_accessor :service_account_email attr_accessor :service_account_email
@ -637,12 +548,10 @@ module Google
end end
end end
# Contains information needed for generating an # Contains information needed for generating an [OpenID Connect token](https://
# [OpenID Connect # developers.google.com/identity/protocols/OpenIDConnect). This type of
# token](https://developers.google.com/identity/protocols/OpenIDConnect). # authorization can be used for many scenarios, including calling Cloud Run, or
# This type of authorization can be used for many scenarios, including # endpoints where you intend to validate the token yourself.
# calling Cloud Run, or endpoints where you intend to validate the token
# yourself.
class OidcToken class OidcToken
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -652,10 +561,10 @@ module Google
# @return [String] # @return [String]
attr_accessor :audience attr_accessor :audience
# [Service account email](https://cloud.google.com/iam/docs/service-accounts) # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to
# to be used for generating OIDC token. # be used for generating OIDC token. The service account must be within the same
# The service account must be within the same project as the job. The caller # project as the job. The caller must have iam.serviceAccounts.actAs permission
# must have iam.serviceAccounts.actAs permission for the service account. # for the service account.
# Corresponds to the JSON property `serviceAccountEmail` # Corresponds to the JSON property `serviceAccountEmail`
# @return [String] # @return [String]
attr_accessor :service_account_email attr_accessor :service_account_email
@ -686,24 +595,22 @@ module Google
# A message that is published by publishers and consumed by subscribers. The # A message that is published by publishers and consumed by subscribers. The
# message must contain either a non-empty data field or at least one attribute. # message must contain either a non-empty data field or at least one attribute.
# Note that client libraries represent this object differently # Note that client libraries represent this object differently depending on the
# depending on the language. See the corresponding [client library # language. See the corresponding [client library documentation](https://cloud.
# documentation](https://cloud.google.com/pubsub/docs/reference/libraries) for # google.com/pubsub/docs/reference/libraries) for more information. See [quotas
# more information. See [quotas and limits] # and limits] (https://cloud.google.com/pubsub/quotas) for more information
# (https://cloud.google.com/pubsub/quotas) for more information about message # about message limits.
# limits.
class PubsubMessage class PubsubMessage
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Attributes for this message. If this field is empty, the message must # Attributes for this message. If this field is empty, the message must contain
# contain non-empty data. This can be used to filter messages on the # non-empty data. This can be used to filter messages on the subscription.
# subscription.
# Corresponds to the JSON property `attributes` # Corresponds to the JSON property `attributes`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :attributes attr_accessor :attributes
# The message data field. If this field is empty, the message must contain # The message data field. If this field is empty, the message must contain at
# at least one attribute. # least one attribute.
# Corresponds to the JSON property `data` # Corresponds to the JSON property `data`
# NOTE: Values are automatically base64 encoded/decoded in the client library. # NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String] # @return [String]
@ -720,16 +627,16 @@ module Google
# If non-empty, identifies related messages for which publish order should be # If non-empty, identifies related messages for which publish order should be
# respected. If a `Subscription` has `enable_message_ordering` set to `true`, # respected. If a `Subscription` has `enable_message_ordering` set to `true`,
# messages published with the same non-empty `ordering_key` value will be # messages published with the same non-empty `ordering_key` value will be
# delivered to subscribers in the order in which they are received by the # delivered to subscribers in the order in which they are received by the Pub/
# Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` # Sub system. All `PubsubMessage`s published in a given `PublishRequest` must
# must specify the same `ordering_key` value. # specify the same `ordering_key` value.
# Corresponds to the JSON property `orderingKey` # Corresponds to the JSON property `orderingKey`
# @return [String] # @return [String]
attr_accessor :ordering_key attr_accessor :ordering_key
# The time at which the message was published, populated by the server when # The time at which the message was published, populated by the server when it
# it receives the `Publish` call. It must not be populated by the # receives the `Publish` call. It must not be populated by the publisher in a `
# publisher in a `Publish` call. # Publish` call.
# Corresponds to the JSON property `publishTime` # Corresponds to the JSON property `publishTime`
# @return [String] # @return [String]
attr_accessor :publish_time attr_accessor :publish_time
@ -748,33 +655,30 @@ module Google
end end
end end
# Pub/Sub target. The job will be delivered by publishing a message to # Pub/Sub target. The job will be delivered by publishing a message to the given
# the given Pub/Sub topic. # Pub/Sub topic.
class PubsubTarget class PubsubTarget
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Attributes for PubsubMessage. # Attributes for PubsubMessage. Pubsub message must contain either non-empty
# Pubsub message must contain either non-empty data, or at least one # data, or at least one attribute.
# attribute.
# Corresponds to the JSON property `attributes` # Corresponds to the JSON property `attributes`
# @return [Hash<String,String>] # @return [Hash<String,String>]
attr_accessor :attributes attr_accessor :attributes
# The message payload for PubsubMessage. # The message payload for PubsubMessage. Pubsub message must contain either non-
# Pubsub message must contain either non-empty data, or at least one # empty data, or at least one attribute.
# attribute.
# Corresponds to the JSON property `data` # Corresponds to the JSON property `data`
# NOTE: Values are automatically base64 encoded/decoded in the client library. # NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String] # @return [String]
attr_accessor :data attr_accessor :data
# Required. The name of the Cloud Pub/Sub topic to which messages will # Required. The name of the Cloud Pub/Sub topic to which messages will be
# be published when a job is delivered. The topic name must be in the # published when a job is delivered. The topic name must be in the same format
# same format as required by PubSub's # as required by PubSub's [PublishRequest.name](https://cloud.google.com/pubsub/
# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/ # docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/
# google.pubsub.v1#publishrequest), # PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the
# for example `projects/PROJECT_ID/topics/TOPIC_ID`. # Cloud Scheduler job.
# The topic must be in the same project as the Cloud Scheduler job.
# Corresponds to the JSON property `topicName` # Corresponds to the JSON property `topicName`
# @return [String] # @return [String]
attr_accessor :topic_name attr_accessor :topic_name
@ -804,69 +708,55 @@ module Google
end end
end end
# Settings that determine the retry behavior. # Settings that determine the retry behavior. By default, if a job does not
# By default, if a job does not complete successfully (meaning that # complete successfully (meaning that an acknowledgement is not received from
# an acknowledgement is not received from the handler, then it will be retried # the handler, then it will be retried with exponential backoff according to the
# with exponential backoff according to the settings in RetryConfig. # settings in RetryConfig.
class RetryConfig class RetryConfig
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The maximum amount of time to wait before retrying a job after # The maximum amount of time to wait before retrying a job after it fails. The
# it fails. # default value of this field is 1 hour.
# The default value of this field is 1 hour.
# Corresponds to the JSON property `maxBackoffDuration` # Corresponds to the JSON property `maxBackoffDuration`
# @return [String] # @return [String]
attr_accessor :max_backoff_duration attr_accessor :max_backoff_duration
# The time between retries will double `max_doublings` times. # The time between retries will double `max_doublings` times. A job's retry
# A job's retry interval starts at # interval starts at min_backoff_duration, then doubles `max_doublings` times,
# min_backoff_duration, then doubles # then increases linearly, and finally retries at intervals of
# `max_doublings` times, then increases linearly, and finally # max_backoff_duration up to retry_count times. For example, if
# retries at intervals of # min_backoff_duration is 10s, max_backoff_duration is 300s, and `max_doublings`
# max_backoff_duration up to # is 3, then the a job will first be retried in 10s. The retry interval will
# retry_count times. # double three times, and then increase linearly by 2^3 * 10s. Finally, the job
# For example, if min_backoff_duration is # will retry at intervals of max_backoff_duration until the job has been
# 10s, max_backoff_duration is 300s, and # attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s,
# `max_doublings` is 3, then the a job will first be retried in 10s. The # 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5.
# retry interval will double three times, and then increase linearly by
# 2^3 * 10s. Finally, the job will retry at intervals of
# max_backoff_duration until the job has
# been attempted retry_count times. Thus, the
# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
# The default value of this field is 5.
# Corresponds to the JSON property `maxDoublings` # Corresponds to the JSON property `maxDoublings`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :max_doublings attr_accessor :max_doublings
# The time limit for retrying a failed job, measured from time when an # The time limit for retrying a failed job, measured from time when an execution
# execution was first attempted. If specified with # was first attempted. If specified with retry_count, the job will be retried
# retry_count, the job will be retried until both # until both limits are reached. The default value for max_retry_duration is
# limits are reached. # zero, which means retry duration is unlimited.
# The default value for max_retry_duration is zero, which means retry
# duration is unlimited.
# Corresponds to the JSON property `maxRetryDuration` # Corresponds to the JSON property `maxRetryDuration`
# @return [String] # @return [String]
attr_accessor :max_retry_duration attr_accessor :max_retry_duration
# The minimum amount of time to wait before retrying a job after # The minimum amount of time to wait before retrying a job after it fails. The
# it fails. # default value of this field is 5 seconds.
# The default value of this field is 5 seconds.
# Corresponds to the JSON property `minBackoffDuration` # Corresponds to the JSON property `minBackoffDuration`
# @return [String] # @return [String]
attr_accessor :min_backoff_duration attr_accessor :min_backoff_duration
# The number of attempts that the system will make to run a job using the # The number of attempts that the system will make to run a job using the
# exponential backoff procedure described by # exponential backoff procedure described by max_doublings. The default value of
# max_doublings. # retry_count is zero. If retry_count is zero, a job attempt will *not* be
# The default value of retry_count is zero. # retried if it fails. Instead the Cloud Scheduler system will wait for the next
# If retry_count is zero, a job attempt will *not* be retried if # scheduled execution time. If retry_count is set to a non-zero number then
# it fails. Instead the Cloud Scheduler system will wait for the # Cloud Scheduler will retry failed attempts, using exponential backoff,
# next scheduled execution time. # retry_count times, or until the next scheduled execution time, whichever comes
# If retry_count is set to a non-zero number then Cloud Scheduler # first. Values greater than 5 and negative values are not allowed.
# will retry failed attempts, using exponential backoff,
# retry_count times, or until the next scheduled execution time,
# whichever comes first.
# Values greater than 5 and negative values are not allowed.
# Corresponds to the JSON property `retryCount` # Corresponds to the JSON property `retryCount`
# @return [Fixnum] # @return [Fixnum]
attr_accessor :retry_count attr_accessor :retry_count
@ -885,8 +775,7 @@ module Google
end end
end end
# Request message for forcing a job to run now using # Request message for forcing a job to run now using RunJob.
# RunJob.
class RunJobRequest class RunJobRequest
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -899,12 +788,12 @@ module Google
end end
end end
# The `Status` type defines a logical error model that is suitable for # The `Status` type defines a logical error model that is suitable for different
# different programming environments, including REST APIs and RPC APIs. It is # programming environments, including REST APIs and RPC APIs. It is used by [
# used by [gRPC](https://github.com/grpc). Each `Status` message contains # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
# three pieces of data: error code, error message, and error details. # data: error code, error message, and error details. You can find out more
# You can find out more about this error model and how to work with it in the # about this error model and how to work with it in the [API Design Guide](https:
# [API Design Guide](https://cloud.google.com/apis/design/errors). # //cloud.google.com/apis/design/errors).
class Status class Status
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
@ -913,15 +802,15 @@ module Google
# @return [Fixnum] # @return [Fixnum]
attr_accessor :code attr_accessor :code
# A list of messages that carry the error details. There is a common set of # A list of messages that carry the error details. There is a common set of
# message types for APIs to use. # message types for APIs to use.
# Corresponds to the JSON property `details` # Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>] # @return [Array<Hash<String,Object>>]
attr_accessor :details attr_accessor :details
# A developer-facing error message, which should be in English. Any # A developer-facing error message, which should be in English. Any user-facing
# user-facing error message should be localized and sent in the # error message should be localized and sent in the google.rpc.Status.details
# google.rpc.Status.details field, or localized by the client. # field, or localized by the client.
# Corresponds to the JSON property `message` # Corresponds to the JSON property `message`
# @return [String] # @return [String]
attr_accessor :message attr_accessor :message

107
generated/google/apis/cloudscheduler_v1beta1/service.rb
View File

@ -118,8 +118,8 @@ module Google
# Creates a job. # Creates a job.
# @param [String] parent # @param [String] parent
# Required. The location name. For example: # Required. The location name. For example: `projects/PROJECT_ID/locations/
# `projects/PROJECT_ID/locations/LOCATION_ID`. # LOCATION_ID`.
# @param [Google::Apis::CloudschedulerV1beta1::Job] job_object # @param [Google::Apis::CloudschedulerV1beta1::Job] job_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -152,8 +152,8 @@ module Google
# Deletes a job. # Deletes a job.
# @param [String] name # @param [String] name
# Required. The job name. For example: # Required. The job name. For example: `projects/PROJECT_ID/locations/
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. # LOCATION_ID/jobs/JOB_ID`.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -183,8 +183,8 @@ module Google
# Gets a job. # Gets a job.
# @param [String] name # @param [String] name
# Required. The job name. For example: # Required. The job name. For example: `projects/PROJECT_ID/locations/
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. # LOCATION_ID/jobs/JOB_ID`.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -214,21 +214,17 @@ module Google
# Lists jobs. # Lists jobs.
# @param [String] parent # @param [String] parent
# Required. The location name. For example: # Required. The location name. For example: `projects/PROJECT_ID/locations/
# `projects/PROJECT_ID/locations/LOCATION_ID`. # LOCATION_ID`.
# @param [Fixnum] page_size # @param [Fixnum] page_size
# Requested page size. # Requested page size. The maximum page size is 500. If unspecified, the page
# The maximum page size is 500. If unspecified, the page size will # size will be the maximum. Fewer jobs than requested might be returned, even if
# be the maximum. Fewer jobs than requested might be returned, # more jobs exist; use next_page_token to determine if more jobs exist.
# even if more jobs exist; use next_page_token to determine if more
# jobs exist.
# @param [String] page_token # @param [String] page_token
# A token identifying a page of results the server will return. To # A token identifying a page of results the server will return. To request the
# request the first page results, page_token must be empty. To # first page results, page_token must be empty. To request the next page of
# request the next page of results, page_token must be the value of # results, page_token must be the value of next_page_token returned from the
# next_page_token returned from # previous call to ListJobs. It is an error to switch the value of filter or
# the previous call to ListJobs. It is an error to
# switch the value of filter or
# order_by while iterating through pages. # order_by while iterating through pages.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -259,33 +255,25 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Updates a job. # Updates a job. If successful, the updated Job is returned. If the job does not
# If successful, the updated Job is returned. If the job does # exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it
# not exist, `NOT_FOUND` is returned. # is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in
# If UpdateJob does not successfully return, it is possible for the # this state may not be executed. If this happens, retry the UpdateJob request
# job to be in an Job.State.UPDATE_FAILED state. A job in this state may
# not be executed. If this happens, retry the UpdateJob request
# until a successful response is received. # until a successful response is received.
# @param [String] name # @param [String] name
# Optionally caller-specified in CreateJob, after # Optionally caller-specified in CreateJob, after which it becomes output only.
# which it becomes output only. # The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/
# The job name. For example: # JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. # hyphens (-), colons (:), or periods (.). For more information, see [
# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), # Identifying projects](https://cloud.google.com/resource-manager/docs/creating-
# hyphens (-), colons (:), or periods (.). # managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID
# For more information, see # for the job's location. The list of available locations can be obtained by
# [Identifying # calling ListLocations. For more information, see https://cloud.google.com/
# projects](https://cloud.google.com/resource-manager/docs/creating-managing- # about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-
# projects#identifying_projects) # 9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
# * `LOCATION_ID` is the canonical ID for the job's location.
# The list of available locations can be obtained by calling
# ListLocations.
# For more information, see https://cloud.google.com/about/locations/.
# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
# hyphens (-), or underscores (_). The maximum length is 500 characters.
# @param [Google::Apis::CloudschedulerV1beta1::Job] job_object # @param [Google::Apis::CloudschedulerV1beta1::Job] job_object
# @param [String] update_mask # @param [String] update_mask
# A mask used to specify which fields of the job are being updated. # A mask used to specify which fields of the job are being updated.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user
@ -316,15 +304,13 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Pauses a job. # Pauses a job. If a job is paused then the system will stop executing the job
# If a job is paused then the system will stop executing the job # until it is re-enabled via ResumeJob. The state of the job is stored in state;
# until it is re-enabled via ResumeJob. The # if paused it will be set to Job.State.PAUSED. A job must be in Job.State.
# state of the job is stored in state; if paused it # ENABLED to be paused.
# will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED
# to be paused.
# @param [String] name # @param [String] name
# Required. The job name. For example: # Required. The job name. For example: `projects/PROJECT_ID/locations/
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. # LOCATION_ID/jobs/JOB_ID`.
# @param [Google::Apis::CloudschedulerV1beta1::PauseJobRequest] pause_job_request_object # @param [Google::Apis::CloudschedulerV1beta1::PauseJobRequest] pause_job_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -355,14 +341,12 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Resume a job. # Resume a job. This method reenables a job after it has been Job.State.PAUSED.
# This method reenables a job after it has been Job.State.PAUSED. The # The state of a job is stored in Job.state; after calling this method it will
# state of a job is stored in Job.state; after calling this method it # be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed.
# will be set to Job.State.ENABLED. A job must be in
# Job.State.PAUSED to be resumed.
# @param [String] name # @param [String] name
# Required. The job name. For example: # Required. The job name. For example: `projects/PROJECT_ID/locations/
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. # LOCATION_ID/jobs/JOB_ID`.
# @param [Google::Apis::CloudschedulerV1beta1::ResumeJobRequest] resume_job_request_object # @param [Google::Apis::CloudschedulerV1beta1::ResumeJobRequest] resume_job_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
@ -393,12 +377,11 @@ module Google
execute_or_queue_command(command, &block) execute_or_queue_command(command, &block)
end end
# Forces a job to run now. # Forces a job to run now. When this method is called, Cloud Scheduler will
# When this method is called, Cloud Scheduler will dispatch the job, even # dispatch the job, even if the job is already running.
# if the job is already running.
# @param [String] name # @param [String] name
# Required. The job name. For example: # Required. The job name. For example: `projects/PROJECT_ID/locations/
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. # LOCATION_ID/jobs/JOB_ID`.
# @param [Google::Apis::CloudschedulerV1beta1::RunJobRequest] run_job_request_object # @param [Google::Apis::CloudschedulerV1beta1::RunJobRequest] run_job_request_object
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.

2
generated/google/apis/gmail_v1.rb
View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/gmail/api/ # @see https://developers.google.com/gmail/api/
module GmailV1 module GmailV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200810' REVISION = '20200817'
# Read, compose, send, and permanently delete all your email from Gmail # Read, compose, send, and permanently delete all your email from Gmail
AUTH_SCOPE = 'https://mail.google.com/' AUTH_SCOPE = 'https://mail.google.com/'

4
generated/google/apis/gmail_v1/service.rb
View File

@ -44,8 +44,8 @@ module Google
attr_accessor :quota_user attr_accessor :quota_user
def initialize def initialize
super('https://www.googleapis.com/', '') super('https://gmail.googleapis.com/', '')
@batch_path = 'batch/gmail/v1' @batch_path = 'batch'
end end
# Gets the current user's Gmail profile. # Gets the current user's Gmail profile.

2
generated/google/apis/kgsearch_v1.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/knowledge-graph/ # @see https://developers.google.com/knowledge-graph/
module KgsearchV1 module KgsearchV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200210' REVISION = '20200809'
end end
end end
end end

8
generated/google/apis/kgsearch_v1/classes.rb
View File

@ -22,13 +22,13 @@ module Google
module Apis module Apis
module KgsearchV1 module KgsearchV1
# Response message includes the context and a list of matching results # Response message includes the context and a list of matching results which
# which contain the detail of associated entities. # contain the detail of associated entities.
class SearchResponse class SearchResponse
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# The local context applicable for the response. See more details at # The local context applicable for the response. See more details at http://www.
# http://www.w3.org/TR/json-ld/#context-definitions. # w3.org/TR/json-ld/#context-definitions.
# Corresponds to the JSON property `@context` # Corresponds to the JSON property `@context`
# @return [Object] # @return [Object]
attr_accessor :_context attr_accessor :_context

22
generated/google/apis/kgsearch_v1/service.rb
View File

@ -47,18 +47,18 @@ module Google
@batch_path = 'batch' @batch_path = 'batch'
end end
# Searches Knowledge Graph for entities that match the constraints. # Searches Knowledge Graph for entities that match the constraints. A list of
# A list of matched entities will be returned in response, which will be in # matched entities will be returned in response, which will be in JSON-LD format
# JSON-LD format and compatible with http://schema.org # and compatible with http://schema.org
# @param [Array<String>, String] ids # @param [Array<String>, String] ids
# The list of entity id to be used for search instead of query string. # The list of entity id to be used for search instead of query string. To
# To specify multiple ids in the HTTP request, repeat the parameter in the # specify multiple ids in the HTTP request, repeat the parameter in the URL as
# URL as in ...?ids=A&ids=B # in ...?ids=A&ids=B
# @param [Boolean] indent # @param [Boolean] indent
# Enables indenting of json results. # Enables indenting of json results.
# @param [Array<String>, String] languages # @param [Array<String>, String] languages
# The list of language codes (defined in ISO 693) to run the query with, # The list of language codes (defined in ISO 693) to run the query with, e.g. '
# e.g. 'en'. # en'.
# @param [Fixnum] limit # @param [Fixnum] limit
# Limits the number of entities to be returned. # Limits the number of entities to be returned.
# @param [Boolean] prefix # @param [Boolean] prefix
@ -66,9 +66,9 @@ module Google
# @param [String] query # @param [String] query
# The literal query string for search. # The literal query string for search.
# @param [Array<String>, String] types # @param [Array<String>, String] types
# Restricts returned entities with these types, e.g. Person # Restricts returned entities with these types, e.g. Person (as defined in http:/
# (as defined in http://schema.org/Person). If multiple types are specified, # /schema.org/Person). If multiple types are specified, returned entities will
# returned entities will contain one or more of these types. # contain one or more of these types.
# @param [String] fields # @param [String] fields
# Selector specifying which fields to include in a partial response. # Selector specifying which fields to include in a partial response.
# @param [String] quota_user # @param [String] quota_user

2
generated/google/apis/oslogin_v1alpha.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/compute/docs/oslogin/ # @see https://cloud.google.com/compute/docs/oslogin/
module OsloginV1alpha module OsloginV1alpha
VERSION = 'V1alpha' VERSION = 'V1alpha'
REVISION = '20200801' REVISION = '20200817'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

6
generated/google/apis/oslogin_v1alpha/classes.rb
View File

@ -43,6 +43,11 @@ module Google
class ImportSshPublicKeyResponse class ImportSshPublicKeyResponse
include Google::Apis::Core::Hashable include Google::Apis::Core::Hashable
# Detailed information about import results.
# Corresponds to the JSON property `details`
# @return [String]
attr_accessor :details
# The user profile information used for logging in to a virtual machine on # The user profile information used for logging in to a virtual machine on
# Google Compute Engine. # Google Compute Engine.
# Corresponds to the JSON property `loginProfile` # Corresponds to the JSON property `loginProfile`
@ -55,6 +60,7 @@ module Google
# Update properties of this object # Update properties of this object
def update!(**args) def update!(**args)
@details = args[:details] if args.key?(:details)
@login_profile = args[:login_profile] if args.key?(:login_profile) @login_profile = args[:login_profile] if args.key?(:login_profile)
end end
end end

1
generated/google/apis/oslogin_v1alpha/representations.rb
View File

@ -61,6 +61,7 @@ module Google
class ImportSshPublicKeyResponse class ImportSshPublicKeyResponse
# @private # @private
class Representation < Google::Apis::Core::JsonRepresentation class Representation < Google::Apis::Core::JsonRepresentation
property :details, as: 'details'
property :login_profile, as: 'loginProfile', class: Google::Apis::OsloginV1alpha::LoginProfile, decorator: Google::Apis::OsloginV1alpha::LoginProfile::Representation property :login_profile, as: 'loginProfile', class: Google::Apis::OsloginV1alpha::LoginProfile, decorator: Google::Apis::OsloginV1alpha::LoginProfile::Representation
end end

2
generated/google/apis/serviceconsumermanagement_v1.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/service-consumer-management/docs/overview # @see https://cloud.google.com/service-consumer-management/docs/overview
module ServiceconsumermanagementV1 module ServiceconsumermanagementV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200804' REVISION = '20200818'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

2
generated/google/apis/serviceconsumermanagement_v1/classes.rb
View File

@ -1927,7 +1927,7 @@ module Google
# AccessControl The mixin construct implies that all methods in `AccessControl` # AccessControl The mixin construct implies that all methods in `AccessControl`
# are also declared with same name and request/response types in `Storage`. A # are also declared with same name and request/response types in `Storage`. A
# documentation generator or annotation processor will see the effective ` # documentation generator or annotation processor will see the effective `
# Storage.GetAcl` method after inherting documentation and annotations as # Storage.GetAcl` method after inheriting documentation and annotations as
# follows: service Storage ` // Get the underlying ACL object. rpc GetAcl( # follows: service Storage ` // Get the underlying ACL object. rpc GetAcl(
# GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=** # GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=**
# `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1` # `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1`

2
generated/google/apis/serviceconsumermanagement_v1beta1.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/service-consumer-management/docs/overview # @see https://cloud.google.com/service-consumer-management/docs/overview
module ServiceconsumermanagementV1beta1 module ServiceconsumermanagementV1beta1
VERSION = 'V1beta1' VERSION = 'V1beta1'
REVISION = '20200804' REVISION = '20200818'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

4
generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb
View File

@ -1708,7 +1708,7 @@ module Google
# AccessControl The mixin construct implies that all methods in `AccessControl` # AccessControl The mixin construct implies that all methods in `AccessControl`
# are also declared with same name and request/response types in `Storage`. A # are also declared with same name and request/response types in `Storage`. A
# documentation generator or annotation processor will see the effective ` # documentation generator or annotation processor will see the effective `
# Storage.GetAcl` method after inherting documentation and annotations as # Storage.GetAcl` method after inheriting documentation and annotations as
# follows: service Storage ` // Get the underlying ACL object. rpc GetAcl( # follows: service Storage ` // Get the underlying ACL object. rpc GetAcl(
# GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=** # GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=**
# `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1` # `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1`
@ -3185,7 +3185,7 @@ module Google
# The overrides to create. Each override must have a value for 'metric' and ' # 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 # unit', to specify which metric and which limit the override should be applied
# to. # to. The 'name' field of the override does not need to be set; it is ignored.
# Corresponds to the JSON property `overrides` # Corresponds to the JSON property `overrides`
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride>] # @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride>]
attr_accessor :overrides attr_accessor :overrides

2
generated/google/apis/servicenetworking_v1.rb
View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started # @see https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started
module ServicenetworkingV1 module ServicenetworkingV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200804' REVISION = '20200818'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

2
generated/google/apis/servicenetworking_v1/classes.rb
View File

@ -2265,7 +2265,7 @@ module Google
# AccessControl The mixin construct implies that all methods in `AccessControl` # AccessControl The mixin construct implies that all methods in `AccessControl`
# are also declared with same name and request/response types in `Storage`. A # are also declared with same name and request/response types in `Storage`. A
# documentation generator or annotation processor will see the effective ` # documentation generator or annotation processor will see the effective `
# Storage.GetAcl` method after inherting documentation and annotations as # Storage.GetAcl` method after inheriting documentation and annotations as
# follows: service Storage ` // Get the underlying ACL object. rpc GetAcl( # follows: service Storage ` // Get the underlying ACL object. rpc GetAcl(
# GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=** # GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=**
# `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1` # `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1`

2
generated/google/apis/servicenetworking_v1beta.rb
View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started # @see https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started
module ServicenetworkingV1beta module ServicenetworkingV1beta
VERSION = 'V1beta' VERSION = 'V1beta'
REVISION = '20200804' REVISION = '20200818'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

2
generated/google/apis/servicenetworking_v1beta/classes.rb
View File

@ -2034,7 +2034,7 @@ module Google
# AccessControl The mixin construct implies that all methods in `AccessControl` # AccessControl The mixin construct implies that all methods in `AccessControl`
# are also declared with same name and request/response types in `Storage`. A # are also declared with same name and request/response types in `Storage`. A
# documentation generator or annotation processor will see the effective ` # documentation generator or annotation processor will see the effective `
# Storage.GetAcl` method after inherting documentation and annotations as # Storage.GetAcl` method after inheriting documentation and annotations as
# follows: service Storage ` // Get the underlying ACL object. rpc GetAcl( # follows: service Storage ` // Get the underlying ACL object. rpc GetAcl(
# GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=** # GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=**
# `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1` # `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1`

2
generated/google/apis/serviceusage_v1.rb
View File

@ -27,7 +27,7 @@ module Google
# @see https://cloud.google.com/service-usage/ # @see https://cloud.google.com/service-usage/
module ServiceusageV1 module ServiceusageV1
VERSION = 'V1' VERSION = 'V1'
REVISION = '20200813' REVISION = '20200818'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

2
generated/google/apis/serviceusage_v1/classes.rb
View File

@ -2719,7 +2719,7 @@ module Google
# AccessControl The mixin construct implies that all methods in `AccessControl` # AccessControl The mixin construct implies that all methods in `AccessControl`
# are also declared with same name and request/response types in `Storage`. A # are also declared with same name and request/response types in `Storage`. A
# documentation generator or annotation processor will see the effective ` # documentation generator or annotation processor will see the effective `
# Storage.GetAcl` method after inherting documentation and annotations as # Storage.GetAcl` method after inheriting documentation and annotations as
# follows: service Storage ` // Get the underlying ACL object. rpc GetAcl( # follows: service Storage ` // Get the underlying ACL object. rpc GetAcl(
# GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=** # GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=**
# `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1` # `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1`

2
generated/google/apis/serviceusage_v1beta1.rb
View File

@ -27,7 +27,7 @@ module Google
# @see https://cloud.google.com/service-usage/ # @see https://cloud.google.com/service-usage/
module ServiceusageV1beta1 module ServiceusageV1beta1
VERSION = 'V1beta1' VERSION = 'V1beta1'
REVISION = '20200804' REVISION = '20200818'
# View and manage your data across Google Cloud Platform services # View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

4
generated/google/apis/serviceusage_v1beta1/classes.rb
View File

@ -2885,7 +2885,7 @@ module Google
# AccessControl The mixin construct implies that all methods in `AccessControl` # AccessControl The mixin construct implies that all methods in `AccessControl`
# are also declared with same name and request/response types in `Storage`. A # are also declared with same name and request/response types in `Storage`. A
# documentation generator or annotation processor will see the effective ` # documentation generator or annotation processor will see the effective `
# Storage.GetAcl` method after inherting documentation and annotations as # Storage.GetAcl` method after inheriting documentation and annotations as
# follows: service Storage ` // Get the underlying ACL object. rpc GetAcl( # follows: service Storage ` // Get the underlying ACL object. rpc GetAcl(
# GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=** # GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=**
# `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1` # `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1`
@ -3222,7 +3222,7 @@ module Google
# The overrides to create. Each override must have a value for 'metric' and ' # 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 # unit', to specify which metric and which limit the override should be applied
# to. # to. The 'name' field of the override does not need to be set; it is ignored.
# Corresponds to the JSON property `overrides` # Corresponds to the JSON property `overrides`
# @return [Array<Google::Apis::ServiceusageV1beta1::QuotaOverride>] # @return [Array<Google::Apis::ServiceusageV1beta1::QuotaOverride>]
attr_accessor :overrides attr_accessor :overrides

37
generated/google/apis/site_verification_v1.rb
View File

@ -1,37 +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/site_verification_v1/service.rb'
require 'google/apis/site_verification_v1/classes.rb'
require 'google/apis/site_verification_v1/representations.rb'
module Google
module Apis
# Google Site Verification API
#
# Verifies ownership of websites or domains with Google.
#
# @see https://developers.google.com/site-verification/
module SiteVerificationV1
VERSION = 'V1'
REVISION = '20180521'
# Manage the list of sites and domains you control
AUTH_SITEVERIFICATION = 'https://www.googleapis.com/auth/siteverification'
# Manage your new site verifications with Google
AUTH_SITEVERIFICATION_VERIFY_ONLY = 'https://www.googleapis.com/auth/siteverification.verify_only'
end
end
end

185
generated/google/apis/site_verification_v1/classes.rb
View File

@ -1,185 +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 SiteVerificationV1
#
class GetWebResourceTokenRequest
include Google::Apis::Core::Hashable
# The site for which a verification token will be generated.
# Corresponds to the JSON property `site`
# @return [Google::Apis::SiteVerificationV1::GetWebResourceTokenRequest::Site]
attr_accessor :site
# The verification method that will be used to verify this site. For sites, '
# FILE' or 'META' methods may be used. For domains, only 'DNS' may be used.
# Corresponds to the JSON property `verificationMethod`
# @return [String]
attr_accessor :verification_method
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@site = args[:site] if args.key?(:site)
@verification_method = args[:verification_method] if args.key?(:verification_method)
end
# The site for which a verification token will be generated.
class Site
include Google::Apis::Core::Hashable
# The site identifier. If the type is set to SITE, the identifier is a URL. If
# the type is set to INET_DOMAIN, the site identifier is a domain name.
# Corresponds to the JSON property `identifier`
# @return [String]
attr_accessor :identifier
# The type of resource to be verified. Can be SITE or INET_DOMAIN (domain name).
# 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)
@identifier = args[:identifier] if args.key?(:identifier)
@type = args[:type] if args.key?(:type)
end
end
end
#
class GetWebResourceTokenResponse
include Google::Apis::Core::Hashable
# The verification method to use in conjunction with this token. For FILE, the
# token should be placed in the top-level directory of the site, stored inside a
# file of the same name. For META, the token should be placed in the HEAD tag of
# the default page that is loaded for the site. For DNS, the token should be
# placed in a TXT record of the domain.
# Corresponds to the JSON property `method`
# @return [String]
attr_accessor :verification_method
# The verification token. The token must be placed appropriately in order for
# verification to succeed.
# Corresponds to the JSON property `token`
# @return [String]
attr_accessor :token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@verification_method = args[:verification_method] if args.key?(:verification_method)
@token = args[:token] if args.key?(:token)
end
end
#
class ListWebResourceResponse
include Google::Apis::Core::Hashable
# The list of sites that are owned by the authenticated user.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource>]
attr_accessor :items
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@items = args[:items] if args.key?(:items)
end
end
#
class SiteVerificationWebResourceResource
include Google::Apis::Core::Hashable
# The string used to identify this site. This value should be used in the "id"
# portion of the REST URL for the Get, Update, and Delete operations.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# The email addresses of all verified owners.
# Corresponds to the JSON property `owners`
# @return [Array<String>]
attr_accessor :owners
# The address and type of a site that is verified or will be verified.
# Corresponds to the JSON property `site`
# @return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Site]
attr_accessor :site
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@owners = args[:owners] if args.key?(:owners)
@site = args[:site] if args.key?(:site)
end
# The address and type of a site that is verified or will be verified.
class Site
include Google::Apis::Core::Hashable
# The site identifier. If the type is set to SITE, the identifier is a URL. If
# the type is set to INET_DOMAIN, the site identifier is a domain name.
# Corresponds to the JSON property `identifier`
# @return [String]
attr_accessor :identifier
# The site type. Can be SITE or INET_DOMAIN (domain name).
# 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)
@identifier = args[:identifier] if args.key?(:identifier)
@type = args[:type] if args.key?(:type)
end
end
end
end
end
end

113
generated/google/apis/site_verification_v1/representations.rb
View File

@ -1,113 +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 SiteVerificationV1
class GetWebResourceTokenRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
class Site
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
include Google::Apis::Core::JsonObjectSupport
end
class GetWebResourceTokenResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListWebResourceResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class SiteVerificationWebResourceResource
class Representation < Google::Apis::Core::JsonRepresentation; end
class Site
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
include Google::Apis::Core::JsonObjectSupport
end
class GetWebResourceTokenRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :site, as: 'site', class: Google::Apis::SiteVerificationV1::GetWebResourceTokenRequest::Site, decorator: Google::Apis::SiteVerificationV1::GetWebResourceTokenRequest::Site::Representation
property :verification_method, as: 'verificationMethod'
end
class Site
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :identifier, as: 'identifier'
property :type, as: 'type'
end
end
end
class GetWebResourceTokenResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :verification_method, as: 'method'
property :token, as: 'token'
end
end
class ListWebResourceResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :items, as: 'items', class: Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource, decorator: Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation
end
end
class SiteVerificationWebResourceResource
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :id, as: 'id'
collection :owners, as: 'owners'
property :site, as: 'site', class: Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Site, decorator: Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Site::Representation
end
class Site
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :identifier, as: 'identifier'
property :type, as: 'type'
end
end
end
end
end
end

300
generated/google/apis/site_verification_v1/service.rb
View File

@ -1,300 +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 SiteVerificationV1
# Google Site Verification API
#
# Verifies ownership of websites or domains with Google.
#
# @example
# require 'google/apis/site_verification_v1'
#
# SiteVerification = Google::Apis::SiteVerificationV1 # Alias the module
# service = SiteVerification::SiteVerificationService.new
#
# @see https://developers.google.com/site-verification/
class SiteVerificationService < 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/', 'siteVerification/v1/')
@batch_path = 'batch/siteVerification/v1'
end
# Relinquish ownership of a website or domain.
# @param [String] id
# The id of a verified site or domain.
# @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_web_resource(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:delete, 'webResource/{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
# Get the most current data for a website or domain.
# @param [String] id
# The id of a verified site or domain.
# @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::SiteVerificationV1::SiteVerificationWebResourceResource] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_resource(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'webResource/{id}', options)
command.response_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation
command.response_class = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource
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
# Get a verification token for placing on a website or domain.
# @param [Google::Apis::SiteVerificationV1::GetWebResourceTokenRequest] get_web_resource_token_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::SiteVerificationV1::GetWebResourceTokenResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SiteVerificationV1::GetWebResourceTokenResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_resource_token(get_web_resource_token_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'token', options)
command.request_representation = Google::Apis::SiteVerificationV1::GetWebResourceTokenRequest::Representation
command.request_object = get_web_resource_token_request_object
command.response_representation = Google::Apis::SiteVerificationV1::GetWebResourceTokenResponse::Representation
command.response_class = Google::Apis::SiteVerificationV1::GetWebResourceTokenResponse
command.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
# Attempt verification of a website or domain.
# @param [String] verification_method
# The method to use for verifying a site or domain.
# @param [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] site_verification_web_resource_resource_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::SiteVerificationV1::SiteVerificationWebResourceResource] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_resource(verification_method, site_verification_web_resource_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:post, 'webResource', options)
command.request_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation
command.request_object = site_verification_web_resource_resource_object
command.response_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation
command.response_class = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource
command.query['verificationMethod'] = verification_method unless verification_method.nil?
command.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 the list of your verified websites and domains.
# @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::SiteVerificationV1::ListWebResourceResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SiteVerificationV1::ListWebResourceResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_resources(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:get, 'webResource', options)
command.response_representation = Google::Apis::SiteVerificationV1::ListWebResourceResponse::Representation
command.response_class = Google::Apis::SiteVerificationV1::ListWebResourceResponse
command.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
# Modify the list of owners for your website or domain. This method supports
# patch semantics.
# @param [String] id
# The id of a verified site or domain.
# @param [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] site_verification_web_resource_resource_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::SiteVerificationV1::SiteVerificationWebResourceResource] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_resource(id, site_verification_web_resource_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:patch, 'webResource/{id}', options)
command.request_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation
command.request_object = site_verification_web_resource_resource_object
command.response_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation
command.response_class = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource
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
# Modify the list of owners for your website or domain.
# @param [String] id
# The id of a verified site or domain.
# @param [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource] site_verification_web_resource_resource_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::SiteVerificationV1::SiteVerificationWebResourceResource] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_web_resource(id, site_verification_web_resource_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
command = make_simple_command(:put, 'webResource/{id}', options)
command.request_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation
command.request_object = site_verification_web_resource_resource_object
command.response_representation = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource::Representation
command.response_class = Google::Apis::SiteVerificationV1::SiteVerificationWebResourceResource
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
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