class SignBlobResponse(_messages.Message):
r"""A SignBlobResponse object.
Fields:
keyId: The ID of the key used to sign the blob. The key used for signing
will remain valid for at least 12 hours after the blob is signed. To
verify the signature, you can retrieve the public key in several formats
from the following endpoints: - RSA public key wrapped in an X.509 v3
certificate: `https://www.googleapis.com/service_accounts/v1/metadata/x5
09/{ACCOUNT_EMAIL}` - Raw key in JSON format: `https://www.googleapis.co
m/service_accounts/v1/metadata/raw/{ACCOUNT_EMAIL}` - JSON Web Key
(JWK): `https://www.googleapis.com/service_accounts/v1/metadata/jwk/{ACC
OUNT_EMAIL}`
signedBlob: The signature for the blob. Does not include the original
blob. After the key pair referenced by the `key_id` response field
expires, Google no longer exposes the public key that can be used to
verify the blob. As a result, the receiver can no longer verify the
signature.
"""
keyId = _messages.StringField(1)
signedBlob = _messages.BytesField(2)
class Hash(_messages.Message):
"""Container message for hash values.
Enums:
TypeValueValuesEnum: The type of hash that was performed.
Fields:
type: The type of hash that was performed.
value: The hash value.
"""
class TypeValueValuesEnum(_messages.Enum):
"""The type of hash that was performed.
Values:
NONE: No hash requested.
SHA256: Use a sha256 hash.
"""
NONE = 0
SHA256 = 1
type = _messages.EnumField('TypeValueValuesEnum', 1)
value = _messages.BytesField(2)
class ServiceAccount(_messages.Message):
"""A service account in the Identity and Access Management API. To create a
service account, specify the `project_id` and the `account_id` for the
account. The `account_id` is unique within the project, and is used to
generate the service account email address and a stable `unique_id`. All
other methods can identify the service account using the format
`projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for
the project will infer the project from the account. The `account` value can
be the `email` address or the `unique_id` of the service account.
Fields:
description: Optional. A user-specified opaque description of the service
account.
displayName: Optional. A user-specified description of the service
account. Must be fewer than 100 UTF-8 bytes.
email: @OutputOnly The email address of the service account.
etag: Used to perform a consistent read-modify-write.
name: The resource name of the service account in the following format:
`projects/{project}/serviceAccounts/{account}`. Requests using `-` as a
wildcard for the project will infer the project from the `account` and
the `account` value can be the `email` address or the `unique_id` of the
service account. In responses the resource name will always be in the
format `projects/{project}/serviceAccounts/{email}`.
oauth2ClientId: @OutputOnly. The OAuth2 client id for the service account.
This is used in conjunction with the OAuth2 clientconfig API to make
three legged OAuth2 (3LO) flows to access the data of Google users.
projectId: @OutputOnly The id of the project that owns the service
account.
uniqueId: @OutputOnly The unique and stable id of the service account.
"""
description = _messages.StringField(1)
displayName = _messages.StringField(2)
email = _messages.StringField(3)
etag = _messages.BytesField(4)
name = _messages.StringField(5)
oauth2ClientId = _messages.StringField(6)
projectId = _messages.StringField(7)
uniqueId = _messages.StringField(8)
class GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest(_messages.Message):
r"""The request message to search related account group memberships.
Fields:
hashedAccountId: Optional. The unique stable hashed user identifier we
should search connections to. The identifier should correspond to a
`hashed_account_id` provided in a previous CreateAssessment or
AnnotateAssessment call.
pageSize: Optional. The maximum number of groups to return. The service
may return fewer than this value. If unspecified, at most 50 groups will
be returned. The maximum value is 1000; values above 1000 will be
coerced to 1000.
pageToken: Optional. A page token, received from a previous
`SearchRelatedAccountGroupMemberships` call. Provide this to retrieve
the subsequent page. When paginating, all other parameters provided to
`SearchRelatedAccountGroupMemberships` must match the call that provided
the page token.
"""
hashedAccountId = _messages.BytesField(1)
pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32)
pageToken = _messages.StringField(3)
class Hash(_messages.Message):
r"""A hash of file content.
Enums:
TypeValueValuesEnum: The algorithm used to compute the hash value.
Fields:
type: The algorithm used to compute the hash value.
value: The hash value.
"""
class TypeValueValuesEnum(_messages.Enum):
r"""The algorithm used to compute the hash value.
Values:
HASH_TYPE_UNSPECIFIED: Unspecified.
SHA256: SHA256 hash.
"""
HASH_TYPE_UNSPECIFIED = 0
SHA256 = 1
type = _messages.EnumField('TypeValueValuesEnum', 1)
value = _messages.BytesField(2)
class PublicKey(_messages.Message):
r"""A public SSH key, corresponding to a private SSH key held by the client.
Enums:
FormatValueValuesEnum: Required. Format of this key's content.
Fields:
format: Required. Format of this key's content.
key: Required. Content of this key.
name: Output only. Full name of this resource, in the format
`users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.
`{owner_email}` is the email address of the user to whom the key
belongs. `{environment_id}` is the identifier of the environment to
which the key grants access. `{key_id}` is the unique identifier of the
key. For example,
`users/[email protected]/environments/default/publicKeys/myKey`.
"""
class FormatValueValuesEnum(_messages.Enum):
r"""Required. Format of this key's content.
Values:
FORMAT_UNSPECIFIED: Unknown format. Do not use.
SSH_DSS: `ssh-dss` key format (see RFC4253).
SSH_RSA: `ssh-rsa` key format (see RFC4253).
ECDSA_SHA2_NISTP256: `ecdsa-sha2-nistp256` key format (see RFC5656).
ECDSA_SHA2_NISTP384: `ecdsa-sha2-nistp384` key format (see RFC5656).
ECDSA_SHA2_NISTP521: `ecdsa-sha2-nistp521` key format (see RFC5656).
"""
FORMAT_UNSPECIFIED = 0
SSH_DSS = 1
SSH_RSA = 2
ECDSA_SHA2_NISTP256 = 3
ECDSA_SHA2_NISTP384 = 4
ECDSA_SHA2_NISTP521 = 5
format = _messages.EnumField('FormatValueValuesEnum', 1)
key = _messages.BytesField(2)
name = _messages.StringField(3)
class Policy(_messages.Message):
r"""Defines an Identity and Access Management (IAM) policy. It is used to
specify access control policies for Cloud Platform resources. A `Policy`
consists of a list of `bindings`. A `binding` binds a list of `members` to a
`role`, where the members can be user accounts, Google groups, Google
domains, and service accounts. A `role` is a named list of permissions
defined by IAM. **JSON Example** { "bindings": [ {
"role": "roles/owner", "members": [
"user:[email protected]", "group:[email protected]",
"domain:google.com", "serviceAccount:my-other-
[email protected]" ] }, {
"role": "roles/viewer", "members": ["user:[email protected]"]
} ] } **YAML Example** bindings: - members: -
user:[email protected] - group:[email protected] -
domain:google.com - serviceAccount:my-other-
[email protected] role: roles/owner - members:
- user:[email protected] role: roles/viewer For a description of IAM
and its features, see the [IAM developer's
guide](https://cloud.google.com/iam/docs).
Fields:
bindings: Associates a list of `members` to a `role`. `bindings` with no
members will result in an error.
etag: `etag` is used for optimistic concurrency control as a way to help
prevent simultaneous updates of a policy from overwriting each other. It
is strongly suggested that systems make use of the `etag` in the read-
modify-write cycle to perform policy updates in order to avoid race
conditions: An `etag` is returned in the response to `getIamPolicy`, and
systems are expected to put that etag in the request to `setIamPolicy`
to ensure that their change will be applied to the same version of the
policy. If no `etag` is provided in the call to `setIamPolicy`, then
the existing policy is overwritten blindly.
version: Deprecated.
"""
bindings = _messages.MessageField('Binding', 1, repeated=True)
etag = _messages.BytesField(2)
version = _messages.IntegerField(3, variant=_messages.Variant.INT32)
class Results(_messages.Message):
r"""Artifacts created by the build pipeline.
Fields:
artifactManifest: Path to the artifact manifest. Only populated when
artifacts are uploaded.
buildStepImages: List of build step digests, in the order corresponding to
build step indices.
buildStepOutputs: List of build step outputs, produced by builder images,
in the order corresponding to build step indices. [Cloud
Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can
produce this output by writing to `$BUILDER_OUTPUT/output`. Only the
first 4KB of data is stored.
images: Container images that were built as a part of the build.
numArtifacts: Number of artifacts uploaded. Only populated when artifacts
are uploaded.
"""
artifactManifest = _messages.StringField(1)
buildStepImages = _messages.StringField(2, repeated=True)
buildStepOutputs = _messages.BytesField(3, repeated=True)
images = _messages.MessageField('BuiltImage', 4, repeated=True)
numArtifacts = _messages.IntegerField(5)
class Endpoint(_messages.Message):
"""Next available tag: 13
Fields:
addresses: User-provided addresses and ports of the service represented by
an endpoint.
creationTimestamp: [Output Only] Creation timestamp in RFC3339 text
format.
description: An optional user-provided description of the endpoint.
dnsIntegration: The DNS configuration for this endpoint. This must be a
list of fully-qualified URLs to Compute Engine networks.
fingerprint: Supply the fingerprint value for update requests. The
fingerprint value is generated by the server and ensures optimistic
concurrency (so that only one update can be performed at a time). The
fingerprint changes after each update.
id: [Output Only] Unique identifier for the resource; defined by the
server.
name: A user-provided name of the endpoint, which must be unique within
the project. The name must comply with RFC1035. Specifically, the name
must be 1-63 characters long and match the regular expression
[a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a
lowercase letter, and all following characters must be a dash, lowercase
letter, or digit, except the last character, which cannot be a dash.
selfLink: [Output Only] Self link for the endpoint.
state: [Output Only] The current state of the endpoint, as determined by
the system.
"""
addresses = _messages.MessageField('EndpointAddress', 1, repeated=True)
creationTimestamp = _messages.StringField(2)
description = _messages.StringField(3)
dnsIntegration = _messages.MessageField('EndpointDnsIntegration', 4)
fingerprint = _messages.BytesField(5)
id = _messages.IntegerField(6, variant=_messages.Variant.UINT64)
name = _messages.StringField(7)
selfLink = _messages.StringField(8)
state = _messages.StringField(9)
class GoogleDevtoolsArtifactregistryV1alpha1AptArtifact(_messages.Message):
r"""A detailed representation of an Apt artifact. Information in the record
is derived from the archive's control file. See
https://www.debian.org/doc/debian-policy/ch-controlfields.html
Enums:
PackageTypeValueValuesEnum: Output only. An artifact is a binary or source
package.
Fields:
architecture: Output only. Operating system architecture of the artifact.
component: Output only. Repository component of the artifact.
controlFile: Output only. Contents of the artifact's control metadata
file.
name: Output only. The Artifact Registry resource name of the artifact.
packageName: Output only. The Apt package name of the artifact.
packageType: Output only. An artifact is a binary or source package.
"""
class PackageTypeValueValuesEnum(_messages.Enum):
r"""Output only. An artifact is a binary or source package.
Values:
PACKAGE_TYPE_UNSPECIFIED: Package type is not specified.
BINARY: Binary package.
SOURCE: Source package.
"""
PACKAGE_TYPE_UNSPECIFIED = 0
BINARY = 1
SOURCE = 2
architecture = _messages.StringField(1)
component = _messages.StringField(2)
controlFile = _messages.BytesField(3)
name = _messages.StringField(4)
packageName = _messages.StringField(5)
packageType = _messages.EnumField('PackageTypeValueValuesEnum', 6)
class GoogleCloudOrgpolicyV1Policy(_messages.Message):
r"""Defines a Cloud Organization `Policy` which is used to specify
`Constraints` for configurations of Cloud Platform resources.
Fields:
booleanPolicy: For boolean `Constraints`, whether to enforce the
`Constraint` or not.
constraint: The name of the `Constraint` the `Policy` is configuring, for
example, `constraints/serviceuser.services`. Immutable after creation.
etag: An opaque tag indicating the current version of the `Policy`, used
for concurrency control. When the `Policy` is returned from either a
`GetPolicy` or a `ListOrgPolicy` request, this `etag` indicates the
version of the current `Policy` to use when executing a read-modify-
write loop. When the `Policy` is returned from a `GetEffectivePolicy`
request, the `etag` will be unset. When the `Policy` is used in a
`SetOrgPolicy` method, use the `etag` value that was returned from a
`GetOrgPolicy` request as part of a read-modify-write loop for
concurrency control. Not setting the `etag`in a `SetOrgPolicy` request
will result in an unconditional write of the `Policy`.
listPolicy: List of values either allowed or disallowed.
restoreDefault: Restores the default behavior of the constraint;
independent of `Constraint` type.
updateTime: The time stamp the `Policy` was previously updated. This is
set by the server, not specified by the caller, and represents the last
time a call to `SetOrgPolicy` was made for that `Policy`. Any value set
by the client will be ignored.
version: Version of the `Policy`. Default version is 0;
"""
booleanPolicy = _messages.MessageField('GoogleCloudOrgpolicyV1BooleanPolicy', 1)
constraint = _messages.StringField(2)
etag = _messages.BytesField(3)
listPolicy = _messages.MessageField('GoogleCloudOrgpolicyV1ListPolicy', 4)
restoreDefault = _messages.MessageField('GoogleCloudOrgpolicyV1RestoreDefault', 5)
updateTime = _messages.StringField(6)
version = _messages.IntegerField(7, variant=_messages.Variant.INT32)
class Asset(_messages.Message):
r"""Cloud asset. This includes all Google Cloud Platform resources, Cloud
IAM policies, and other non-GCP assets.
Fields:
assetType: Type of the asset. Example: "compute.googleapis.com/Disk".
iamPolicy: Representation of the actual Cloud IAM policy set on a cloud
resource. For each resource, there must be at most one Cloud IAM policy
set on it.
iamPolicyName: Cloud IAM policy name of the Cloud IAM policy set on a
cloud resource. For each resource, there must be at most one Cloud IAM
policy name associated with it.
name: The full name of the asset. For example: `//compute.googleapis.com/p
rojects/my_project_123/zones/zone1/instances/instance1`. See [Resource N
ames](https://cloud.google.com/apis/design/resource_names#full_resource_
name) for more information.
resource: Representation of the resource.
"""
assetType = _messages.StringField(1)
iamPolicy = _messages.MessageField('Policy', 2)
iamPolicyName = _messages.BytesField(3)
name = _messages.StringField(4)
resource = _messages.MessageField('Resource', 5)
class BytesMessage(messages.Message):
field = messages.BytesField(1)
repfield = messages.BytesField(2, repeated=True)
class Policy(_messages.Message):
r"""Defines an Identity and Access Management (IAM) policy. It is used to
specify access control policies for Cloud Platform resources. A `Policy`
is a collection of `bindings`. A `binding` binds one or more `members` to a
single `role`. Members can be user accounts, service accounts, Google
groups, and domains (such as G Suite). A `role` is a named list of
permissions (defined by IAM or configured by users). A `binding` can
optionally specify a `condition`, which is a logic expression that further
constrains the role binding based on attributes about the request and/or
target resource. **JSON Example** { "bindings": [ {
"role": "roles/resourcemanager.organizationAdmin", "members": [
"user:[email protected]", "group:[email protected]",
"domain:google.com", "serviceAccount:my-project-
[email protected]" ] }, {
"role": "roles/resourcemanager.organizationViewer", "members":
["user:[email protected]"], "condition": { "title":
"expirable access", "description": "Does not grant access after
Sep 2020", "expression": "request.time <
timestamp('2020-10-01T00:00:00.000Z')", } } ] }
**YAML Example** bindings: - members: - user:[email protected]
- group:[email protected] - domain:google.com - serviceAccount
:[email protected] role:
roles/resourcemanager.organizationAdmin - members: -
user:[email protected] role: roles/resourcemanager.organizationViewer
condition: title: expirable access description: Does not
grant access after Sep 2020 expression: request.time <
timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its
features, see the [IAM developer's
guide](https://cloud.google.com/iam/docs).
Fields:
auditConfigs: Specifies cloud audit logging configuration for this policy.
bindings: Associates a list of `members` to a `role`. Optionally may
specify a `condition` that determines when binding is in effect.
`bindings` with no members will result in an error.
etag: `etag` is used for optimistic concurrency control as a way to help
prevent simultaneous updates of a policy from overwriting each other. It
is strongly suggested that systems make use of the `etag` in the read-
modify-write cycle to perform policy updates in order to avoid race
conditions: An `etag` is returned in the response to `getIamPolicy`, and
systems are expected to put that etag in the request to `setIamPolicy`
to ensure that their change will be applied to the same version of the
policy. If no `etag` is provided in the call to `setIamPolicy`, then
the existing policy is overwritten. Due to blind-set semantics of an
etag-less policy, 'setIamPolicy' will not fail even if either of
incoming or stored policy does not meet the version requirements.
version: Specifies the format of the policy. Valid values are 0, 1, and
3. Requests specifying an invalid value will be rejected. Operations
affecting conditional bindings must specify version 3. This can be
either setting a conditional policy, modifying a conditional binding, or
removing a conditional binding from the stored conditional policy.
Operations on non-conditional policies may specify any valid value or
leave the field unset. If no etag is provided in the call to
`setIamPolicy`, any version compliance checks on the incoming and/or
stored policy is skipped.
"""
auditConfigs = _messages.MessageField('AuditConfig', 1, repeated=True)
bindings = _messages.MessageField('Binding', 2, repeated=True)
etag = _messages.BytesField(3)
version = _messages.IntegerField(4, variant=_messages.Variant.INT32)
class OidcConfig(_messages.Message):
r"""OidcConfig holds the configuration for the OIDC provider that's used to
authenticate users against a member.
Enums:
TokenEndpointRoutabilityValueValuesEnum: Connection method to be used when
accessing the token endpoint.
Messages:
ExtraParametersValue: Additional parameters required by the Identity
Provider
Fields:
aud: Audience claims to request when fetching the id_token - should
include the --oidc-client-id configured for the cluster.
authorizationEndpoint: Endpoint to be used for authentication of end user,
ex. https://accounts.google.com/o/oauth2/v2/auth. See
https://openid.net/specs/openid-connect-core-
1_0.html#AuthorizationEndpoint
clientId: Client Id for the OAuth client to be used when communicating
with Identity Provider.
clientSecret: Client Secret for the OAuth client to be used when
communicating with Identity Provider.
extraParameters: Additional parameters required by the Identity Provider
issuer: Identity Provider that needs to issue tokens accepted by this
cluster, ex. https://accounts.google.com. Should match the --oidc-
issuer-url configured for the cluster.
scopes: Scopes to be requested from Identity Provider
tokenEndpoint: Endpoint to be used to obtain the id_token, ex.
https://www.googleapis.com/oauth2/v4/token. See https://openid.net/specs
/openid-connect-core-1_0.html#TokenEndpoint
tokenEndpointRoutability: Connection method to be used when accessing the
token endpoint.
"""
class TokenEndpointRoutabilityValueValuesEnum(_messages.Enum):
r"""Connection method to be used when accessing the token endpoint.
Values:
ENDPOINT_ROUTABILITY_UNSPECIFIED: Not set.
PUBLIC: Identity Provider is available over internet
GKE_CONNECT: Identity Provider is available On-Prem, use On-Prem proxy
over GKE Connect.
"""
ENDPOINT_ROUTABILITY_UNSPECIFIED = 0
PUBLIC = 1
GKE_CONNECT = 2
@encoding.MapUnrecognizedFields('additionalProperties')
class ExtraParametersValue(_messages.Message):
r"""Additional parameters required by the Identity Provider
Messages:
AdditionalProperty: An additional property for a ExtraParametersValue
object.
Fields:
additionalProperties: Additional properties of type ExtraParametersValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a ExtraParametersValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
"""
key = _messages.StringField(1)
value = _messages.StringField(2)
additionalProperties = _messages.MessageField('AdditionalProperty',
1,
repeated=True)
aud = _messages.StringField(1, repeated=True)
authorizationEndpoint = _messages.StringField(2)
clientId = _messages.StringField(3)
clientSecret = _messages.BytesField(4)
extraParameters = _messages.MessageField('ExtraParametersValue', 5)
issuer = _messages.StringField(6)
scopes = _messages.StringField(7, repeated=True)
tokenEndpoint = _messages.StringField(8)
tokenEndpointRoutability = _messages.EnumField(
'TokenEndpointRoutabilityValueValuesEnum', 9)
class HttpTarget(_messages.Message):
r"""Http target. The job will be pushed to the job handler by means of an
HTTP request via an HttpTarget.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.
Enums:
HttpMethodValueValuesEnum: Which HTTP method to use for the request.
Messages:
HeadersValue: 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 HttpTarget.url. - Content-Length: This will be computed by
Cloud Scheduler. - User-Agent: This will be populated by Cloud
Scheduler. - X-Google-*: Google internal use only. - X-AppEngine-*:
Google internal use only. The total size of headers must be less than
80KB.
Fields:
body: HTTP request body. A request body is allowed only if the HTTP method
is POST, PUT, or PATCH. It will result in an error to set body on a job
with an incompatible HttpMethod.
headers: 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 HttpTarget.url. - Content-Length: This will be computed by
Cloud Scheduler. - User-Agent: This will be populated by Cloud
Scheduler. - X-Google-*: Google internal use only. - X-AppEngine-*:
Google internal use only. The total size of headers must be less than
80KB.
httpMethod: Which HTTP method to use for the request.
url: Required. The full url path that the request will be sent to. This
string must begin with either "http://" or "https://". Some examples of
valid values for HttpTarget.url 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.
"""
class HttpMethodValueValuesEnum(_messages.Enum):
r"""Which HTTP method to use for the request.
Values:
HTTP_METHOD_UNSPECIFIED: HTTP method unspecified. Defaults to POST.
POST: HTTP Post
GET: HTTP Get
HEAD: HTTP Head
PUT: HTTP Put
DELETE: HTTP Delete
PATCH: HTTP Patch
OPTIONS: HTTP Options
"""
HTTP_METHOD_UNSPECIFIED = 0
POST = 1
GET = 2
HEAD = 3
PUT = 4
DELETE = 5
PATCH = 6
OPTIONS = 7
@encoding.MapUnrecognizedFields('additionalProperties')
class HeadersValue(_messages.Message):
r"""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 HttpTarget.url.
- Content-Length: This will be computed by Cloud Scheduler. - User-Agent:
This will be populated by Cloud Scheduler. - X-Google-*: Google internal
use only. - X-AppEngine-*: Google internal use only. The total size of
headers must be less than 80KB.
Messages:
AdditionalProperty: An additional property for a HeadersValue object.
Fields:
additionalProperties: Additional properties of type HeadersValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a HeadersValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
"""
key = _messages.StringField(1)
value = _messages.StringField(2)
additionalProperties = _messages.MessageField('AdditionalProperty',
1,
repeated=True)
body = _messages.BytesField(1)
headers = _messages.MessageField('HeadersValue', 2)
httpMethod = _messages.EnumField('HttpMethodValueValuesEnum', 3)
url = _messages.StringField(4)
class ServiceAccountKey(_messages.Message):
"""Represents a service account key. A service account has two sets of key-
pairs: user-managed, and system-managed. User-managed key-pairs can be
created and deleted by users. Users are responsible for rotating these keys
periodically to ensure security of their service accounts. Users retain the
private key of these key-pairs, and Google retains ONLY the public key.
System-managed key-pairs are managed automatically by Google, and rotated
daily without user intervention. The private key never leaves Google's
servers to maximize security. Public keys for all service accounts are also
published at the OAuth2 Service Account API.
Enums:
KeyAlgorithmValueValuesEnum: Specifies the algorithm (and possibly key
size) for the key.
PrivateKeyTypeValueValuesEnum: The output format for the private key. Only
provided in `CreateServiceAccountKey` responses, not in
`GetServiceAccountKey` or `ListServiceAccountKey` responses. Google
never exposes system-managed private keys, and never retains user-
managed private keys.
Fields:
keyAlgorithm: Specifies the algorithm (and possibly key size) for the key.
name: The resource name of the service account key in the following format
`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key
}`.
privateKeyData: The private key data. Only provided in
`CreateServiceAccountKey` responses.
privateKeyType: The output format for the private key. Only provided in
`CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or
`ListServiceAccountKey` responses. Google never exposes system-managed
private keys, and never retains user-managed private keys.
publicKeyData: The public key data. Only provided in
`GetServiceAccountKey` responses.
validAfterTime: The key can be used after this timestamp.
validBeforeTime: The key can be used before this timestamp.
"""
class KeyAlgorithmValueValuesEnum(_messages.Enum):
"""Specifies the algorithm (and possibly key size) for the key.
Values:
KEY_ALG_UNSPECIFIED: An unspecified key algorithm.
KEY_ALG_RSA_1024: 1k RSA Key.
KEY_ALG_RSA_2048: 2k RSA Key.
"""
KEY_ALG_UNSPECIFIED = 0
KEY_ALG_RSA_1024 = 1
KEY_ALG_RSA_2048 = 2
class PrivateKeyTypeValueValuesEnum(_messages.Enum):
"""The output format for the private key. Only provided in
`CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or
`ListServiceAccountKey` responses. Google never exposes system-managed
private keys, and never retains user-managed private keys.
Values:
TYPE_UNSPECIFIED: Unspecified. Equivalent to
`TYPE_GOOGLE_CREDENTIALS_FILE`.
TYPE_PKCS12_FILE: PKCS12 format. The password for the PKCS12 file is
`notasecret`. For more information, see
https://tools.ietf.org/html/rfc7292.
TYPE_GOOGLE_CREDENTIALS_FILE: Google Credentials File format.
"""
TYPE_UNSPECIFIED = 0
TYPE_PKCS12_FILE = 1
TYPE_GOOGLE_CREDENTIALS_FILE = 2
keyAlgorithm = _messages.EnumField('KeyAlgorithmValueValuesEnum', 1)
name = _messages.StringField(2)
privateKeyData = _messages.BytesField(3)
privateKeyType = _messages.EnumField('PrivateKeyTypeValueValuesEnum', 4)
publicKeyData = _messages.BytesField(5)
validAfterTime = _messages.StringField(6)
validBeforeTime = _messages.StringField(7)
class HttpTarget(_messages.Message):
r"""Http target. The job will be pushed to the job handler by means of an
HTTP request via an HttpTarget.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.
Enums:
HttpMethodValueValuesEnum: Which HTTP method to use for the request.
Messages:
HeadersValue: 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 HttpTarget.url. - Content-Length: This will be computed by
Cloud Scheduler. - User-Agent: This will be populated by Cloud
Scheduler. - X-Google-*: Google internal use only. - X-AppEngine-*:
Google internal use only. - `X-CloudScheduler`: This header will be set
to true. - `X-CloudScheduler-JobName`: This header will contain the job
name. - `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs
specified in the unix-cron format, this header will contain the job
schedule time in RFC3339 UTC "Zulu" format. The total size of headers
must be less than 80KB.
Fields:
body: 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.
headers: 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 HttpTarget.url. - Content-Length: This will be computed by
Cloud Scheduler. - User-Agent: This will be populated by Cloud
Scheduler. - X-Google-*: Google internal use only. - X-AppEngine-*:
Google internal use only. - `X-CloudScheduler`: This header will be set
to true. - `X-CloudScheduler-JobName`: This header will contain the job
name. - `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs
specified in the unix-cron format, this header will contain the job
schedule time in RFC3339 UTC "Zulu" format. The total size of headers
must be less than 80KB.
httpMethod: Which HTTP method to use for the request.
oauthToken: If specified, an [OAuth
token](https://developers.google.com/identity/protocols/OAuth2) will be
generated and attached as an `Authorization` header in the HTTP request.
This type of authorization should generally only be used when calling
Google APIs hosted on *.googleapis.com.
oidcToken: If specified, an
[OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
token will be generated and attached as an `Authorization` header in the
HTTP request. This type of authorization can be used for many scenarios,
including calling Cloud Run, or endpoints where you intend to validate
the token yourself.
url: Required. The full url path that the request will be sent to. This
string must begin with either "http://" or "https://". Some examples of
valid values for HttpTarget.url 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.
"""
class HttpMethodValueValuesEnum(_messages.Enum):
r"""Which HTTP method to use for the request.
Values:
HTTP_METHOD_UNSPECIFIED: HTTP method unspecified. Defaults to POST.
POST: HTTP Post
GET: HTTP Get
HEAD: HTTP Head
PUT: HTTP Put
DELETE: HTTP Delete
PATCH: HTTP Patch
OPTIONS: HTTP Options
"""
HTTP_METHOD_UNSPECIFIED = 0
POST = 1
GET = 2
HEAD = 3
PUT = 4
DELETE = 5
PATCH = 6
OPTIONS = 7
@encoding.MapUnrecognizedFields('additionalProperties')
class HeadersValue(_messages.Message):
r"""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 HttpTarget.url.
- Content-Length: This will be computed by Cloud Scheduler. - User-Agent:
This will be populated by Cloud Scheduler. - X-Google-*: Google internal
use only. - X-AppEngine-*: Google internal use only. - `X-CloudScheduler`:
This header will be set to true. - `X-CloudScheduler-JobName`: This header
will contain the job name. - `X-CloudScheduler-ScheduleTime`: For Cloud
Scheduler jobs specified in the unix-cron format, this header will contain
the job schedule time in RFC3339 UTC "Zulu" format. The total size of
headers must be less than 80KB.
Messages:
AdditionalProperty: An additional property for a HeadersValue object.
Fields:
additionalProperties: Additional properties of type HeadersValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a HeadersValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
"""
key = _messages.StringField(1)
value = _messages.StringField(2)
additionalProperties = _messages.MessageField('AdditionalProperty',
1,
repeated=True)
body = _messages.BytesField(1)
headers = _messages.MessageField('HeadersValue', 2)
httpMethod = _messages.EnumField('HttpMethodValueValuesEnum', 3)
oauthToken = _messages.MessageField('OAuthToken', 4)
oidcToken = _messages.MessageField('OidcToken', 5)
url = _messages.StringField(6)
class AdditionalProperty(messages.Message):
key = messages.StringField(1)
value = messages.BytesField(2)
class PubsubMessage(_messages.Message):
r"""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.
Messages:
AttributesValue: 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.
Fields:
attributes: 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.
data: The message data field. If this field is empty, the message must
contain at least one attribute.
messageId: ID of this message, assigned by the server when the message is
published. Guaranteed to be unique within the topic. This value may be
read by a subscriber that receives a `PubsubMessage` via a `Pull` call
or a push delivery. It must not be populated by the publisher in a
`Publish` call.
orderingKey: 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.
publishTime: 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.
"""
@encoding.MapUnrecognizedFields('additionalProperties')
class AttributesValue(_messages.Message):
r"""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.
Messages:
AdditionalProperty: An additional property for a AttributesValue object.
Fields:
additionalProperties: Additional properties of type AttributesValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a AttributesValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
"""
key = _messages.StringField(1)
value = _messages.StringField(2)
additionalProperties = _messages.MessageField('AdditionalProperty',
1,
repeated=True)
attributes = _messages.MessageField('AttributesValue', 1)
data = _messages.BytesField(2)
messageId = _messages.StringField(3)
orderingKey = _messages.StringField(4)
publishTime = _messages.StringField(5)
class GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest(_messages.Message):
r"""The request message to annotate an Assessment.
Enums:
AnnotationValueValuesEnum: Optional. The annotation that will be assigned
to the Event. This field can be left empty to provide reasons that apply
to an event without concluding whether the event is legitimate or
fraudulent.
ReasonsValueListEntryValuesEnum:
Fields:
annotation: Optional. The annotation that will be assigned to the Event.
This field can be left empty to provide reasons that apply to an event
without concluding whether the event is legitimate or fraudulent.
hashedAccountId: Optional. Optional unique stable hashed user identifier
to apply to the assessment. This is an alternative to setting the
hashed_account_id in CreateAssessment, for example when the account
identifier is not yet known in the initial request. It is recommended
that the identifier is hashed using hmac-sha256 with stable secret.
reasons: Optional. Optional reasons for the annotation that will be
assigned to the Event.
"""
class AnnotationValueValuesEnum(_messages.Enum):
r"""Optional. The annotation that will be assigned to the Event. This
field can be left empty to provide reasons that apply to an event without
concluding whether the event is legitimate or fraudulent.
Values:
ANNOTATION_UNSPECIFIED: Default unspecified type.
LEGITIMATE: Provides information that the event turned out to be
legitimate.
FRAUDULENT: Provides information that the event turned out to be
fraudulent.
PASSWORD_CORRECT: Provides information that the event was related to a
login event in which the user typed the correct password. Deprecated,
prefer indicating CORRECT_PASSWORD through the reasons field instead.
PASSWORD_INCORRECT: Provides information that the event was related to a
login event in which the user typed the incorrect password.
Deprecated, prefer indicating INCORRECT_PASSWORD through the reasons
field instead.
"""
ANNOTATION_UNSPECIFIED = 0
LEGITIMATE = 1
FRAUDULENT = 2
PASSWORD_CORRECT = 3
PASSWORD_INCORRECT = 4
class ReasonsValueListEntryValuesEnum(_messages.Enum):
r"""ReasonsValueListEntryValuesEnum enum type.
Values:
REASON_UNSPECIFIED: Default unspecified reason.
CHARGEBACK: Indicates a chargeback issued for the transaction with no
other details. When possible, specify the type by using
CHARGEBACK_FRAUD or CHARGEBACK_DISPUTE instead.
CHARGEBACK_FRAUD: Indicates a chargeback related to an alleged
unauthorized transaction from the cardholder's perspective (for
example, the card number was stolen).
CHARGEBACK_DISPUTE: Indicates a chargeback related to the cardholder
having provided their card details but allegedly not being satisfied
with the purchase (for example, misrepresentation, attempted
cancellation).
PAYMENT_HEURISTICS: Indicates the transaction associated with the
assessment is suspected of being fraudulent based on the payment
method, billing details, shipping address or other transaction
information.
INITIATED_TWO_FACTOR: Indicates that the user was served a 2FA
challenge. An old assessment with `ENUM_VALUES.INITIATED_TWO_FACTOR`
reason that has not been overwritten with `PASSED_TWO_FACTOR` is
treated as an abandoned 2FA flow. This is equivalent to
`FAILED_TWO_FACTOR`.
PASSED_TWO_FACTOR: Indicates that the user passed a 2FA challenge.
FAILED_TWO_FACTOR: Indicates that the user failed a 2FA challenge.
CORRECT_PASSWORD: Indicates the user provided the correct password.
INCORRECT_PASSWORD: Indicates the user provided an incorrect password.
"""
REASON_UNSPECIFIED = 0
CHARGEBACK = 1
CHARGEBACK_FRAUD = 2
CHARGEBACK_DISPUTE = 3
PAYMENT_HEURISTICS = 4
INITIATED_TWO_FACTOR = 5
PASSED_TWO_FACTOR = 6
FAILED_TWO_FACTOR = 7
CORRECT_PASSWORD = 8
INCORRECT_PASSWORD = 9
annotation = _messages.EnumField('AnnotationValueValuesEnum', 1)
hashedAccountId = _messages.BytesField(2)
reasons = _messages.EnumField('ReasonsValueListEntryValuesEnum', 3, repeated=True)
class SimpleMessage(messages.Message):
field = messages.StringField(1)
bytes_field = messages.BytesField(2)
class AppEngineHttpTarget(_messages.Message):
r"""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.
Enums:
HttpMethodValueValuesEnum: The HTTP method to use for the request. PATCH
and OPTIONS are not permitted.
Messages:
HeadersValue: 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.
Fields:
appEngineRouting: App Engine Routing setting for the job.
body: 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.
headers: 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.
httpMethod: The HTTP method to use for the request. PATCH and OPTIONS are
not permitted.
relativeUri: 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.
"""
class HttpMethodValueValuesEnum(_messages.Enum):
r"""The HTTP method to use for the request. PATCH and OPTIONS are not
permitted.
Values:
HTTP_METHOD_UNSPECIFIED: HTTP method unspecified. Defaults to POST.
POST: HTTP POST
GET: HTTP GET
HEAD: HTTP HEAD
PUT: HTTP PUT
DELETE: HTTP DELETE
PATCH: HTTP PATCH
OPTIONS: HTTP OPTIONS
"""
HTTP_METHOD_UNSPECIFIED = 0
POST = 1
GET = 2
HEAD = 3
PUT = 4
DELETE = 5
PATCH = 6
OPTIONS = 7
@encoding.MapUnrecognizedFields('additionalProperties')
class HeadersValue(_messages.Message):
r"""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.
Messages:
AdditionalProperty: An additional property for a HeadersValue object.
Fields:
additionalProperties: Additional properties of type HeadersValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a HeadersValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
"""
key = _messages.StringField(1)
value = _messages.StringField(2)
additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
appEngineRouting = _messages.MessageField('AppEngineRouting', 1)
body = _messages.BytesField(2)
headers = _messages.MessageField('HeadersValue', 3)
httpMethod = _messages.EnumField('HttpMethodValueValuesEnum', 4)
relativeUri = _messages.StringField(5)
class StandardQueryParameters(messages.Message):
field = messages.StringField(1)
prettyPrint = messages.BooleanField(5, default=True) # pylint: disable=invalid-name
pp = messages.BooleanField(6, default=True)
nextPageToken = messages.BytesField(7) # pylint:disable=invalid-name
class AppEngineHttpTarget(_messages.Message):
"""App Engine target. The job will be pushed to a job handler by means of an
HTTP request via an AppEngineHttpTarget.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 execution.
Enums:
HttpMethodValueValuesEnum: The HTTP method to use for the request. The
default is POST.
Messages:
HeadersValue: 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`.
If the job has an AppEngineHttpTarget.payload, 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. See [Reading request
headers](/appengine/docs/python/taskqueue/push/creating-
handlers#reading_request_headers). In addition, some App Engine
headers, which contain job-specific information, are also be sent to the
job handler; see [request headers](/appengine/docs/python/taskqueue/push
/creating-handlers#reading_request_headers).
Fields:
appEngineRouting: App Engine Routing setting for the job.
headers: 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`. If the job has an AppEngineHttpTarget.payload,
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. See [Reading
request headers](/appengine/docs/python/taskqueue/push/creating-
handlers#reading_request_headers). In addition, some App Engine
headers, which contain job-specific information, are also be sent to the
job handler; see [request headers](/appengine/docs/python/taskqueue/push
/creating-handlers#reading_request_headers).
httpMethod: The HTTP method to use for the request. The default is POST.
payload: Payload. The payload will be sent as the HTTP message body. A
message body, and thus a payload, is allowed only if the HTTP method is
POST or PUT. It is an error to set a data payload on a job with an
incompatible HttpMethod.
relativeUrl: The relative URL. 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.
retryConfig: Settings that determine the retry behavior.
"""
class HttpMethodValueValuesEnum(_messages.Enum):
"""The HTTP method to use for the request. The default is POST.
Values:
HTTP_METHOD_UNSPECIFIED: HTTP method unspecified
POST: HTTP Post
GET: HTTP Get
HEAD: HTTP Head
PUT: HTTP Put
DELETE: HTTP Delete
"""
HTTP_METHOD_UNSPECIFIED = 0
POST = 1
GET = 2
HEAD = 3
PUT = 4
DELETE = 5
@encoding.MapUnrecognizedFields('additionalProperties')
class HeadersValue(_messages.Message):
"""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`. If the job has an AppEngineHttpTarget.payload, 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. See [Reading request
headers](/appengine/docs/python/taskqueue/push/creating-
handlers#reading_request_headers). In addition, some App Engine headers,
which contain job-specific information, are also be sent to the job
handler; see [request headers](/appengine/docs/python/taskqueue/push
/creating-handlers#reading_request_headers).
Messages:
AdditionalProperty: An additional property for a HeadersValue object.
Fields:
additionalProperties: Additional properties of type HeadersValue
"""
class AdditionalProperty(_messages.Message):
"""An additional property for a HeadersValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
"""
key = _messages.StringField(1)
value = _messages.StringField(2)
additionalProperties = _messages.MessageField('AdditionalProperty',
1,
repeated=True)
appEngineRouting = _messages.MessageField('AppEngineRouting', 1)
headers = _messages.MessageField('HeadersValue', 2)
httpMethod = _messages.EnumField('HttpMethodValueValuesEnum', 3)
payload = _messages.BytesField(4)
relativeUrl = _messages.StringField(5)
retryConfig = _messages.MessageField('RetryConfig', 6)
class HttpTarget(_messages.Message):
r"""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.
Enums:
HttpMethodValueValuesEnum: Which HTTP method to use for the request.
Messages:
HeadersValue: 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.
Fields:
body: 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.
headers: 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.
httpMethod: Which HTTP method to use for the request.
oauthToken: If specified, an [OAuth
token](https://developers.google.com/identity/protocols/OAuth2) will be
generated and attached as an `Authorization` header in the HTTP request.
This type of authorization should be used when sending requests to a GCP
endpoint.
oidcToken: If specified, an
[OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
token will be generated and attached as an `Authorization` header in the
HTTP request. This type of authorization should be used when sending
requests to third party endpoints or Cloud Run.
uri: 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.
"""
class HttpMethodValueValuesEnum(_messages.Enum):
r"""Which HTTP method to use for the request.
Values:
HTTP_METHOD_UNSPECIFIED: HTTP method unspecified. Defaults to POST.
POST: HTTP POST
GET: HTTP GET
HEAD: HTTP HEAD
PUT: HTTP PUT
DELETE: HTTP DELETE
PATCH: HTTP PATCH
OPTIONS: HTTP OPTIONS
"""
HTTP_METHOD_UNSPECIFIED = 0
POST = 1
GET = 2
HEAD = 3
PUT = 4
DELETE = 5
PATCH = 6
OPTIONS = 7
@encoding.MapUnrecognizedFields('additionalProperties')
class HeadersValue(_messages.Message):
r"""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.
Messages:
AdditionalProperty: An additional property for a HeadersValue object.
Fields:
additionalProperties: Additional properties of type HeadersValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a HeadersValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
"""
key = _messages.StringField(1)
value = _messages.StringField(2)
additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
body = _messages.BytesField(1)
headers = _messages.MessageField('HeadersValue', 2)
httpMethod = _messages.EnumField('HttpMethodValueValuesEnum', 3)
oauthToken = _messages.MessageField('OAuthToken', 4)
oidcToken = _messages.MessageField('OidcToken', 5)
uri = _messages.StringField(6)
class FakeMessage(_messages.Message):
"""A FakeMessage object.
Fields:
string1: the first string
string2: a repeated string
enum1: a FakeEnum
enum2: a repeated FakeEnum
bool1: a boolean
int1: an int
float1: a float
bytes1: a byte string
message1: an InnerMessage message
message2: an InnerMessage2 message
repeated_message: a repeated InnerMessage message.
"""
class InnerMessage(_messages.Message):
"""A InnerMessage object.
Fields:
string1: the first string
string2: The second string. It also happens to have a really long
description that wraps lines, which is convenient for testing that
capability.
int1: an integer
enum1: an enum
"""
string1 = _messages.StringField(1)
string2 = _messages.StringField(2)
int1 = _messages.IntegerField(3)
enum1 = _messages.EnumField('FakeEnum', 4)
class InnerMessage2(_messages.Message):
"""A InnerMessage2 object.
Fields:
deeper_message: a DeeperMessage message
"""
class DeeperMessage(_messages.Message):
"""A DeeperMessage object.
Fields:
deep_string: a string
output_string: [Output Only] a string that cannot be set.
output_string2: another string that cannot be set.@OutputOnly
"""
deep_string = _messages.StringField(1)
output_string = _messages.StringField(2)
output_string2 = _messages.StringField(3)
deeper_message = _messages.MessageField('DeeperMessage', 1)
class FakeEnum(_messages.Enum):
"""A FakeEnum object.
Values:
THING_ONE: the first thing
THING_TWO: the second thing
"""
THING_ONE = 0
THING_TWO = 1
string1 = _messages.StringField(1)
string2 = _messages.StringField(2, repeated=True)
enum1 = _messages.EnumField('FakeEnum', 3)
enum2 = _messages.EnumField('FakeEnum', 4, repeated=True)
bool1 = _messages.BooleanField(5)
int1 = _messages.IntegerField(6)
float1 = _messages.FloatField(7)
bytes1 = _messages.BytesField(8)
message1 = _messages.MessageField('InnerMessage', 9)
message2 = _messages.MessageField('InnerMessage2', 10)
repeated_message = _messages.MessageField('InnerMessage',
11,
repeated=True)
class Policy(_messages.Message):
r"""An Identity and Access Management (IAM) policy, which specifies access
controls for Google Cloud resources. A `Policy` is a collection of
`bindings`. A `binding` binds one or more `members` to a single `role`.
Members can be user accounts, service accounts, Google groups, and domains
(such as G Suite). A `role` is a named list of permissions; each `role` can
be an IAM predefined role or a user-created custom role. Optionally, a
`binding` can specify a `condition`, which is a logical expression that
allows access to a resource only if the expression evaluates to `true`. A
condition can add constraints based on attributes of the request, the
resource, or both. **JSON example:** { "bindings": [ {
"role": "roles/resourcemanager.organizationAdmin", "members": [
"user:[email protected]", "group:[email protected]",
"domain:google.com", "serviceAccount:my-project-
[email protected]" ] }, {
"role": "roles/resourcemanager.organizationViewer", "members":
["user:[email protected]"], "condition": { "title":
"expirable access", "description": "Does not grant access after
Sep 2020", "expression": "request.time <
timestamp('2020-10-01T00:00:00.000Z')", } } ],
"etag": "BwWWja0YfJA=", "version": 3 } **YAML example:**
bindings: - members: - user:[email protected] -
group:[email protected] - domain:google.com - serviceAccount
:[email protected] role:
roles/resourcemanager.organizationAdmin - members: -
user:[email protected] role: roles/resourcemanager.organizationViewer
condition: title: expirable access description: Does not
grant access after Sep 2020 expression: request.time <
timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= -
version: 3 For a description of IAM and its features, see the [IAM
documentation](https://cloud.google.com/iam/docs/).
Fields:
auditConfigs: Specifies cloud audit logging configuration for this policy.
bindings: Associates a list of `members` to a `role`. Optionally, may
specify a `condition` that determines how and when the `bindings` are
applied. Each of the `bindings` must contain at least one member.
etag: `etag` is used for optimistic concurrency control as a way to help
prevent simultaneous updates of a policy from overwriting each other. It
is strongly suggested that systems make use of the `etag` in the read-
modify-write cycle to perform policy updates in order to avoid race
conditions: An `etag` is returned in the response to `getIamPolicy`, and
systems are expected to put that etag in the request to `setIamPolicy`
to ensure that their change will be applied to the same version of the
policy. **Important:** If you use IAM Conditions, you must include the
`etag` field whenever you call `setIamPolicy`. If you omit this field,
then IAM allows you to overwrite a version `3` policy with a version `1`
policy, and all of the conditions in the version `3` policy are lost.
version: Specifies the format of the policy. Valid values are `0`, `1`,
and `3`. Requests that specify an invalid value are rejected. Any
operation that affects conditional role bindings must specify version
`3`. This requirement applies to the following operations: * Getting a
policy that includes a conditional role binding * Adding a conditional
role binding to a policy * Changing a conditional role binding in a
policy * Removing any role binding, with or without a condition, from a
policy that includes conditions **Important:** If you use IAM
Conditions, you must include the `etag` field whenever you call
`setIamPolicy`. If you omit this field, then IAM allows you to overwrite
a version `3` policy with a version `1` policy, and all of the
conditions in the version `3` policy are lost. If a policy does not
include any conditions, operations on that policy may specify any valid
version or leave the field unset.
"""
auditConfigs = _messages.MessageField('AuditConfig', 1, repeated=True)
bindings = _messages.MessageField('Binding', 2, repeated=True)
etag = _messages.BytesField(3)
version = _messages.IntegerField(4, variant=_messages.Variant.INT32)
class IoCloudeventsV1CloudEvent(_messages.Message):
r"""-- CloudEvent Context Attributes
Messages:
AttributesValue: Optional & Extension Attributes
ProtoDataValue: A ProtoDataValue object.
Fields:
attributes: Optional & Extension Attributes
binaryData: A byte attribute.
id: Required Attributes
protoData: A ProtoDataValue attribute.
source: URI-reference
specVersion: A string attribute.
textData: A string attribute.
type: A string attribute.
"""
@encoding.MapUnrecognizedFields('additionalProperties')
class AttributesValue(_messages.Message):
r"""Optional & Extension Attributes
Messages:
AdditionalProperty: An additional property for a AttributesValue object.
Fields:
additionalProperties: Additional properties of type AttributesValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a AttributesValue object.
Fields:
key: Name of the additional property.
value: A IoCloudeventsV1CloudEventCloudEventAttributeValue attribute.
"""
key = _messages.StringField(1)
value = _messages.MessageField(
'IoCloudeventsV1CloudEventCloudEventAttributeValue', 2)
additionalProperties = _messages.MessageField('AdditionalProperty',
1,
repeated=True)
@encoding.MapUnrecognizedFields('additionalProperties')
class ProtoDataValue(_messages.Message):
r"""A ProtoDataValue object.
Messages:
AdditionalProperty: An additional property for a ProtoDataValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a ProtoDataValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
"""
key = _messages.StringField(1)
value = _messages.MessageField('extra_types.JsonValue', 2)
additionalProperties = _messages.MessageField('AdditionalProperty',
1,
repeated=True)
attributes = _messages.MessageField('AttributesValue', 1)
binaryData = _messages.BytesField(2)
id = _messages.StringField(3)
protoData = _messages.MessageField('ProtoDataValue', 4)
source = _messages.StringField(5)
specVersion = _messages.StringField(6)
textData = _messages.StringField(7)
type = _messages.StringField(8)
