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/member": member
"/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/logName": log_name
"/cloudkms:v1/Condition": condition
@ -22044,6 +22051,7 @@
"/cloudkms:v1/ImportJob/publicKey": public_key
"/cloudkms:v1/ImportJob/state": state
"/cloudkms:v1/KeyOperationAttestation": key_operation_attestation
"/cloudkms:v1/KeyOperationAttestation/certChains": cert_chains
"/cloudkms:v1/KeyOperationAttestation/content": content
"/cloudkms:v1/KeyOperationAttestation/format": format
"/cloudkms:v1/KeyRing": key_ring
@ -112062,6 +112070,7 @@
"/oslogin:v1/quotaUser": quota_user
"/oslogin:v1alpha/Empty": empty
"/oslogin:v1alpha/ImportSshPublicKeyResponse": import_ssh_public_key_response
"/oslogin:v1alpha/ImportSshPublicKeyResponse/details": details
"/oslogin:v1alpha/ImportSshPublicKeyResponse/loginProfile": login_profile
"/oslogin:v1alpha/LoginProfile": login_profile
"/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/
module AdminDirectoryV1
VERSION = 'DirectoryV1'
REVISION = '20200810'
REVISION = '20200819'
# View and manage customer related information
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/
module AdminReportsV1
VERSION = 'ReportsV1'
REVISION = '20200810'
REVISION = '20200819'
# View audit reports for your G Suite domain
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/
module CloudkmsV1
VERSION = 'V1'
REVISION = '20200803'
REVISION = '20200814'
# View and manage your data across Google Cloud Platform services
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
# 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
# operations. A CryptoKey is made up of zero or more versions, which represent
# the actual key material used in cryptographic operations.
@ -1066,6 +1099,13 @@ module Google
class KeyOperationAttestation
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
# was performed.
# Corresponds to the JSON property `content`
@ -1084,6 +1124,7 @@ module Google
# Update properties of this object
def update!(**args)
@cert_chains = args[:cert_chains] if args.key?(:cert_chains)
@content = args[:content] if args.key?(:content)
@format = args[:format] if args.key?(:format)
end

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

@ -64,6 +64,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class CertificateChains
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CryptoKey
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -307,6 +313,15 @@ module Google
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
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -453,6 +468,8 @@ module Google
class KeyOperationAttestation
# @private
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 :format, as: 'format'
end

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

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

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

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

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

@ -118,8 +118,8 @@ module Google
# Creates a job.
# @param [String] parent
# Required. The location name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID`.
# Required. The location name. For example: `projects/PROJECT_ID/locations/
# LOCATION_ID`.
# @param [Google::Apis::CloudschedulerV1::Job] job_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -152,8 +152,8 @@ module Google
# Deletes a job.
# @param [String] name
# Required. The job name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
# Required. The job name. For example: `projects/PROJECT_ID/locations/
# LOCATION_ID/jobs/JOB_ID`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -183,8 +183,8 @@ module Google
# Gets a job.
# @param [String] name
# Required. The job name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
# Required. The job name. For example: `projects/PROJECT_ID/locations/
# LOCATION_ID/jobs/JOB_ID`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -214,21 +214,17 @@ module Google
# Lists jobs.
# @param [String] parent
# Required. The location name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID`.
# Required. The location name. For example: `projects/PROJECT_ID/locations/
# LOCATION_ID`.
# @param [Fixnum] page_size
# Requested page size.
# The maximum page size is 500. If unspecified, the page size will
# be the maximum. Fewer jobs than requested might be returned,
# even if more jobs exist; use next_page_token to determine if more
# jobs exist.
# Requested page size. The maximum page size is 500. If unspecified, the page
# size will be the maximum. Fewer jobs than requested might be returned, even if
# more jobs exist; use next_page_token to determine if more jobs exist.
# @param [String] page_token
# A token identifying a page of results the server will return. To
# request the first page results, page_token must be empty. To
# request the next page of results, page_token must be the value of
# next_page_token returned from
# the previous call to ListJobs. It is an error to
# switch the value of filter or
# A token identifying a page of results the server will return. To request the
# first page results, page_token must be empty. To request the next page of
# results, page_token must be the value of next_page_token returned from the
# previous call to ListJobs. It is an error to switch the value of filter or
# order_by while iterating through pages.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -259,30 +255,22 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates a job.
# If successful, the updated Job is returned. If the job does
# not exist, `NOT_FOUND` is returned.
# If UpdateJob does not successfully return, it is possible for the
# 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
# Updates a job. If successful, the updated Job is returned. If the job does not
# exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it
# is possible for the 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.
# @param [String] name
# Optionally caller-specified in CreateJob, after
# which it becomes output only.
# The job name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
# hyphens (-), colons (:), or periods (.).
# For more information, see
# [Identifying
# projects](https://cloud.google.com/resource-manager/docs/creating-managing-
# projects#identifying_projects)
# * `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.
# Optionally caller-specified in CreateJob, after which it becomes output only.
# The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/
# JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
# hyphens (-), colons (:), or periods (.). For more information, see [
# Identifying projects](https://cloud.google.com/resource-manager/docs/creating-
# managing-projects#identifying_projects) * `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 [String] update_mask
# A mask used to specify which fields of the job are being updated.
@ -316,15 +304,13 @@ module Google
execute_or_queue_command(command, &block)
end
# Pauses a 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; if paused it
# will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED
# to be paused.
# Pauses a 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;
# if paused it will be set to Job.State.PAUSED. A job must be in Job.State.
# ENABLED to be paused.
# @param [String] name
# Required. The job name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
# Required. The job name. For example: `projects/PROJECT_ID/locations/
# LOCATION_ID/jobs/JOB_ID`.
# @param [Google::Apis::CloudschedulerV1::PauseJobRequest] pause_job_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -355,14 +341,12 @@ module Google
execute_or_queue_command(command, &block)
end
# Resume a job.
# This method reenables a job after it has been Job.State.PAUSED. The
# state of a job is stored in Job.state; after calling this method it
# will be set to Job.State.ENABLED. A job must be in
# Job.State.PAUSED to be resumed.
# Resume a job. This method reenables a job after it has been Job.State.PAUSED.
# The state of a job is stored in Job.state; after calling this method it will
# be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed.
# @param [String] name
# Required. The job name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
# Required. The job name. For example: `projects/PROJECT_ID/locations/
# LOCATION_ID/jobs/JOB_ID`.
# @param [Google::Apis::CloudschedulerV1::ResumeJobRequest] resume_job_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -393,12 +377,11 @@ module Google
execute_or_queue_command(command, &block)
end
# Forces a job to run now.
# When this method is called, Cloud Scheduler will dispatch the job, even
# if the job is already running.
# Forces a job to run now. When this method is called, Cloud Scheduler will
# dispatch the job, even if the job is already running.
# @param [String] name
# Required. The job name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
# Required. The job name. For example: `projects/PROJECT_ID/locations/
# LOCATION_ID/jobs/JOB_ID`.
# @param [Google::Apis::CloudschedulerV1::RunJobRequest] run_job_request_object
# @param [String] fields
# 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/
module CloudschedulerV1beta1
VERSION = 'V1beta1'
REVISION = '20200716'
REVISION = '20200814'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

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

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

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

@ -118,8 +118,8 @@ module Google
# Creates a job.
# @param [String] parent
# Required. The location name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID`.
# Required. The location name. For example: `projects/PROJECT_ID/locations/
# LOCATION_ID`.
# @param [Google::Apis::CloudschedulerV1beta1::Job] job_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -152,8 +152,8 @@ module Google
# Deletes a job.
# @param [String] name
# Required. The job name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
# Required. The job name. For example: `projects/PROJECT_ID/locations/
# LOCATION_ID/jobs/JOB_ID`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -183,8 +183,8 @@ module Google
# Gets a job.
# @param [String] name
# Required. The job name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
# Required. The job name. For example: `projects/PROJECT_ID/locations/
# LOCATION_ID/jobs/JOB_ID`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -214,21 +214,17 @@ module Google
# Lists jobs.
# @param [String] parent
# Required. The location name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID`.
# Required. The location name. For example: `projects/PROJECT_ID/locations/
# LOCATION_ID`.
# @param [Fixnum] page_size
# Requested page size.
# The maximum page size is 500. If unspecified, the page size will
# be the maximum. Fewer jobs than requested might be returned,
# even if more jobs exist; use next_page_token to determine if more
# jobs exist.
# Requested page size. The maximum page size is 500. If unspecified, the page
# size will be the maximum. Fewer jobs than requested might be returned, even if
# more jobs exist; use next_page_token to determine if more jobs exist.
# @param [String] page_token
# A token identifying a page of results the server will return. To
# request the first page results, page_token must be empty. To
# request the next page of results, page_token must be the value of
# next_page_token returned from
# the previous call to ListJobs. It is an error to
# switch the value of filter or
# A token identifying a page of results the server will return. To request the
# first page results, page_token must be empty. To request the next page of
# results, page_token must be the value of next_page_token returned from the
# previous call to ListJobs. It is an error to switch the value of filter or
# order_by while iterating through pages.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -259,30 +255,22 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates a job.
# If successful, the updated Job is returned. If the job does
# not exist, `NOT_FOUND` is returned.
# If UpdateJob does not successfully return, it is possible for the
# 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
# Updates a job. If successful, the updated Job is returned. If the job does not
# exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it
# is possible for the 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.
# @param [String] name
# Optionally caller-specified in CreateJob, after
# which it becomes output only.
# The job name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
# * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
# hyphens (-), colons (:), or periods (.).
# For more information, see
# [Identifying
# projects](https://cloud.google.com/resource-manager/docs/creating-managing-
# projects#identifying_projects)
# * `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.
# Optionally caller-specified in CreateJob, after which it becomes output only.
# The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/
# JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
# hyphens (-), colons (:), or periods (.). For more information, see [
# Identifying projects](https://cloud.google.com/resource-manager/docs/creating-
# managing-projects#identifying_projects) * `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 [String] update_mask
# A mask used to specify which fields of the job are being updated.
@ -316,15 +304,13 @@ module Google
execute_or_queue_command(command, &block)
end
# Pauses a 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; if paused it
# will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED
# to be paused.
# Pauses a 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;
# if paused it will be set to Job.State.PAUSED. A job must be in Job.State.
# ENABLED to be paused.
# @param [String] name
# Required. The job name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
# Required. The job name. For example: `projects/PROJECT_ID/locations/
# LOCATION_ID/jobs/JOB_ID`.
# @param [Google::Apis::CloudschedulerV1beta1::PauseJobRequest] pause_job_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -355,14 +341,12 @@ module Google
execute_or_queue_command(command, &block)
end
# Resume a job.
# This method reenables a job after it has been Job.State.PAUSED. The
# state of a job is stored in Job.state; after calling this method it
# will be set to Job.State.ENABLED. A job must be in
# Job.State.PAUSED to be resumed.
# Resume a job. This method reenables a job after it has been Job.State.PAUSED.
# The state of a job is stored in Job.state; after calling this method it will
# be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed.
# @param [String] name
# Required. The job name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
# Required. The job name. For example: `projects/PROJECT_ID/locations/
# LOCATION_ID/jobs/JOB_ID`.
# @param [Google::Apis::CloudschedulerV1beta1::ResumeJobRequest] resume_job_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -393,12 +377,11 @@ module Google
execute_or_queue_command(command, &block)
end
# Forces a job to run now.
# When this method is called, Cloud Scheduler will dispatch the job, even
# if the job is already running.
# Forces a job to run now. When this method is called, Cloud Scheduler will
# dispatch the job, even if the job is already running.
# @param [String] name
# Required. The job name. For example:
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
# Required. The job name. For example: `projects/PROJECT_ID/locations/
# LOCATION_ID/jobs/JOB_ID`.
# @param [Google::Apis::CloudschedulerV1beta1::RunJobRequest] run_job_request_object
# @param [String] fields
# 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/
module GmailV1
VERSION = 'V1'
REVISION = '20200810'
REVISION = '20200817'
# Read, compose, send, and permanently delete all your email from Gmail
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
def initialize
super('https://www.googleapis.com/', '')
@batch_path = 'batch/gmail/v1'
super('https://gmail.googleapis.com/', '')
@batch_path = 'batch'
end
# 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/
module KgsearchV1
VERSION = 'V1'
REVISION = '20200210'
REVISION = '20200809'
end
end
end

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

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

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

@ -47,18 +47,18 @@ module Google
@batch_path = 'batch'
end
# Searches Knowledge Graph for entities that match the constraints.
# A list of matched entities will be returned in response, which will be in
# JSON-LD format and compatible with http://schema.org
# Searches Knowledge Graph for entities that match the constraints. A list of
# matched entities will be returned in response, which will be in JSON-LD format
# and compatible with http://schema.org
# @param [Array<String>, String] ids
# The list of entity id to be used for search instead of query string.
# To specify multiple ids in the HTTP request, repeat the parameter in the
# URL as in ...?ids=A&ids=B
# The list of entity id to be used for search instead of query string. To
# specify multiple ids in the HTTP request, repeat the parameter in the URL as
# in ...?ids=A&ids=B
# @param [Boolean] indent
# Enables indenting of json results.
# @param [Array<String>, String] languages
# The list of language codes (defined in ISO 693) to run the query with,
# e.g. 'en'.
# The list of language codes (defined in ISO 693) to run the query with, e.g. '
# en'.
# @param [Fixnum] limit
# Limits the number of entities to be returned.
# @param [Boolean] prefix
@ -66,9 +66,9 @@ module Google
# @param [String] query
# The literal query string for search.
# @param [Array<String>, String] types
# Restricts returned entities with these types, e.g. Person
# (as defined in http://schema.org/Person). If multiple types are specified,
# returned entities will contain one or more of these types.
# Restricts returned entities with these types, e.g. Person (as defined in http:/
# /schema.org/Person). If multiple types are specified, returned entities will
# contain one or more of these types.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @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/
module OsloginV1alpha
VERSION = 'V1alpha'
REVISION = '20200801'
REVISION = '20200817'
# View and manage your data across Google Cloud Platform services
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
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
# Google Compute Engine.
# Corresponds to the JSON property `loginProfile`
@ -55,6 +60,7 @@ module Google
# Update properties of this object
def update!(**args)
@details = args[:details] if args.key?(:details)
@login_profile = args[:login_profile] if args.key?(:login_profile)
end
end

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

@ -61,6 +61,7 @@ module Google
class ImportSshPublicKeyResponse
# @private
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
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
module ServiceconsumermanagementV1
VERSION = 'V1'
REVISION = '20200804'
REVISION = '20200818'
# View and manage your data across Google Cloud Platform services
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`
# are also declared with same name and request/response types in `Storage`. A
# documentation generator or annotation processor will see the effective `
# Storage.GetAcl` method after inherting documentation and annotations as
# Storage.GetAcl` method after inheriting documentation and annotations as
# follows: service Storage ` // Get the underlying ACL object. rpc GetAcl(
# GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=**
# `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1`

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

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
module ServicenetworkingV1beta
VERSION = 'V1beta'
REVISION = '20200804'
REVISION = '20200818'
# View and manage your data across Google Cloud Platform services
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`
# are also declared with same name and request/response types in `Storage`. A
# documentation generator or annotation processor will see the effective `
# Storage.GetAcl` method after inherting documentation and annotations as
# Storage.GetAcl` method after inheriting documentation and annotations as
# follows: service Storage ` // Get the underlying ACL object. rpc GetAcl(
# GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=**
# `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1`

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

@ -27,7 +27,7 @@ module Google
# @see https://cloud.google.com/service-usage/
module ServiceusageV1
VERSION = 'V1'
REVISION = '20200813'
REVISION = '20200818'
# View and manage your data across Google Cloud Platform services
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`
# are also declared with same name and request/response types in `Storage`. A
# documentation generator or annotation processor will see the effective `
# Storage.GetAcl` method after inherting documentation and annotations as
# Storage.GetAcl` method after inheriting documentation and annotations as
# follows: service Storage ` // Get the underlying ACL object. rpc GetAcl(
# GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=**
# `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1`

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

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