class RecognitionConfig(_messages.Message):
r"""Provides information to the recognizer that specifies how to process the
request.
Enums:
EncodingValueValuesEnum: Encoding of audio data sent in all
`RecognitionAudio` messages. This field is optional for `FLAC` and `WAV`
audio files and required for all other audio formats. For details, see
AudioEncoding.
Fields:
audioChannelCount: The number of channels in the input audio data. ONLY
set this for MULTI-CHANNEL recognition. Valid values for LINEAR16 and
FLAC are `1`-`8`. Valid values for OGG_OPUS are '1'-'254'. Valid value
for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`. If `0` or
omitted, defaults to one channel (mono). Note: We only recognize the
first channel by default. To perform independent recognition on each
channel set `enable_separate_recognition_per_channel` to 'true'.
diarizationConfig: Config to enable speaker diarization and set additional
parameters to make diarization better suited for your application. Note:
When this is enabled, we send all the words from the beginning of the
audio for the top alternative in every consecutive STREAMING responses.
This is done in order to improve our speaker tags as our models learn to
identify the speakers in the conversation over time. For non-streaming
requests, the diarization results will be provided only in the top
alternative of the FINAL SpeechRecognitionResult.
enableAutomaticPunctuation: If 'true', adds punctuation to recognition
result hypotheses. This feature is only available in select languages.
Setting this for requests in other languages has no effect at all. The
default 'false' value does not add punctuation to result hypotheses.
enableSeparateRecognitionPerChannel: This needs to be set to `true`
explicitly and `audio_channel_count` > 1 to get each channel recognized
separately. The recognition result will contain a `channel_tag` field to
state which channel that result belongs to. If this is not true, we will
only recognize the first channel. The request is billed cumulatively for
all channels recognized: `audio_channel_count` multiplied by the length
of the audio.
enableWordTimeOffsets: If `true`, the top result includes a list of words
and the start and end time offsets (timestamps) for those words. If
`false`, no word-level time offset information is returned. The default
is `false`.
encoding: Encoding of audio data sent in all `RecognitionAudio` messages.
This field is optional for `FLAC` and `WAV` audio files and required for
all other audio formats. For details, see AudioEncoding.
languageCode: Required. The language of the supplied audio as a
[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
Example: "en-US". See [Language
Support](https://cloud.google.com/speech-to-text/docs/languages) for a
list of the currently supported language codes.
maxAlternatives: Maximum number of recognition hypotheses to be returned.
Specifically, the maximum number of `SpeechRecognitionAlternative`
messages within each `SpeechRecognitionResult`. The server may return
fewer than `max_alternatives`. Valid values are `0`-`30`. A value of `0`
or `1` will return a maximum of one. If omitted, will return a maximum
of one.
metadata: Metadata regarding this request.
model: Which model to select for the given request. Select the model best
suited to your domain to get best results. If a model is not explicitly
specified, then we auto-select a model based on the parameters in the
RecognitionConfig. <table> <tr> <td><b>Model</b></td>
<td><b>Description</b></td> </tr> <tr>
<td><code>command_and_search</code></td> <td>Best for short queries
such as voice commands or voice search.</td> </tr> <tr>
<td><code>phone_call</code></td> <td>Best for audio that originated
from a phone call (typically recorded at an 8khz sampling
rate).</td> </tr> <tr> <td><code>video</code></td> <td>Best
for audio that originated from from video or includes multiple
speakers. Ideally the audio is recorded at a 16khz or greater
sampling rate. This is a premium model that costs more than the
standard rate.</td> </tr> <tr> <td><code>default</code></td>
<td>Best for audio that is not one of the specific audio models.
For example, long-form audio. Ideally the audio is high-fidelity,
recorded at a 16khz or greater sampling rate.</td> </tr> </table>
profanityFilter: If set to `true`, the server will attempt to filter out
profanities, replacing all but the initial character in each filtered
word with asterisks, e.g. "f***". If set to `false` or omitted,
profanities won't be filtered out.
sampleRateHertz: Sample rate in Hertz of the audio data sent in all
`RecognitionAudio` messages. Valid values are: 8000-48000. 16000 is
optimal. For best results, set the sampling rate of the audio source to
16000 Hz. If that's not possible, use the native sample rate of the
audio source (instead of re-sampling). This field is optional for FLAC
and WAV audio files, but is required for all other audio formats. For
details, see AudioEncoding.
speechContexts: Array of SpeechContext. A means to provide context to
assist the speech recognition. For more information, see [speech
adaptation](https://cloud.google.com/speech-to-text/docs/context-
strength).
useEnhanced: Set to true to use an enhanced model for speech recognition.
If `use_enhanced` is set to true and the `model` field is not set, then
an appropriate enhanced model is chosen if an enhanced model exists for
the audio. If `use_enhanced` is true and an enhanced version of the
specified model does not exist, then the speech is recognized using the
standard version of the specified model.
"""
class EncodingValueValuesEnum(_messages.Enum):
r"""Encoding of audio data sent in all `RecognitionAudio` messages. This
field is optional for `FLAC` and `WAV` audio files and required for all
other audio formats. For details, see AudioEncoding.
Values:
ENCODING_UNSPECIFIED: Not specified.
LINEAR16: Uncompressed 16-bit signed little-endian samples (Linear PCM).
FLAC: `FLAC` (Free Lossless Audio Codec) is the recommended encoding
because it is lossless--therefore recognition is not compromised--and
requires only about half the bandwidth of `LINEAR16`. `FLAC` stream
encoding supports 16-bit and 24-bit samples, however, not all fields
in `STREAMINFO` are supported.
MULAW: 8-bit samples that compand 14-bit audio samples using G.711
PCMU/mu-law.
AMR: Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be
8000.
AMR_WB: Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be
16000.
OGG_OPUS: Opus encoded audio frames in Ogg container
([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must
be one of 8000, 12000, 16000, 24000, or 48000.
SPEEX_WITH_HEADER_BYTE: Although the use of lossy encodings is not
recommended, if a very low bitrate encoding is required, `OGG_OPUS` is
highly preferred over Speex encoding. The [Speex](https://speex.org/)
encoding supported by Cloud Speech API has a header byte in each
block, as in MIME type `audio/x-speex-with-header-byte`. It is a
variant of the RTP Speex encoding defined in [RFC
5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence
of blocks, one block per RTP packet. Each block starts with a byte
containing the length of the block, in bytes, followed by one or more
frames of Speex data, padded to an integral number of bytes (octets)
as specified in RFC 5574. In other words, each RTP header is replaced
with a single byte containing the block length. Only Speex wideband is
supported. `sample_rate_hertz` must be 16000.
"""
ENCODING_UNSPECIFIED = 0
LINEAR16 = 1
FLAC = 2
MULAW = 3
AMR = 4
AMR_WB = 5
OGG_OPUS = 6
SPEEX_WITH_HEADER_BYTE = 7
audioChannelCount = _messages.IntegerField(1, variant=_messages.Variant.INT32)
diarizationConfig = _messages.MessageField('SpeakerDiarizationConfig', 2)
enableAutomaticPunctuation = _messages.BooleanField(3)
enableSeparateRecognitionPerChannel = _messages.BooleanField(4)
enableWordTimeOffsets = _messages.BooleanField(5)
encoding = _messages.EnumField('EncodingValueValuesEnum', 6)
languageCode = _messages.StringField(7)
maxAlternatives = _messages.IntegerField(8, variant=_messages.Variant.INT32)
metadata = _messages.MessageField('RecognitionMetadata', 9)
model = _messages.StringField(10)
profanityFilter = _messages.BooleanField(11)
sampleRateHertz = _messages.IntegerField(12, variant=_messages.Variant.INT32)
speechContexts = _messages.MessageField('SpeechContext', 13, repeated=True)
useEnhanced = _messages.BooleanField(14)
class ScanRun(_messages.Message):
r"""A ScanRun is a output-only resource representing an actual run of the
scan. Next id: 12
Enums:
ExecutionStateValueValuesEnum: Output only. The execution state of the
ScanRun.
ResultStateValueValuesEnum: Output only. The result state of the ScanRun.
This field is only available after the execution state reaches
"FINISHED".
Fields:
endTime: Output only. The time at which the ScanRun reached termination
state - that the ScanRun is either finished or stopped by user.
errorTrace: Output only. If result_state is an ERROR, this field provides
the primary reason for scan's termination and more details, if such are
available.
executionState: Output only. The execution state of the ScanRun.
hasVulnerabilities: Output only. Whether the scan run has found any
vulnerabilities.
name: Output only. The resource name of the ScanRun. The name follows the
format of
'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
The ScanRun IDs are generated by the system.
progressPercent: Output only. The percentage of total completion ranging
from 0 to 100. If the scan is in queue, the value is 0. If the scan is
running, the value ranges from 0 to 100. If the scan is finished, the
value is 100.
resultState: Output only. The result state of the ScanRun. This field is
only available after the execution state reaches "FINISHED".
startTime: Output only. The time at which the ScanRun started.
urlsCrawledCount: Output only. The number of URLs crawled during this
ScanRun. If the scan is in progress, the value represents the number of
URLs crawled up to now.
urlsTestedCount: Output only. The number of URLs tested during this
ScanRun. If the scan is in progress, the value represents the number of
URLs tested up to now. The number of URLs tested is usually larger than
the number URLS crawled because typically a crawled URL is tested with
multiple test payloads.
warningTraces: Output only. A list of warnings, if such are encountered
during this scan run.
"""
class ExecutionStateValueValuesEnum(_messages.Enum):
r"""Output only. The execution state of the ScanRun.
Values:
EXECUTION_STATE_UNSPECIFIED: Represents an invalid state caused by
internal server error. This value should never be returned.
QUEUED: The scan is waiting in the queue.
SCANNING: The scan is in progress.
FINISHED: The scan is either finished or stopped by user.
"""
EXECUTION_STATE_UNSPECIFIED = 0
QUEUED = 1
SCANNING = 2
FINISHED = 3
class ResultStateValueValuesEnum(_messages.Enum):
r"""Output only. The result state of the ScanRun. This field is only
available after the execution state reaches "FINISHED".
Values:
RESULT_STATE_UNSPECIFIED: Default value. This value is returned when the
ScanRun is not yet finished.
SUCCESS: The scan finished without errors.
ERROR: The scan finished with errors.
KILLED: The scan was terminated by user.
"""
RESULT_STATE_UNSPECIFIED = 0
SUCCESS = 1
ERROR = 2
KILLED = 3
endTime = _messages.StringField(1)
errorTrace = _messages.MessageField('ScanRunErrorTrace', 2)
executionState = _messages.EnumField('ExecutionStateValueValuesEnum', 3)
hasVulnerabilities = _messages.BooleanField(4)
name = _messages.StringField(5)
progressPercent = _messages.IntegerField(6,
variant=_messages.Variant.INT32)
resultState = _messages.EnumField('ResultStateValueValuesEnum', 7)
startTime = _messages.StringField(8)
urlsCrawledCount = _messages.IntegerField(9)
urlsTestedCount = _messages.IntegerField(10)
warningTraces = _messages.MessageField('ScanRunWarningTrace',
11,
repeated=True)
class StandardQueryParameters(_messages.Message):
"""Query parameters accepted by all methods.
Enums:
FXgafvValueValuesEnum: V1 error format.
AltValueValuesEnum: Data format for response.
Fields:
f__xgafv: V1 error format.
access_token: OAuth access token.
alt: Data format for response.
bearer_token: OAuth bearer token.
callback: JSONP
fields: Selector specifying which fields to include in a partial response.
key: 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.
oauth_token: OAuth 2.0 token for the current user.
pp: Pretty-print response.
prettyPrint: Returns response with indentations and line breaks.
quotaUser: Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should
not exceed 40 characters.
trace: A tracing token of the form "token:<tokenid>" to include in api
requests.
uploadType: Legacy upload protocol for media (e.g. "media", "multipart").
upload_protocol: Upload protocol for media (e.g. "raw", "multipart").
"""
class AltValueValuesEnum(_messages.Enum):
"""Data format for response.
Values:
json: Responses with Content-Type of application/json
media: Media download with context-dependent Content-Type
proto: Responses with Content-Type of application/x-protobuf
"""
json = 0
media = 1
proto = 2
class FXgafvValueValuesEnum(_messages.Enum):
"""V1 error format.
Values:
_1: v1 error format
_2: v2 error format
"""
_1 = 0
_2 = 1
f__xgafv = _messages.EnumField('FXgafvValueValuesEnum', 1)
access_token = _messages.StringField(2)
alt = _messages.EnumField('AltValueValuesEnum', 3, default=u'json')
bearer_token = _messages.StringField(4)
callback = _messages.StringField(5)
fields = _messages.StringField(6)
key = _messages.StringField(7)
oauth_token = _messages.StringField(8)
pp = _messages.BooleanField(9, default=True)
prettyPrint = _messages.BooleanField(10, default=True)
quotaUser = _messages.StringField(11)
trace = _messages.StringField(12)
uploadType = _messages.StringField(13)
upload_protocol = _messages.StringField(14)
class DevicePolicy(_messages.Message):
r"""`DevicePolicy` specifies device specific restrictions necessary to
acquire a given access level. A `DevicePolicy` specifies requirements for
requests from devices to be granted access levels, it does not do any
enforcement on the device. `DevicePolicy` acts as an AND over all specified
fields, and each repeated field is an OR over its elements. Any unset fields
are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS,
os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the
DevicePolicy will be true for requests originating from encrypted Linux
desktops and encrypted Windows desktops.
Enums:
AllowedDeviceManagementLevelsValueListEntryValuesEnum:
AllowedEncryptionStatusesValueListEntryValuesEnum:
Fields:
allowedDeviceManagementLevels: Allowed device management levels, an empty
list allows all management levels.
allowedEncryptionStatuses: Allowed encryptions statuses, an empty list
allows all statuses.
osConstraints: Allowed OS versions, an empty list allows all types and all
versions.
requireAdminApproval: Whether the device needs to be approved by the
customer admin.
requireCorpOwned: Whether the device needs to be corp owned.
requireScreenlock: Whether or not screenlock is required for the
DevicePolicy to be true. Defaults to `false`.
"""
class AllowedDeviceManagementLevelsValueListEntryValuesEnum(_messages.Enum):
r"""AllowedDeviceManagementLevelsValueListEntryValuesEnum enum type.
Values:
MANAGEMENT_UNSPECIFIED: The device's management level is not specified
or not known.
NONE: The device is not managed.
BASIC: Basic management is enabled, which is generally limited to
monitoring and wiping the corporate account.
COMPLETE: Complete device management. This includes more thorough
monitoring and the ability to directly manage the device (such as
remote wiping). This can be enabled through the Android Enterprise
Platform.
"""
MANAGEMENT_UNSPECIFIED = 0
NONE = 1
BASIC = 2
COMPLETE = 3
class AllowedEncryptionStatusesValueListEntryValuesEnum(_messages.Enum):
r"""AllowedEncryptionStatusesValueListEntryValuesEnum enum type.
Values:
ENCRYPTION_UNSPECIFIED: The encryption status of the device is not
specified or not known.
ENCRYPTION_UNSUPPORTED: The device does not support encryption.
UNENCRYPTED: The device supports encryption, but is currently
unencrypted.
ENCRYPTED: The device is encrypted.
"""
ENCRYPTION_UNSPECIFIED = 0
ENCRYPTION_UNSUPPORTED = 1
UNENCRYPTED = 2
ENCRYPTED = 3
allowedDeviceManagementLevels = _messages.EnumField('AllowedDeviceManagementLevelsValueListEntryValuesEnum', 1, repeated=True)
allowedEncryptionStatuses = _messages.EnumField('AllowedEncryptionStatusesValueListEntryValuesEnum', 2, repeated=True)
osConstraints = _messages.MessageField('OsConstraint', 3, repeated=True)
requireAdminApproval = _messages.BooleanField(4)
requireCorpOwned = _messages.BooleanField(5)
requireScreenlock = _messages.BooleanField(6)
class Job(_messages.Message):
r"""Configuration for a job. The maximum allowed size for a job is 100KB.
Enums:
StateValueValuesEnum: Output only. State of the job. For example: enabled,
paused, or disabled.
Fields:
appEngineHttpTarget: App Engine Http target.
attemptDeadline: 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.
description: Optionally caller-specified in CreateJob or UpdateJob. A
human-readable description for the job. This string must not contain
more than 500 characters.
httpTarget: Http target.
lastAttemptTime: Output only. The time the last job attempt started.
legacyAppEngineCron: Immutable. This field is used to manage the legacy
App Engine Cron jobs using the Cloud Scheduler API. If the field is set
to true, the job will be considered to be a legacy job. Note that App
Engine Cron jobs have fewer features than Cloud Scheduler jobs, e.g.,
are only limited to App Engine targets.
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`. The maximum
allowed length for `JOB_ID` is 500 characters.
nextScheduleTime: 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.
pubsubTarget: Pub/Sub target.
retryConfig: Settings that determine the retry behavior.
schedule: Specifies a schedule of start times. This can be used to specify
complicated and time-zone-aware schedules. A scheduled start time will
be delayed if the previous execution has not ended when its scheduled
time occurs. If RetryConfig.retry_count > 0 and a job attempt fails, the
job will be a total of tried RetryConfig.retry_count times, with
exponential backoff, until the next scheduled start time.
state: Output only. State of the job. For example: enabled, paused, or
disabled.
status: Output only. The response from the target of the last attempted
execution.
userUpdateTime: Output only. The time of the last user update to the job,
or the creation time if there have been no updates.
"""
class StateValueValuesEnum(_messages.Enum):
r"""Output only. State of the job. For example: enabled, paused, or
disabled.
Values:
STATE_UNSPECIFIED: Unspecified state.
ENABLED: The job is executing normally.
PAUSED: The job is paused by the user. It will not execute. A user can
intentionally pause the job using PauseJobRequest.
DISABLED: The job is disabled by the system due to error. The user
cannot directly set a job to be disabled.
UPDATE_FAILED: The job state resulting from a failed
CloudScheduler.UpdateJob operation. To recover a job from this state,
retry CloudScheduler.UpdateJob until a successful response is
received.
"""
STATE_UNSPECIFIED = 0
ENABLED = 1
PAUSED = 2
DISABLED = 3
UPDATE_FAILED = 4
appEngineHttpTarget = _messages.MessageField('AppEngineHttpTarget', 1)
attemptDeadline = _messages.StringField(2)
description = _messages.StringField(3)
httpTarget = _messages.MessageField('HttpTarget', 4)
lastAttemptTime = _messages.StringField(5)
legacyAppEngineCron = _messages.BooleanField(6)
name = _messages.StringField(7)
nextScheduleTime = _messages.StringField(8)
pubsubTarget = _messages.MessageField('PubsubTarget', 9)
retryConfig = _messages.MessageField('RetryConfig', 10)
schedule = _messages.MessageField('Schedule', 11)
state = _messages.EnumField('StateValueValuesEnum', 12)
status = _messages.MessageField('Status', 13)
userUpdateTime = _messages.StringField(14)
class Operation(_messages.Message):
r"""This resource represents a long-running operation that is the result of
a network API call.
Messages:
MetadataValue: { `createTime`: The time the operation was created.
`endTime`: The time the operation finished running. `target`: Server-
defined resource path for the target of the operation. `verb`: Name of
the verb executed by the operation. `statusDetail`: Human-readable
status of the operation, if any. `cancelRequested`: Identifies whether
the user has requested cancellation of the operation. Operations that
have successfully been cancelled have Operation.error value with a
google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
`apiVersion`: API version used to start the operation. }
ResponseValue: The normal response of the operation in case of success. If
the original method returns no data on success, such as `Delete`, the
response is `google.protobuf.Empty`. If the original method is standard
`Get`/`Create`/`Update`, the response should be the resource. For other
methods, the response should have the type `XxxResponse`, where `Xxx` is
the original method name. For example, if the original method name is
`TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
Fields:
done: If the value is `false`, it means the operation is still in
progress. If `true`, the operation is completed, and either `error` or
`response` is available.
error: The error result of the operation in case of failure or
cancellation.
metadata: { `createTime`: The time the operation was created. `endTime`:
The time the operation finished running. `target`: Server-defined
resource path for the target of the operation. `verb`: Name of the verb
executed by the operation. `statusDetail`: Human-readable status of the
operation, if any. `cancelRequested`: Identifies whether the user has
requested cancellation of the operation. Operations that have
successfully been cancelled have Operation.error value with a
google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
`apiVersion`: API version used to start the operation. }
name: The server-assigned name, which is only unique within the same
service that originally returns it. If you use the default HTTP mapping,
the `name` should be a resource name ending with
`operations/{unique_id}`.
response: The normal response of the operation in case of success. If the
original method returns no data on success, such as `Delete`, the
response is `google.protobuf.Empty`. If the original method is standard
`Get`/`Create`/`Update`, the response should be the resource. For other
methods, the response should have the type `XxxResponse`, where `Xxx` is
the original method name. For example, if the original method name is
`TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"""
@encoding.MapUnrecognizedFields('additionalProperties')
class MetadataValue(_messages.Message):
r"""{ `createTime`: The time the operation was created. `endTime`: The
time the operation finished running. `target`: Server-defined resource
path for the target of the operation. `verb`: Name of the verb executed by
the operation. `statusDetail`: Human-readable status of the operation, if
any. `cancelRequested`: Identifies whether the user has requested
cancellation of the operation. Operations that have successfully been
cancelled have Operation.error value with a google.rpc.Status.code of 1,
corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start
the operation. }
Messages:
AdditionalProperty: An additional property for a MetadataValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a MetadataValue 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)
@encoding.MapUnrecognizedFields('additionalProperties')
class ResponseValue(_messages.Message):
r"""The normal response of the operation in case of success. If the
original method returns no data on success, such as `Delete`, the response
is `google.protobuf.Empty`. If the original method is standard
`Get`/`Create`/`Update`, the response should be the resource. For other
methods, the response should have the type `XxxResponse`, where `Xxx` is
the original method name. For example, if the original method name is
`TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
Messages:
AdditionalProperty: An additional property for a ResponseValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a ResponseValue 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)
done = _messages.BooleanField(1)
error = _messages.MessageField('Status', 2)
metadata = _messages.MessageField('MetadataValue', 3)
name = _messages.StringField(4)
response = _messages.MessageField('ResponseValue', 5)
class GoogleCloudMlV1alpha3JobMetadata(_messages.Message):
"""Represents the metadata of the longrunning.Operation created by the
SubmitTrainingJob or SubmitPredictionJob method.
Enums:
JobStateValueValuesEnum: The detailed state of a job.
Messages:
StatusMetricsSnapshotValue: Progress report. A set of key-value pairs that
convey the current state of the job.
Fields:
createTime: When the job was submitted.
createVersionRequest: The create version job request recorded. The create
version job request recorded.
endTime: When the job processing was completed.
isCancellationRequested: Whether the cancellation of this job has been
requested.
jobState: The detailed state of a job.
predictionRequest: The prediction job request recorded.
predictionResult: The current prediction job result.
startTime: When the job processing was started.
statusMetricsSnapshot: Progress report. A set of key-value pairs that
convey the current state of the job.
statusMetricsSnapshotTime: The time at which the 'status' field was
populated.
trainingRequest: The training job request recorded.
trainingResult: The current training job result.
"""
class JobStateValueValuesEnum(_messages.Enum):
"""The detailed state of a job.
Values:
UNKNOWN_JOB_STATE: <no description>
QUEUED: <no description>
PREPARING: <no description>
RUNNING: <no description>
SUCCEEDED: <no description>
FAILED: <no description>
CANCELLED: <no description>
"""
UNKNOWN_JOB_STATE = 0
QUEUED = 1
PREPARING = 2
RUNNING = 3
SUCCEEDED = 4
FAILED = 5
CANCELLED = 6
@encoding.MapUnrecognizedFields('additionalProperties')
class StatusMetricsSnapshotValue(_messages.Message):
"""Progress report. A set of key-value pairs that convey the current state
of the job.
Messages:
AdditionalProperty: An additional property for a
StatusMetricsSnapshotValue object.
Fields:
additionalProperties: Additional properties of type
StatusMetricsSnapshotValue
"""
class AdditionalProperty(_messages.Message):
"""An additional property for a StatusMetricsSnapshotValue 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)
createTime = _messages.StringField(1)
createVersionRequest = _messages.MessageField(
'GoogleCloudMlV1alpha3CreateVersionRequest', 2)
endTime = _messages.StringField(3)
isCancellationRequested = _messages.BooleanField(4)
jobState = _messages.EnumField('JobStateValueValuesEnum', 5)
predictionRequest = _messages.MessageField(
'GoogleCloudMlV1alpha3SubmitPredictionJobRequest', 6)
predictionResult = _messages.MessageField(
'GoogleCloudMlV1alpha3PredictionJobResult', 7)
startTime = _messages.StringField(8)
statusMetricsSnapshot = _messages.MessageField(
'StatusMetricsSnapshotValue', 9)
statusMetricsSnapshotTime = _messages.StringField(10)
trainingRequest = _messages.MessageField(
'GoogleCloudMlV1alpha3SubmitTrainingJobRequest', 11)
trainingResult = _messages.MessageField(
'GoogleCloudMlV1alpha3TrainingJobResult', 12)
class Node(_messages.Message):
r"""A TPU instance.
Enums:
ApiVersionValueValuesEnum: Output only. The API version that created this
Node.
HealthValueValuesEnum: The health status of the TPU node.
StateValueValuesEnum: Output only. The current state for the TPU Node.
Messages:
LabelsValue: Resource labels to represent user-provided metadata.
Fields:
acceleratorType: Required. The type of hardware accelerators associated
with this node.
apiVersion: Output only. The API version that created this Node.
cidrBlock: The CIDR block that the TPU node will use when selecting an IP
address. This CIDR block must be a /29 block; the Compute Engine
networks API forbids a smaller block, and using a larger block would be
wasteful (a node can only consume one IP address). Errors will occur if
the CIDR block has already been used for a currently existing TPU node,
the CIDR block conflicts with any subnetworks in the user's provided
network, or the provided network is peered with another network that is
using that CIDR block.
createTime: Output only. The time when the node was created.
description: The user-supplied description of the TPU. Maximum of 512
characters.
health: The health status of the TPU node.
healthDescription: Output only. If this field is populated, it contains a
description of why the TPU Node is unhealthy.
ipAddress: Output only. DEPRECATED! Use network_endpoints instead. The
network address for the TPU Node as visible to Compute Engine instances.
labels: Resource labels to represent user-provided metadata.
modelBasePath: Inference Mode: Base path to exported saved model. This
field can be used instead of model_config_file directly to specify the
exported saved model's base path (excluding timestamp), whereas
model_config_file points to a Cloud Storage path to a ModelServerConfig
proto.
modelConfigFile: Inference Mode: Cloud Storage path to model configuration
file for models to serve. The contents of the model_config.pbtxt is a
ModelServerConfig proto.
modelName: Inference Mode: Model name for tensorflow serving to serve to
incoming requests. If none is provided, "serving_default" will be used.
name: Output only. Immutable. The name of the TPU
network: The name of a network they wish to peer the TPU node to. It must
be a preexisting Compute Engine network inside of the project on which
this API has been activated. If none is provided, "default" will be
used.
networkEndpoints: Output only. The network endpoints where TPU workers can
be accessed and sent work. It is recommended that Tensorflow clients of
the node reach out to the 0th entry in this map first.
platformConfigFile: Inference Mode: Cloud Storage path to configuration
file for platform requirements The contents of the platform_config.pbtxt
is a PlatformConfigMap proto.
port: Output only. DEPRECATED! Use network_endpoints instead. The network
port for the TPU Node as visible to Compute Engine instances.
schedulingConfig: The scheduling options for this node.
serviceAccount: Output only. The service account used to run the tensor
flow services within the node. To share resources, including Google
Cloud Storage data, with the Tensorflow job running in the Node, this
account must have permissions to that data.
state: Output only. The current state for the TPU Node.
symptoms: Output only. The Symptoms that have occurred to the TPU Node.
tensorflowVersion: Required. The version of Tensorflow running in the
Node.
useServiceNetworking: Whether the VPC peering for the node is set up
through Service Networking API. The VPC Peering should be set up before
provisioning the node. If this field is set, cidr_block field should not
be specified. If the network, that you want to peer the TPU Node to, is
Shared VPC networks, the node must be created with this this field
enabled.
"""
class ApiVersionValueValuesEnum(_messages.Enum):
r"""Output only. The API version that created this Node.
Values:
API_VERSION_UNSPECIFIED: API version is unknown.
V1_ALPHA1: TPU API V1Alpha1 version.
V1: TPU API V1 version.
V2_ALPHA1: TPU API V2Alpha1 version.
"""
API_VERSION_UNSPECIFIED = 0
V1_ALPHA1 = 1
V1 = 2
V2_ALPHA1 = 3
class HealthValueValuesEnum(_messages.Enum):
r"""The health status of the TPU node.
Values:
HEALTH_UNSPECIFIED: Health status is unknown: not initialized or failed
to retrieve.
HEALTHY: The resource is healthy.
DEPRECATED_UNHEALTHY: The resource is unhealthy.
TIMEOUT: The resource is unresponsive.
UNHEALTHY_TENSORFLOW: The in-guest ML stack is unhealthy.
UNHEALTHY_MAINTENANCE: The node is under maintenance/priority boost
caused rescheduling and will resume running once rescheduled.
"""
HEALTH_UNSPECIFIED = 0
HEALTHY = 1
DEPRECATED_UNHEALTHY = 2
TIMEOUT = 3
UNHEALTHY_TENSORFLOW = 4
UNHEALTHY_MAINTENANCE = 5
class StateValueValuesEnum(_messages.Enum):
r"""Output only. The current state for the TPU Node.
Values:
STATE_UNSPECIFIED: TPU node state is not known/set.
CREATING: TPU node is being created.
READY: TPU node has been created.
RESTARTING: TPU node is restarting.
REIMAGING: TPU node is undergoing reimaging.
DELETING: TPU node is being deleted.
REPAIRING: TPU node is being repaired and may be unusable. Details can
be found in the `help_description` field.
STOPPED: TPU node is stopped.
STOPPING: TPU node is currently stopping.
STARTING: TPU node is currently starting.
PREEMPTED: TPU node has been preempted. Only applies to Preemptible TPU
Nodes.
TERMINATED: TPU node has been terminated due to maintenance or has
reached the end of its life cycle (for preemptible nodes).
HIDING: TPU node is currently hiding.
HIDDEN: TPU node has been hidden.
UNHIDING: TPU node is currently unhiding.
"""
STATE_UNSPECIFIED = 0
CREATING = 1
READY = 2
RESTARTING = 3
REIMAGING = 4
DELETING = 5
REPAIRING = 6
STOPPED = 7
STOPPING = 8
STARTING = 9
PREEMPTED = 10
TERMINATED = 11
HIDING = 12
HIDDEN = 13
UNHIDING = 14
@encoding.MapUnrecognizedFields('additionalProperties')
class LabelsValue(_messages.Message):
r"""Resource labels to represent user-provided metadata.
Messages:
AdditionalProperty: An additional property for a LabelsValue object.
Fields:
additionalProperties: Additional properties of type LabelsValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a LabelsValue 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)
acceleratorType = _messages.StringField(1)
apiVersion = _messages.EnumField('ApiVersionValueValuesEnum', 2)
cidrBlock = _messages.StringField(3)
createTime = _messages.StringField(4)
description = _messages.StringField(5)
health = _messages.EnumField('HealthValueValuesEnum', 6)
healthDescription = _messages.StringField(7)
ipAddress = _messages.StringField(8)
labels = _messages.MessageField('LabelsValue', 9)
modelBasePath = _messages.StringField(10)
modelConfigFile = _messages.StringField(11)
modelName = _messages.StringField(12)
name = _messages.StringField(13)
network = _messages.StringField(14)
networkEndpoints = _messages.MessageField('NetworkEndpoint',
15,
repeated=True)
platformConfigFile = _messages.StringField(16)
port = _messages.StringField(17)
schedulingConfig = _messages.MessageField('SchedulingConfig', 18)
serviceAccount = _messages.StringField(19)
state = _messages.EnumField('StateValueValuesEnum', 20)
symptoms = _messages.MessageField('Symptom', 21, repeated=True)
tensorflowVersion = _messages.StringField(22)
useServiceNetworking = _messages.BooleanField(23)
class Debuggee(_messages.Message):
r"""Represents the debugged application. The application may include one or
more replicated processes executing the same code. Each of these processes
is attached with a debugger agent, carrying out the debugging commands.
Agents attached to the same debuggee identify themselves as such by using
exactly the same Debuggee message value when registering.
Messages:
LabelsValue: A set of custom debuggee properties, populated by the agent,
to be displayed to the user.
Fields:
agentVersion: Version ID of the agent. Schema: `domain/language-
platform/vmajor.minor` (for example `google.com/java-gcp/v1.1`).
description: Human readable description of the debuggee. Including a
human-readable project name, environment name and version information is
recommended.
extSourceContexts: References to the locations and revisions of the source
code used in the deployed application.
id: Unique identifier for the debuggee generated by the controller
service.
isDisabled: If set to `true`, indicates that the agent should disable
itself and detach from the debuggee.
isInactive: If set to `true`, indicates that Controller service does not
detect any activity from the debuggee agents and the application is
possibly stopped.
labels: A set of custom debuggee properties, populated by the agent, to be
displayed to the user.
project: Project the debuggee is associated with. Use project number or id
when registering a Google Cloud Platform project.
sourceContexts: References to the locations and revisions of the source
code used in the deployed application.
status: Human readable message to be displayed to the user about this
debuggee. Absence of this field indicates no status. The message can be
either informational or an error status.
uniquifier: Uniquifier to further distiguish the application. It is
possible that different applications might have identical values in the
debuggee message, thus, incorrectly identified as a single application
by the Controller service. This field adds salt to further distiguish
the application. Agents should consider seeding this field with value
that identifies the code, binary, configuration and environment.
"""
@encoding.MapUnrecognizedFields('additionalProperties')
class LabelsValue(_messages.Message):
r"""A set of custom debuggee properties, populated by the agent, to be
displayed to the user.
Messages:
AdditionalProperty: An additional property for a LabelsValue object.
Fields:
additionalProperties: Additional properties of type LabelsValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a LabelsValue 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)
agentVersion = _messages.StringField(1)
description = _messages.StringField(2)
extSourceContexts = _messages.MessageField('ExtendedSourceContext',
3,
repeated=True)
id = _messages.StringField(4)
isDisabled = _messages.BooleanField(5)
isInactive = _messages.BooleanField(6)
labels = _messages.MessageField('LabelsValue', 7)
project = _messages.StringField(8)
sourceContexts = _messages.MessageField('SourceContext', 9, repeated=True)
status = _messages.MessageField('StatusMessage', 10)
uniquifier = _messages.StringField(11)
class CloudassetAnalyzeIamPolicyRequest(_messages.Message):
r"""A CloudassetAnalyzeIamPolicyRequest object.
Fields:
accessSelector_permissions: Optional. The permissions to appear in result.
accessSelector_roles: Optional. The roles to appear in result.
identitySelector_identity: Required. The identity appear in the form of
members in [IAM policy
binding](https://cloud.google.com/iam/reference/rest/v1/Binding).
options_expandGroups: Optional. If true, the identities section of the
result will expand any Google groups appearing in an IAM policy binding.
If identity_selector is specified, the identity in the result will be
determined by the selector, and this flag will have no effect. Default
is false.
options_expandResources: Optional. If true, the resource section of the
result will expand any resource attached to an IAM policy to include
resources lower in the resource hierarchy. For example, if the request
analyzes for which resources user A has permission P, and the results
include an IAM policy with P on a GCP folder, the results will also
include resources in that folder with permission P. If
resource_selector is specified, the resource section of the result will
be determined by the selector, and this flag will have no effect.
Default is false.
options_expandRoles: Optional. If true, the access section of result will
expand any roles appearing in IAM policy bindings to include their
permissions. If access_selector is specified, the access section of the
result will be determined by the selector, and this flag will have no
effect. Default is false.
options_maxFanoutsPerGroup: Optional. The maximum number of fanouts per
group when expand_groups is enabled.
options_maxFanoutsPerResource: Optional. The maximum number of fanouts per
parent resource, such as GCP Project etc., when expand_resources is
enabled.
options_outputGroupEdges: Optional. If true, the result will output group
identity edges, starting from the binding's group members, to any
expanded identities. Default is false.
options_outputPartialResultBeforeTimeout: Optional. If true, you will get
a response with partial result instead of a DEADLINE_EXCEEDED error when
your request processing takes longer than the deadline.
options_outputResourceEdges: Optional. If true, the result will output
resource edges, starting from the policy attached resource, to any
expanded resources. Default is false.
parent: Required. The relative name of root asset to do analysis . This
can only be an organization number (such as "organizations/123") for
now.
resourceSelector_fullResourceName: Required. The [full resource name](http
s://cloud.google.com/apis/design/resource_names#full_resource_name) .
"""
accessSelector_permissions = _messages.StringField(1, repeated=True)
accessSelector_roles = _messages.StringField(2, repeated=True)
identitySelector_identity = _messages.StringField(3)
options_expandGroups = _messages.BooleanField(4)
options_expandResources = _messages.BooleanField(5)
options_expandRoles = _messages.BooleanField(6)
options_maxFanoutsPerGroup = _messages.IntegerField(
7, variant=_messages.Variant.INT32)
options_maxFanoutsPerResource = _messages.IntegerField(
8, variant=_messages.Variant.INT32)
options_outputGroupEdges = _messages.BooleanField(9)
options_outputPartialResultBeforeTimeout = _messages.BooleanField(10)
options_outputResourceEdges = _messages.BooleanField(11)
parent = _messages.StringField(12, required=True)
resourceSelector_fullResourceName = _messages.StringField(13)
class Subscription(_messages.Message):
r"""A subscription resource.
Messages:
LabelsValue: User labels.
Fields:
ackDeadlineSeconds: This value is the maximum time after a subscriber
receives a message before the subscriber should acknowledge the message.
After message delivery but before the ack deadline expires and before
the message is acknowledged, it is an outstanding message and will not
be delivered again during that time (on a best-effort basis). For pull
subscriptions, this value is used as the initial value for the ack
deadline. To override this value for a given message, call
`ModifyAckDeadline` with the corresponding `ack_id` if using non-
streaming pull or send the `ack_id` in a
`StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum
custom deadline you can specify is 10 seconds. The maximum custom
deadline you can specify is 600 seconds (10 minutes). If this parameter
is 0, a default value of 10 seconds is used. For push delivery, this
value is also used to set the request timeout for the call to the push
endpoint. If the subscriber never acknowledges the message, the Pub/Sub
system will eventually redeliver the message.
labels: User labels.
messageRetentionDuration: How long to retain unacknowledged messages in
the subscription's backlog, from the moment a message is published. If
`retain_acked_messages` is true, then this also configures the retention
of acknowledged messages, and thus configures how far back in time a
`Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or
less than 10 minutes.<br><br> <b>ALPHA:</b> This feature is part of an
alpha release. This API might be changed in backward-incompatible ways
and is not recommended for production use. It is not subject to any SLA
or deprecation policy.
name: The name of the subscription. It must have the format
`"projects/{project}/subscriptions/{subscription}"`. `{subscription}`
must start with a letter, and contain only letters (`[A-Za-z]`), numbers
(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
plus (`+`) or percent signs (`%`). It must be between 3 and 255
characters in length, and it must not start with `"goog"`.
pushConfig: If push delivery is used with this subscription, this field is
used to configure it. An empty `pushConfig` signifies that the
subscriber will pull and ack messages using API methods.
retainAckedMessages: Indicates whether to retain acknowledged messages. If
true, then messages are not expunged from the subscription's backlog,
even if they are acknowledged, until they fall out of the
`message_retention_duration` window.<br><br> <b>ALPHA:</b> This feature
is part of an alpha release. This API might be changed in backward-
incompatible ways and is not recommended for production use. It is not
subject to any SLA or deprecation policy.
topic: The name of the topic from which this subscription is receiving
messages. Format is `projects/{project}/topics/{topic}`. The value of
this field will be `_deleted-topic_` if the topic has been deleted.
"""
@encoding.MapUnrecognizedFields('additionalProperties')
class LabelsValue(_messages.Message):
r"""User labels.
Messages:
AdditionalProperty: An additional property for a LabelsValue object.
Fields:
additionalProperties: Additional properties of type LabelsValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a LabelsValue 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)
ackDeadlineSeconds = _messages.IntegerField(
1, variant=_messages.Variant.INT32)
labels = _messages.MessageField('LabelsValue', 2)
messageRetentionDuration = _messages.StringField(3)
name = _messages.StringField(4)
pushConfig = _messages.MessageField('PushConfig', 5)
retainAckedMessages = _messages.BooleanField(6)
topic = _messages.StringField(7)
class GoogleCloudRecaptchaenterpriseV1WebKeySettings(_messages.Message):
r"""Settings specific to keys that can be used by websites.
Enums:
ChallengeSecurityPreferenceValueValuesEnum: Settings for the frequency and
difficulty at which this key triggers captcha challenges. This should
only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
IntegrationTypeValueValuesEnum: Required. Describes how this key is
integrated with the website.
Fields:
allowAllDomains: If set to true, it means allowed_domains will not be
enforced.
allowAmpTraffic: If set to true, the key can be used on AMP (Accelerated
Mobile Pages) websites. This is supported only for the SCORE integration
type.
allowedDomains: Domains or subdomains of websites allowed to use the key.
All subdomains of an allowed domain are automatically allowed. A valid
domain requires a host and must not include any path, port, query or
fragment. Examples: 'example.com' or 'subdomain.example.com'
challengeSecurityPreference: Settings for the frequency and difficulty at
which this key triggers captcha challenges. This should only be
specified for IntegrationTypes CHECKBOX and INVISIBLE.
integrationType: Required. Describes how this key is integrated with the
website.
"""
class ChallengeSecurityPreferenceValueValuesEnum(_messages.Enum):
r"""Settings for the frequency and difficulty at which this key triggers
captcha challenges. This should only be specified for IntegrationTypes
CHECKBOX and INVISIBLE.
Values:
CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED: Default type that indicates
this enum hasn't been specified.
USABILITY: Key tends to show fewer and easier challenges.
BALANCE: Key tends to show balanced (in amount and difficulty)
challenges.
SECURITY: Key tends to show more and harder challenges.
"""
CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0
USABILITY = 1
BALANCE = 2
SECURITY = 3
class IntegrationTypeValueValuesEnum(_messages.Enum):
r"""Required. Describes how this key is integrated with the website.
Values:
INTEGRATION_TYPE_UNSPECIFIED: Default type that indicates this enum
hasn't been specified. This is not a valid IntegrationType, one of the
other types must be specified instead.
SCORE: Only used to produce scores. It doesn't display the "I'm not a
robot" checkbox and never shows captcha challenges.
CHECKBOX: Displays the "I'm not a robot" checkbox and may show captcha
challenges after it is checked.
INVISIBLE: Doesn't display the "I'm not a robot" checkbox, but may show
captcha challenges after risk analysis.
"""
INTEGRATION_TYPE_UNSPECIFIED = 0
SCORE = 1
CHECKBOX = 2
INVISIBLE = 3
allowAllDomains = _messages.BooleanField(1)
allowAmpTraffic = _messages.BooleanField(2)
allowedDomains = _messages.StringField(3, repeated=True)
challengeSecurityPreference = _messages.EnumField('ChallengeSecurityPreferenceValueValuesEnum', 4)
integrationType = _messages.EnumField('IntegrationTypeValueValuesEnum', 5)
class PatchJob(_messages.Message):
r"""A high level representation of a patch job that is either in progress or
has completed. Instance details are not included in the job. To paginate
through instance details, use ListPatchJobInstanceDetails. For more
information about patch jobs, see [Creating patch
jobs](https://cloud.google.com/compute/docs/os-patch-management/create-
patch-job).
Enums:
StateValueValuesEnum: The current state of the PatchJob.
Fields:
createTime: Time this patch job was created.
description: Description of the patch job. Length of the description is
limited to 1024 characters.
displayName: Display name for this patch job. This is not a unique
identifier.
dryRun: If this patch job is a dry run, the agent reports that it has
finished without running any updates on the VM instance.
duration: Duration of the patch job. After the duration ends, the patch
job times out.
errorMessage: If this patch job failed, this message provides information
about the failure.
instanceDetailsSummary: Summary of instance details.
instanceFilter: Instances to patch.
name: Unique identifier for this patch job in the form
`projects/*/patchJobs/*`
patchConfig: Patch configuration being applied.
patchDeployment: Output only. Name of the patch deployment that created
this patch job.
percentComplete: Reflects the overall progress of the patch job in the
range of 0.0 being no progress to 100.0 being complete.
rollout: Rollout strategy being applied.
state: The current state of the PatchJob.
updateTime: Last time this patch job was updated.
"""
class StateValueValuesEnum(_messages.Enum):
r"""The current state of the PatchJob.
Values:
STATE_UNSPECIFIED: State must be specified.
STARTED: The patch job was successfully initiated.
INSTANCE_LOOKUP: The patch job is looking up instances to run the patch
on.
PATCHING: Instances are being patched.
SUCCEEDED: Patch job completed successfully.
COMPLETED_WITH_ERRORS: Patch job completed but there were errors.
CANCELED: The patch job was canceled.
TIMED_OUT: The patch job timed out.
"""
STATE_UNSPECIFIED = 0
STARTED = 1
INSTANCE_LOOKUP = 2
PATCHING = 3
SUCCEEDED = 4
COMPLETED_WITH_ERRORS = 5
CANCELED = 6
TIMED_OUT = 7
createTime = _messages.StringField(1)
description = _messages.StringField(2)
displayName = _messages.StringField(3)
dryRun = _messages.BooleanField(4)
duration = _messages.StringField(5)
errorMessage = _messages.StringField(6)
instanceDetailsSummary = _messages.MessageField(
'PatchJobInstanceDetailsSummary', 7)
instanceFilter = _messages.MessageField('PatchInstanceFilter', 8)
name = _messages.StringField(9)
patchConfig = _messages.MessageField('PatchConfig', 10)
patchDeployment = _messages.StringField(11)
percentComplete = _messages.FloatField(12)
rollout = _messages.MessageField('PatchRollout', 13)
state = _messages.EnumField('StateValueValuesEnum', 14)
updateTime = _messages.StringField(15)
class GoogleCloudBillingBudgetsV1NotificationsRule(_messages.Message):
r"""NotificationsRule defines notifications that are sent based on budget
spend and thresholds.
Fields:
disableDefaultIamRecipients: Optional. When set to true, disables default
notifications sent when a threshold is exceeded. Default notifications
are sent to those with Billing Account Administrator and Billing Account
User IAM roles for the target account.
monitoringNotificationChannels: Optional. Email targets to send
notifications to when a threshold is exceeded. This is in addition to
the `DefaultIamRecipients` who receive alert emails based on their
billing account IAM role. The value is the full REST resource name of a
Cloud Monitoring email notification channel with the form
`projects/{project_id}/notificationChannels/{channel_id}`. A maximum of
5 email notifications are allowed. To customize budget alert email
recipients with monitoring notification channels, you _must create the
monitoring notification channels before you link them to a budget_. For
guidance on setting up notification channels to use with budgets, see
[Customize budget alert email
recipients](https://cloud.google.com/billing/docs/how-to/budgets-
notification-recipients). For Cloud Billing budget alerts, you _must use
email notification channels_. The other types of notification channels
are _not_ supported, such as Slack, SMS, or PagerDuty. If you want to
[send budget notifications to
Slack](https://cloud.google.com/billing/docs/how-
to/notify#send_notifications_to_slack), use a pubsubTopic and configure
[programmatic notifications](https://cloud.google.com/billing/docs/how-
to/budgets-programmatic-notifications).
pubsubTopic: Optional. The name of the Pub/Sub topic where budget-related
messages are published, in the form
`projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic
at regular intervals; the timing of the updates is not dependent on the
[threshold rules](#thresholdrule) you've set. Note that if you want your
[Pub/Sub JSON object](https://cloud.google.com/billing/docs/how-
to/budgets-programmatic-notifications#notification_format) to contain
data for `alertThresholdExceeded`, you need at least one [alert
threshold rule](#thresholdrule). When you set threshold rules, you must
also enable at least one of the email notification options, either using
the default IAM recipients or Cloud Monitoring email notification
channels. To use Pub/Sub topics with budgets, you must do the following:
1. Create the Pub/Sub topic before connecting it to your budget. For
guidance, see [Manage programmatic budget alert
notifications](https://cloud.google.com/billing/docs/how-to/budgets-
programmatic-notifications). 2. Grant the API caller the
`pubsub.topics.setIamPolicy` permission on the Pub/Sub topic. If not
set, the API call fails with PERMISSION_DENIED. For additional details
on Pub/Sub roles and permissions, see [Permissions required for this
task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-
notifications#permissions_required_for_this_task).
schemaVersion: Optional. Required when NotificationsRule.pubsub_topic is
set. The schema version of the notification sent to
NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents
the JSON schema as defined in https://cloud.google.com/billing/docs/how-
to/budgets-programmatic-notifications#notification_format.
"""
disableDefaultIamRecipients = _messages.BooleanField(1)
monitoringNotificationChannels = _messages.StringField(2, repeated=True)
pubsubTopic = _messages.StringField(3)
schemaVersion = _messages.StringField(4)
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 ServicePerimeter(_messages.Message):
r"""`ServicePerimeter` describes a set of Google Cloud resources which can
freely import and export data amongst themselves, but not export outside of
the `ServicePerimeter`. If a request with a source within this
`ServicePerimeter` has a target outside of the `ServicePerimeter`, the
request will be blocked. Otherwise the request is allowed. There are two
types of Service Perimeter - Regular and Bridge. Regular Service Perimeters
cannot overlap, a single Google Cloud project can only belong to a single
regular Service Perimeter. Service Perimeter Bridges can contain only Google
Cloud projects as members, a single Google Cloud project may belong to
multiple Service Perimeter Bridges.
Enums:
PerimeterTypeValueValuesEnum: Perimeter type indicator. A single project
is allowed to be a member of single regular perimeter, but multiple
service perimeter bridges. A project cannot be a included in a perimeter
bridge without being included in regular perimeter. For perimeter
bridges, the restricted service list as well as access level lists must
be empty.
Fields:
createTime: Output only. Time the `ServicePerimeter` was created in UTC.
description: Description of the `ServicePerimeter` and its use. Does not
affect behavior.
name: Required. Resource name for the ServicePerimeter. The `short_name`
component must begin with a letter and only include alphanumeric and
'_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
perimeterType: Perimeter type indicator. A single project is allowed to be
a member of single regular perimeter, but multiple service perimeter
bridges. A project cannot be a included in a perimeter bridge without
being included in regular perimeter. For perimeter bridges, the
restricted service list as well as access level lists must be empty.
spec: Proposed (or dry run) ServicePerimeter configuration. This
configuration allows to specify and test ServicePerimeter configuration
without enforcing actual access restrictions. Only allowed to be set
when the "use_explicit_dry_run_spec" flag is set.
status: Current ServicePerimeter configuration. Specifies sets of
resources, restricted services and access levels that determine
perimeter content and boundaries.
title: Human readable title. Must be unique within the Policy.
updateTime: Output only. Time the `ServicePerimeter` was updated in UTC.
useExplicitDryRunSpec: Use explicit dry run spec flag. Ordinarily, a dry-
run spec implicitly exists for all Service Perimeters, and that spec is
identical to the status for those Service Perimeters. When this flag is
set, it inhibits the generation of the implicit spec, thereby allowing
the user to explicitly provide a configuration ("spec") to use in a dry-
run version of the Service Perimeter. This allows the user to test
changes to the enforced config ("status") without actually enforcing
them. This testing is done through analyzing the differences between
currently enforced and suggested restrictions. use_explicit_dry_run_spec
must bet set to True if any of the fields in the spec are set to non-
default values.
"""
class PerimeterTypeValueValuesEnum(_messages.Enum):
r"""Perimeter type indicator. A single project is allowed to be a member
of single regular perimeter, but multiple service perimeter bridges. A
project cannot be a included in a perimeter bridge without being included
in regular perimeter. For perimeter bridges, the restricted service list
as well as access level lists must be empty.
Values:
PERIMETER_TYPE_REGULAR: Regular Perimeter.
PERIMETER_TYPE_BRIDGE: Perimeter Bridge.
"""
PERIMETER_TYPE_REGULAR = 0
PERIMETER_TYPE_BRIDGE = 1
createTime = _messages.StringField(1)
description = _messages.StringField(2)
name = _messages.StringField(3)
perimeterType = _messages.EnumField('PerimeterTypeValueValuesEnum', 4)
spec = _messages.MessageField('ServicePerimeterConfig', 5)
status = _messages.MessageField('ServicePerimeterConfig', 6)
title = _messages.StringField(7)
updateTime = _messages.StringField(8)
useExplicitDryRunSpec = _messages.BooleanField(9)
class Instance(_messages.Message):
r"""A Google Cloud Redis instance.
Enums:
ConnectModeValueValuesEnum: Optional. The network connect mode of the
Redis instance. If not provided, the connect mode defaults to
DIRECT_PEERING.
StateValueValuesEnum: Output only. The current state of this instance.
TierValueValuesEnum: Required. The service tier of the instance.
TransitEncryptionModeValueValuesEnum: Optional. The In-transit encryption
mode of Redis instance. If not provided, in-transit encryption is
disabled for instance.
Messages:
LabelsValue: Resource labels to represent user provided metadata
RedisConfigsValue: Optional. Redis configuration parameters, according to
http://redis.io/topics/config. Currently, the only supported parameters
are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-
events Redis version 4.0 and newer: * activedefrag * lfu-decay-time *
lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-
node-max-bytes * stream-node-max-entries
Fields:
alternativeLocationId: Optional. Only applicable to STANDARD_HA tier which
protects the instance against zonal failures by provisioning it across
two zones. If provided, it must be a different zone from the one
provided in location_id.
authEnabled: Optional. Indicates whether OSS Redis AUTH is enabled for the
instance. If set to "true" AUTH is enabled on the instance. Default
value is "false" meaning AUTH is disabled.
authorizedNetwork: Optional. The full name of the Google Compute Engine
[network](https://cloud.google.com/vpc/docs/vpc) to which the instance
is connected. If left unspecified, the `default` network will be used.
connectMode: Optional. The network connect mode of the Redis instance. If
not provided, the connect mode defaults to DIRECT_PEERING.
createTime: Output only. The time the instance was created.
currentLocationId: Output only. The current zone where the Redis endpoint
is placed. For Basic Tier instances, this will always be the same as the
location_id provided by the user at creation time. For Standard Tier
instances, this can be either location_id or alternative_location_id and
can change after a failover event.
displayName: An arbitrary and optional user-provided name for the
instance.
host: Output only. Hostname or IP address of the exposed Redis endpoint
used by clients to connect to the service.
labels: Resource labels to represent user provided metadata
locationId: Optional. The zone where the instance will be provisioned. If
not provided, the service will choose a zone for the instance. For
STANDARD_HA tier, instances will be created across two zones for
protection against zonal failures. If alternative_location_id is also
provided, it must be different from location_id.
memorySizeGb: Required. Redis memory size in GiB.
name: Required. Unique name of the resource in this scope including
project and location using the form:
`projects/{project_id}/locations/{location_id}/instances/{instance_id}`
Note: Redis instances are managed and addressed at regional level so
location_id here refers to a GCP region; however, users may choose which
specific zone (or collection of zones for cross-zone instances) an
instance should be provisioned in. Refer to location_id and
alternative_location_id fields for more details.
persistenceIamIdentity: Output only. Cloud IAM identity used by import /
export operations to transfer data to/from Cloud Storage. Format is
"serviceAccount:". The value may change over time for a given instance
so should be checked before each import/export operation.
port: Output only. The port number of the exposed Redis endpoint.
redisConfigs: Optional. Redis configuration parameters, according to
http://redis.io/topics/config. Currently, the only supported parameters
are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-
events Redis version 4.0 and newer: * activedefrag * lfu-decay-time *
lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-
node-max-bytes * stream-node-max-entries
redisVersion: Optional. The version of Redis software. If not provided,
latest supported version will be used. Currently, the supported values
are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis
4.0 compatibility (default) * `REDIS_5_0` for Redis 5.0 compatibility
reservedIpRange: Optional. The CIDR range of internal addresses that are
reserved for this instance. If not provided, the service will choose an
unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges
must be unique and non-overlapping with existing subnets in an
authorized network.
serverCaCerts: Output only. List of server CA certificates for the
instance.
state: Output only. The current state of this instance.
statusMessage: Output only. Additional information about the current
status of this instance, if available.
tier: Required. The service tier of the instance.
transitEncryptionMode: Optional. The In-transit encryption mode of Redis
instance. If not provided, in-transit encryption is disabled for
instance.
"""
class ConnectModeValueValuesEnum(_messages.Enum):
r"""Optional. The network connect mode of the Redis instance. If not
provided, the connect mode defaults to DIRECT_PEERING.
Values:
CONNECT_MODE_UNSPECIFIED: Not set.
DIRECT_PEERING: Connect via direct peering to the Memorystore for Redis
hosted service.
PRIVATE_SERVICE_ACCESS: Connect your Memorystore for Redis instance
using Private Services Access. Private services access provides an IP
address range for multiple Google Cloud services, including
Memorystore.
"""
CONNECT_MODE_UNSPECIFIED = 0
DIRECT_PEERING = 1
PRIVATE_SERVICE_ACCESS = 2
class StateValueValuesEnum(_messages.Enum):
r"""Output only. The current state of this instance.
Values:
STATE_UNSPECIFIED: Not set.
CREATING: Redis instance is being created.
READY: Redis instance has been created and is fully usable.
UPDATING: Redis instance configuration is being updated. Certain kinds
of updates may cause the instance to become unusable while the update
is in progress.
DELETING: Redis instance is being deleted.
REPAIRING: Redis instance is being repaired and may be unusable.
MAINTENANCE: Maintenance is being performed on this Redis instance.
IMPORTING: Redis instance is importing data (availability may be
affected).
FAILING_OVER: Redis instance is failing over (availability may be
affected).
"""
STATE_UNSPECIFIED = 0
CREATING = 1
READY = 2
UPDATING = 3
DELETING = 4
REPAIRING = 5
MAINTENANCE = 6
IMPORTING = 7
FAILING_OVER = 8
class TierValueValuesEnum(_messages.Enum):
r"""Required. The service tier of the instance.
Values:
TIER_UNSPECIFIED: Not set.
BASIC: BASIC tier: standalone instance
STANDARD_HA: STANDARD_HA tier: highly available primary/replica
instances
"""
TIER_UNSPECIFIED = 0
BASIC = 1
STANDARD_HA = 2
class TransitEncryptionModeValueValuesEnum(_messages.Enum):
r"""Optional. The In-transit encryption mode of Redis instance. If not
provided, in-transit encryption is disabled for instance.
Values:
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED: Not set.
SERVER_AUTHENTICATION: Client to Server traffic encryption enabled with
server authentication.
DISABLED: In-transit encryption is disabled for instance.
"""
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED = 0
SERVER_AUTHENTICATION = 1
DISABLED = 2
@encoding.MapUnrecognizedFields('additionalProperties')
class LabelsValue(_messages.Message):
r"""Resource labels to represent user provided metadata
Messages:
AdditionalProperty: An additional property for a LabelsValue object.
Fields:
additionalProperties: Additional properties of type LabelsValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a LabelsValue 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)
@encoding.MapUnrecognizedFields('additionalProperties')
class RedisConfigsValue(_messages.Message):
r"""Optional. Redis configuration parameters, according to
http://redis.io/topics/config. Currently, the only supported parameters
are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-
events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-
log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-
bytes * stream-node-max-entries
Messages:
AdditionalProperty: An additional property for a RedisConfigsValue
object.
Fields:
additionalProperties: Additional properties of type RedisConfigsValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a RedisConfigsValue 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)
alternativeLocationId = _messages.StringField(1)
authEnabled = _messages.BooleanField(2)
authorizedNetwork = _messages.StringField(3)
connectMode = _messages.EnumField('ConnectModeValueValuesEnum', 4)
createTime = _messages.StringField(5)
currentLocationId = _messages.StringField(6)
displayName = _messages.StringField(7)
host = _messages.StringField(8)
labels = _messages.MessageField('LabelsValue', 9)
locationId = _messages.StringField(10)
memorySizeGb = _messages.IntegerField(11, variant=_messages.Variant.INT32)
name = _messages.StringField(12)
persistenceIamIdentity = _messages.StringField(13)
port = _messages.IntegerField(14, variant=_messages.Variant.INT32)
redisConfigs = _messages.MessageField('RedisConfigsValue', 15)
redisVersion = _messages.StringField(16)
reservedIpRange = _messages.StringField(17)
serverCaCerts = _messages.MessageField('TlsCertificate', 18, repeated=True)
state = _messages.EnumField('StateValueValuesEnum', 19)
statusMessage = _messages.StringField(20)
tier = _messages.EnumField('TierValueValuesEnum', 21)
transitEncryptionMode = _messages.EnumField(
'TransitEncryptionModeValueValuesEnum', 22)
class DevicePolicy(_messages.Message):
r"""`DevicePolicy` specifies device specific restrictions necessary to
acquire a given access level. A `DevicePolicy` specifies requirements for
requests from devices to be granted access levels, it does not do any
enforcement on the device. `DevicePolicy` acts as an AND over all specified
fields, and each repeated field is an OR over its elements. Any unset fields
are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS,
os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the
DevicePolicy will be true for requests originating from encrypted Linux
desktops and encrypted Windows desktops.
Enums:
AllowedDeviceManagementLevelsValueListEntryValuesEnum:
AllowedEncryptionStatusesValueListEntryValuesEnum:
Fields:
allowedDeviceManagementLevels: Allowed device management levels, an empty
list allows all management levels.
allowedEncryptionStatuses: Allowed encryptions statuses, an empty list
allows all statuses.
osConstraints: Allowed OS versions, an empty list allows all types and all
versions.
requireAdminApproval: Whether the device needs to be approved by the
customer admin.
requireCorpOwned: Whether the device needs to be corp owned.
requireScreenlock: Whether or not screenlock is required for the
DevicePolicy to be true. Defaults to `false`.
"""
class AllowedDeviceManagementLevelsValueListEntryValuesEnum(_messages.Enum):
r"""AllowedDeviceManagementLevelsValueListEntryValuesEnum enum type.
Values:
MANAGEMENT_UNSPECIFIED: <no description>
NONE: <no description>
BASIC: <no description>
COMPLETE: <no description>
"""
MANAGEMENT_UNSPECIFIED = 0
NONE = 1
BASIC = 2
COMPLETE = 3
class AllowedEncryptionStatusesValueListEntryValuesEnum(_messages.Enum):
r"""AllowedEncryptionStatusesValueListEntryValuesEnum enum type.
Values:
ENCRYPTION_UNSPECIFIED: <no description>
ENCRYPTION_UNSUPPORTED: <no description>
UNENCRYPTED: <no description>
ENCRYPTED: <no description>
"""
ENCRYPTION_UNSPECIFIED = 0
ENCRYPTION_UNSUPPORTED = 1
UNENCRYPTED = 2
ENCRYPTED = 3
allowedDeviceManagementLevels = _messages.EnumField('AllowedDeviceManagementLevelsValueListEntryValuesEnum', 1, repeated=True)
allowedEncryptionStatuses = _messages.EnumField('AllowedEncryptionStatusesValueListEntryValuesEnum', 2, repeated=True)
osConstraints = _messages.MessageField('OsConstraint', 3, repeated=True)
requireAdminApproval = _messages.BooleanField(4)
requireCorpOwned = _messages.BooleanField(5)
requireScreenlock = _messages.BooleanField(6)
class RecognitionConfig(_messages.Message):
r"""Provides information to the recognizer that specifies how to process the
request.
Enums:
EncodingValueValuesEnum: Encoding of audio data sent in all
`RecognitionAudio` messages. This field is optional for `FLAC` and `WAV`
audio files and required for all other audio formats. For details, see
AudioEncoding.
Fields:
alternativeLanguageCodes: *Optional* A list of up to 3 additional
[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags,
listing possible alternative languages of the supplied audio. See
[Language Support](https://cloud.google.com/speech/docs/languages) for a
list of the currently supported language codes. If alternative languages
are listed, recognition result will contain recognition in the most
likely language detected including the main language_code. The
recognition result will include the language tag of the language
detected in the audio. NOTE: This feature is only supported for Voice
Command and Voice Search use cases and performance may vary for other
use cases (e.g., phone call transcription).
diarizationSpeakerCount: *Optional* If set, specifies the estimated number
of speakers in the conversation. If not set, defaults to '2'. Ignored
unless enable_speaker_diarization is set to true."
enableAutomaticPunctuation: *Optional* If 'true', adds punctuation to
recognition result hypotheses. This feature is only available in select
languages. Setting this for requests in other languages has no effect at
all. The default 'false' value does not add punctuation to result
hypotheses. NOTE: "This is currently offered as an experimental service,
complimentary to all users. In the future this may be exclusively
available as a premium feature."
enableSpeakerDiarization: *Optional* If 'true', enables speaker detection
for each recognized word in the top alternative of the recognition
result using a speaker_tag provided in the WordInfo. Note: When this is
true, we send all the words from the beginning of the audio for the top
alternative in every consecutive responses. This is done in order to
improve our speaker tags as our models learn to identify the speakers in
the conversation over time.
enableWordConfidence: *Optional* If `true`, the top result includes a list
of words and the confidence for those words. If `false`, no word-level
confidence information is returned. The default is `false`.
enableWordTimeOffsets: *Optional* If `true`, the top result includes a
list of words and the start and end time offsets (timestamps) for those
words. If `false`, no word-level time offset information is returned.
The default is `false`.
encoding: Encoding of audio data sent in all `RecognitionAudio` messages.
This field is optional for `FLAC` and `WAV` audio files and required for
all other audio formats. For details, see AudioEncoding.
languageCode: *Required* The language of the supplied audio as a
[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
Example: "en-US". See [Language
Support](https://cloud.google.com/speech/docs/languages) for a list of
the currently supported language codes.
maxAlternatives: *Optional* Maximum number of recognition hypotheses to be
returned. Specifically, the maximum number of
`SpeechRecognitionAlternative` messages within each
`SpeechRecognitionResult`. The server may return fewer than
`max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1`
will return a maximum of one. If omitted, will return a maximum of one.
metadata: *Optional* Metadata regarding this request.
model: *Optional* Which model to select for the given request. Select the
model best suited to your domain to get best results. If a model is not
explicitly specified, then we auto-select a model based on the
parameters in the RecognitionConfig. <table> <tr>
<td><b>Model</b></td> <td><b>Description</b></td> </tr> <tr>
<td><code>command_and_search</code></td> <td>Best for short queries
such as voice commands or voice search.</td> </tr> <tr>
<td><code>phone_call</code></td> <td>Best for audio that originated
from a phone call (typically recorded at an 8khz sampling
rate).</td> </tr> <tr> <td><code>video</code></td> <td>Best
for audio that originated from from video or includes multiple
speakers. Ideally the audio is recorded at a 16khz or greater
sampling rate. This is a premium model that costs more than the
standard rate.</td> </tr> <tr> <td><code>default</code></td>
<td>Best for audio that is not one of the specific audio models.
For example, long-form audio. Ideally the audio is high-fidelity,
recorded at a 16khz or greater sampling rate.</td> </tr> </table>
profanityFilter: *Optional* If set to `true`, the server will attempt to
filter out profanities, replacing all but the initial character in each
filtered word with asterisks, e.g. "f***". If set to `false` or omitted,
profanities won't be filtered out.
sampleRateHertz: Sample rate in Hertz of the audio data sent in all
`RecognitionAudio` messages. Valid values are: 8000-48000. 16000 is
optimal. For best results, set the sampling rate of the audio source to
16000 Hz. If that's not possible, use the native sample rate of the
audio source (instead of re-sampling). This field is optional for `FLAC`
and `WAV` audio files and required for all other audio formats. For
details, see AudioEncoding.
speechContexts: *Optional* A means to provide context to assist the speech
recognition.
useEnhanced: *Optional* Set to true to use an enhanced model for speech
recognition. You must also set the `model` field to a valid, enhanced
model. If `use_enhanced` is set to true and the `model` field is not
set, then `use_enhanced` is ignored. If `use_enhanced` is true and an
enhanced version of the specified model does not exist, then the speech
is recognized using the standard version of the specified model.
Enhanced speech models require that you opt-in to the audio logging
using instructions in the [alpha documentation](/speech/data-sharing).
If you set `use_enhanced` to true and you have not enabled audio
logging, then you will receive an error.
"""
class EncodingValueValuesEnum(_messages.Enum):
r"""Encoding of audio data sent in all `RecognitionAudio` messages. This
field is optional for `FLAC` and `WAV` audio files and required for all
other audio formats. For details, see AudioEncoding.
Values:
ENCODING_UNSPECIFIED: Not specified.
LINEAR16: Uncompressed 16-bit signed little-endian samples (Linear PCM).
FLAC: `FLAC` (Free Lossless Audio Codec) is the recommended encoding
because it is lossless--therefore recognition is not compromised--and
requires only about half the bandwidth of `LINEAR16`. `FLAC` stream
encoding supports 16-bit and 24-bit samples, however, not all fields
in `STREAMINFO` are supported.
MULAW: 8-bit samples that compand 14-bit audio samples using G.711 PCMU
/mu-law.
AMR: Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be
8000.
AMR_WB: Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be
16000.
OGG_OPUS: Opus encoded audio frames in Ogg container
([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must
be one of 8000, 12000, 16000, 24000, or 48000.
SPEEX_WITH_HEADER_BYTE: Although the use of lossy encodings is not
recommended, if a very low bitrate encoding is required, `OGG_OPUS` is
highly preferred over Speex encoding. The [Speex](https://speex.org/)
encoding supported by Cloud Speech API has a header byte in each
block, as in MIME type `audio/x-speex-with-header-byte`. It is a
variant of the RTP Speex encoding defined in [RFC
5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence
of blocks, one block per RTP packet. Each block starts with a byte
containing the length of the block, in bytes, followed by one or more
frames of Speex data, padded to an integral number of bytes (octets)
as specified in RFC 5574. In other words, each RTP header is replaced
with a single byte containing the block length. Only Speex wideband is
supported. `sample_rate_hertz` must be 16000.
"""
ENCODING_UNSPECIFIED = 0
LINEAR16 = 1
FLAC = 2
MULAW = 3
AMR = 4
AMR_WB = 5
OGG_OPUS = 6
SPEEX_WITH_HEADER_BYTE = 7
alternativeLanguageCodes = _messages.StringField(1, repeated=True)
diarizationSpeakerCount = _messages.IntegerField(2, variant=_messages.Variant.INT32)
enableAutomaticPunctuation = _messages.BooleanField(3)
enableSpeakerDiarization = _messages.BooleanField(4)
enableWordConfidence = _messages.BooleanField(5)
enableWordTimeOffsets = _messages.BooleanField(6)
encoding = _messages.EnumField('EncodingValueValuesEnum', 7)
languageCode = _messages.StringField(8)
maxAlternatives = _messages.IntegerField(9, variant=_messages.Variant.INT32)
metadata = _messages.MessageField('RecognitionMetadata', 10)
model = _messages.StringField(11)
profanityFilter = _messages.BooleanField(12)
sampleRateHertz = _messages.IntegerField(13, variant=_messages.Variant.INT32)
speechContexts = _messages.MessageField('SpeechContext', 14, repeated=True)
useEnhanced = _messages.BooleanField(15)
class RecognitionConfig(_messages.Message):
"""Provides information to the recognizer that specifies how to process the
request.
Enums:
EncodingValueValuesEnum: *Required* Encoding of audio data sent in all
`RecognitionAudio` messages.
Fields:
encoding: *Required* Encoding of audio data sent in all `RecognitionAudio`
messages.
languageCode: *Required* The language of the supplied audio as a
[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
Example: "en-US". See [Language
Support](https://cloud.google.com/speech/docs/languages) for a list of
the currently supported language codes.
maxAlternatives: *Optional* Maximum number of recognition hypotheses to be
returned. Specifically, the maximum number of
`SpeechRecognitionAlternative` messages within each
`SpeechRecognitionResult`. The server may return fewer than
`max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1`
will return a maximum of one. If omitted, will return a maximum of one.
profanityFilter: *Optional* If set to `true`, the server will attempt to
filter out profanities, replacing all but the initial character in each
filtered word with asterisks, e.g. "f***". If set to `false` or omitted,
profanities won't be filtered out.
sampleRateHertz: *Required* Sample rate in Hertz of the audio data sent in
all `RecognitionAudio` messages. Valid values are: 8000-48000. 16000 is
optimal. For best results, set the sampling rate of the audio source to
16000 Hz. If that's not possible, use the native sample rate of the
audio source (instead of re-sampling).
speechContexts: *Optional* A means to provide context to assist the speech
recognition.
"""
class EncodingValueValuesEnum(_messages.Enum):
"""*Required* Encoding of audio data sent in all `RecognitionAudio`
messages.
Values:
ENCODING_UNSPECIFIED: Not specified. Will return result
google.rpc.Code.INVALID_ARGUMENT.
LINEAR16: Uncompressed 16-bit signed little-endian samples (Linear PCM).
FLAC: [`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless
Audio Codec) is the recommended encoding because it is lossless--
therefore recognition is not compromised--and requires only about half
the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit
and 24-bit samples, however, not all fields in `STREAMINFO` are
supported.
MULAW: 8-bit samples that compand 14-bit audio samples using G.711 PCMU
/mu-law.
AMR: Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be
8000.
AMR_WB: Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be
16000.
OGG_OPUS: Opus encoded audio frames in Ogg container
([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must
be 16000.
SPEEX_WITH_HEADER_BYTE: Although the use of lossy encodings is not
recommended, if a very low bitrate encoding is required, `OGG_OPUS` is
highly preferred over Speex encoding. The [Speex](https://speex.org/)
encoding supported by Cloud Speech API has a header byte in each
block, as in MIME type `audio/x-speex-with-header-byte`. It is a
variant of the RTP Speex encoding defined in [RFC
5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence
of blocks, one block per RTP packet. Each block starts with a byte
containing the length of the block, in bytes, followed by one or more
frames of Speex data, padded to an integral number of bytes (octets)
as specified in RFC 5574. In other words, each RTP header is replaced
with a single byte containing the block length. Only Speex wideband is
supported. `sample_rate_hertz` must be 16000.
"""
ENCODING_UNSPECIFIED = 0
LINEAR16 = 1
FLAC = 2
MULAW = 3
AMR = 4
AMR_WB = 5
OGG_OPUS = 6
SPEEX_WITH_HEADER_BYTE = 7
encoding = _messages.EnumField('EncodingValueValuesEnum', 1)
languageCode = _messages.StringField(2)
maxAlternatives = _messages.IntegerField(3,
variant=_messages.Variant.INT32)
profanityFilter = _messages.BooleanField(4)
sampleRateHertz = _messages.IntegerField(5,
variant=_messages.Variant.INT32)
speechContexts = _messages.MessageField('SpeechContext', 6, repeated=True)
class Device(_messages.Message):
"""The device resource.
Messages:
MetadataValue: The metadata key-value pairs assigned to the device. This
metadata is not interpreted or indexed by Cloud IoT Core. It can be used
to add contextual information for the device. Keys must conform to the
regular expression a-zA-Z+ and be less than 128 bytes in length. Values
are free-form strings. Each value must be less than or equal to 32 KB in
size. The total size of all keys and values must be less than 256 KB,
and the maximum number of key-value pairs is 500.
Fields:
blocked: If a device is blocked, connections or requests from this device
will fail. Can be used to temporarily prevent the device from connecting
if, for example, the sensor is generating bad data and needs
maintenance.
config: The most recent device configuration, which is eventually sent
from Cloud IoT Core to the device. If not present on creation, the
configuration will be initialized with an empty payload and version
value of `1`. To update this field after creation, use the
`DeviceManager.ModifyCloudToDeviceConfig` method.
credentials: The credentials used to authenticate this device. To allow
credential rotation without interruption, multiple device credentials
can be bound to this device. No more than 3 credentials can be bound to
a single device at a time. When new credentials are added to a device,
they are verified against the registry credentials. For details, see the
description of the `DeviceRegistry.credentials` field.
id: The user-defined device identifier. The device ID must be unique
within a device registry.
lastConfigAckTime: [Output only] The last time a cloud-to-device config
version acknowledgment was received from the device. This field is only
for configurations sent through MQTT.
lastConfigSendTime: [Output only] The last time a cloud-to-device config
version was sent to the device.
lastErrorStatus: [Output only] The error message of the most recent error,
such as a failure to publish to Cloud Pub/Sub. 'last_error_time' is the
timestamp of this field. If no errors have occurred, this field has an
empty message and the status code 0 == OK. Otherwise, this field is
expected to have a status code other than OK.
lastErrorTime: [Output only] The time the most recent error occurred, such
as a failure to publish to Cloud Pub/Sub. This field is the timestamp of
'last_error_status'.
lastEventTime: [Output only] The last time a telemetry event was received.
Timestamps are periodically collected and written to storage; they may
be stale by a few minutes.
lastHeartbeatTime: [Output only] The last time an MQTT `PINGREQ` was
received. This field applies only to devices connecting through MQTT.
MQTT clients usually only send `PINGREQ` messages if the connection is
idle, and no other messages have been sent. Timestamps are periodically
collected and written to storage; they may be stale by a few minutes.
lastStateTime: [Output only] The last time a state event was received.
Timestamps are periodically collected and written to storage; they may
be stale by a few minutes.
metadata: The metadata key-value pairs assigned to the device. This
metadata is not interpreted or indexed by Cloud IoT Core. It can be used
to add contextual information for the device. Keys must conform to the
regular expression a-zA-Z+ and be less than 128 bytes in length. Values
are free-form strings. Each value must be less than or equal to 32 KB in
size. The total size of all keys and values must be less than 256 KB,
and the maximum number of key-value pairs is 500.
name: The resource path name. For example, `projects/p1/locations/us-
central1/registries/registry0/devices/dev0` or `projects/p1/locations
/us-central1/registries/registry0/devices/{num_id}`. When `name` is
populated as a response from the service, it always ends in the device
numeric ID.
numId: [Output only] A server-defined unique numeric ID for the device.
This is a more compact way to identify devices, and it is globally
unique.
state: [Output only] The state most recently received from the device. If
no state has been reported, this field is not present.
"""
@encoding.MapUnrecognizedFields('additionalProperties')
class MetadataValue(_messages.Message):
"""The metadata key-value pairs assigned to the device. This metadata is
not interpreted or indexed by Cloud IoT Core. It can be used to add
contextual information for the device. Keys must conform to the regular
expression a-zA-Z+ and be less than 128 bytes in length. Values are free-
form strings. Each value must be less than or equal to 32 KB in size. The
total size of all keys and values must be less than 256 KB, and the
maximum number of key-value pairs is 500.
Messages:
AdditionalProperty: An additional property for a MetadataValue object.
Fields:
additionalProperties: Additional properties of type MetadataValue
"""
class AdditionalProperty(_messages.Message):
"""An additional property for a MetadataValue 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)
blocked = _messages.BooleanField(1)
config = _messages.MessageField('DeviceConfig', 2)
credentials = _messages.MessageField('DeviceCredential', 3, repeated=True)
id = _messages.StringField(4)
lastConfigAckTime = _messages.StringField(5)
lastConfigSendTime = _messages.StringField(6)
lastErrorStatus = _messages.MessageField('Status', 7)
lastErrorTime = _messages.StringField(8)
lastEventTime = _messages.StringField(9)
lastHeartbeatTime = _messages.StringField(10)
lastStateTime = _messages.StringField(11)
metadata = _messages.MessageField('MetadataValue', 12)
name = _messages.StringField(13)
numId = _messages.IntegerField(14, variant=_messages.Variant.UINT64)
state = _messages.MessageField('DeviceState', 15)
class ScanConfig(_messages.Message):
r"""A ScanConfig resource contains the configurations to launch a scan.
Enums:
ExportToSecurityCommandCenterValueValuesEnum: Controls export of scan
configurations and results to Security Command Center.
RiskLevelValueValuesEnum: The risk level selected for the scan
TargetPlatformsValueListEntryValuesEnum:
UserAgentValueValuesEnum: The user agent used during scanning.
Fields:
authentication: The authentication configuration. If specified, service
will use the authentication configuration during scanning.
blacklistPatterns: The excluded URL patterns as described in
https://cloud.google.com/security-command-center/docs/how-to-use-web-
security-scanner#excluding_urls
displayName: Required. The user provided display name of the ScanConfig.
exportToSecurityCommandCenter: Controls export of scan configurations and
results to Security Command Center.
latestRun: Latest ScanRun if available.
managedScan: Whether the scan config is managed by Web Security Scanner,
output only.
maxQps: The maximum QPS during scanning. A valid value ranges from 5 to 20
inclusively. If the field is unspecified or its value is set 0, server
will default to 15. Other values outside of [5, 20] range will be
rejected with INVALID_ARGUMENT error.
name: The resource name of the ScanConfig. The name follows the format of
'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs
are generated by the system.
riskLevel: The risk level selected for the scan
schedule: The schedule of the ScanConfig.
startingUrls: Required. The starting URLs from which the scanner finds
site pages.
staticIpScan: Whether the scan configuration has enabled static IP address
scan feature. If enabled, the scanner will access applications from
static IP addresses.
targetPlatforms: Set of Google Cloud platforms targeted by the scan. If
empty, APP_ENGINE will be used as a default.
userAgent: The user agent used during scanning.
"""
class ExportToSecurityCommandCenterValueValuesEnum(_messages.Enum):
r"""Controls export of scan configurations and results to Security Command
Center.
Values:
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED: Use default, which is
ENABLED.
ENABLED: Export results of this scan to Security Command Center.
DISABLED: Do not export results of this scan to Security Command Center.
"""
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED = 0
ENABLED = 1
DISABLED = 2
class RiskLevelValueValuesEnum(_messages.Enum):
r"""The risk level selected for the scan
Values:
RISK_LEVEL_UNSPECIFIED: Use default, which is NORMAL.
NORMAL: Normal scanning (Recommended)
LOW: Lower impact scanning
"""
RISK_LEVEL_UNSPECIFIED = 0
NORMAL = 1
LOW = 2
class TargetPlatformsValueListEntryValuesEnum(_messages.Enum):
r"""TargetPlatformsValueListEntryValuesEnum enum type.
Values:
TARGET_PLATFORM_UNSPECIFIED: The target platform is unknown. Requests
with this enum value will be rejected with INVALID_ARGUMENT error.
APP_ENGINE: Google App Engine service.
COMPUTE: Google Compute Engine service.
"""
TARGET_PLATFORM_UNSPECIFIED = 0
APP_ENGINE = 1
COMPUTE = 2
class UserAgentValueValuesEnum(_messages.Enum):
r"""The user agent used during scanning.
Values:
USER_AGENT_UNSPECIFIED: The user agent is unknown. Service will default
to CHROME_LINUX.
CHROME_LINUX: Chrome on Linux. This is the service default if
unspecified.
CHROME_ANDROID: Chrome on Android.
SAFARI_IPHONE: Safari on IPhone.
"""
USER_AGENT_UNSPECIFIED = 0
CHROME_LINUX = 1
CHROME_ANDROID = 2
SAFARI_IPHONE = 3
authentication = _messages.MessageField('Authentication', 1)
blacklistPatterns = _messages.StringField(2, repeated=True)
displayName = _messages.StringField(3)
exportToSecurityCommandCenter = _messages.EnumField('ExportToSecurityCommandCenterValueValuesEnum', 4)
latestRun = _messages.MessageField('ScanRun', 5)
managedScan = _messages.BooleanField(6)
maxQps = _messages.IntegerField(7, variant=_messages.Variant.INT32)
name = _messages.StringField(8)
riskLevel = _messages.EnumField('RiskLevelValueValuesEnum', 9)
schedule = _messages.MessageField('Schedule', 10)
startingUrls = _messages.StringField(11, repeated=True)
staticIpScan = _messages.BooleanField(12)
targetPlatforms = _messages.EnumField('TargetPlatformsValueListEntryValuesEnum', 13, repeated=True)
userAgent = _messages.EnumField('UserAgentValueValuesEnum', 14)
class ServicePerimeter(_messages.Message):
r"""`ServicePerimeter` describes a set of Google Cloud resources which can
freely import and export data amongst themselves, but not export outside of
the `ServicePerimeter`. If a request with a source within this
`ServicePerimeter` has a target outside of the `ServicePerimeter`, the
request will be blocked. Otherwise the request is allowed. There are two
types of Service Perimeter - Regular and Bridge. Regular Service Perimeters
cannot overlap, a single Google Cloud project can only belong to a single
regular Service Perimeter. Service Perimeter Bridges can contain only Google
Cloud projects as members, a single Google Cloud project may belong to
multiple Service Perimeter Bridges.
Enums:
PerimeterTypeValueValuesEnum: Perimeter type indicator. A single project
is allowed to be a member of single regular perimeter, but multiple
service perimeter bridges. A project cannot be a included in a perimeter
bridge without being included in regular perimeter. For perimeter
bridges, restricted/unrestricted service lists as well as access lists
must be empty.
Fields:
description: Description of the `ServicePerimeter` and its use. Does not
affect behavior.
dryRun: Dry run flag. This flag enables dry run tests for the "proposed"
Service Perimeter configuration. When this flag is enabled, access
restrictions suggestions from the proposed("spec") configuration are
tested without actually enforcing them. This testing is done through
analyzing the differences between currently enforced and suggested
restrictions. As of now, dry_run must be set to true if there is any
proposed config
name: Required. Resource name for the ServicePerimeter. The `short_name`
component must begin with a letter and only include alphanumeric and
'_'. Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
perimeterType: Perimeter type indicator. A single project is allowed to be
a member of single regular perimeter, but multiple service perimeter
bridges. A project cannot be a included in a perimeter bridge without
being included in regular perimeter. For perimeter bridges,
restricted/unrestricted service lists as well as access lists must be
empty.
spec: Proposed (or dry run) ServicePerimeter configuration. This
configuration allows to specify and test ServicePerimeter configuration
without enforcing actual access restrictions. Only allowed to be set
when the "dry_run" flag is set.
status: Current ServicePerimeter configuration. Specifies sets of
resources, restricted/unrestricted services and access levels that
determine perimeter content and boundaries.
title: Human readable title. Must be unique within the Policy.
"""
class PerimeterTypeValueValuesEnum(_messages.Enum):
r"""Perimeter type indicator. A single project is allowed to be a member
of single regular perimeter, but multiple service perimeter bridges. A
project cannot be a included in a perimeter bridge without being included
in regular perimeter. For perimeter bridges, restricted/unrestricted
service lists as well as access lists must be empty.
Values:
PERIMETER_TYPE_REGULAR: Regular Perimeter.
PERIMETER_TYPE_BRIDGE: Perimeter Bridge.
"""
PERIMETER_TYPE_REGULAR = 0
PERIMETER_TYPE_BRIDGE = 1
description = _messages.StringField(1)
dryRun = _messages.BooleanField(2)
name = _messages.StringField(3)
perimeterType = _messages.EnumField('PerimeterTypeValueValuesEnum', 4)
spec = _messages.MessageField('ServicePerimeterConfig', 5)
status = _messages.MessageField('ServicePerimeterConfig', 6)
title = _messages.StringField(7)
class Debuggee(_messages.Message):
"""Represents the application to debug. The application may include one or
more replicated processes executing the same code. Each of these processes
is attached with a debugger agent, carrying out the debugging commands. The
agents attached to the same debuggee are identified by using exactly the
same field values when registering.
Messages:
LabelsValue: A set of custom debuggee properties, populated by the agent,
to be displayed to the user.
Fields:
agentVersion: Version ID of the agent release. The version ID is
structured as following: `domain/type/vmajor.minor` (for example
`google.com/gcp-java/v1.1`).
description: Human readable description of the debuggee. Including a
human-readable project name, environment name and version information is
recommended.
extSourceContexts: References to the locations and revisions of the source
code used in the deployed application. Contexts describing a remote
repo related to the source code have a `category` label of
`remote_repo`. Source snapshot source contexts have a `category` of
`snapshot`.
id: Unique identifier for the debuggee generated by the controller
service.
isDisabled: If set to `true`, indicates that the agent should disable
itself and detach from the debuggee.
isInactive: If set to `true`, indicates that the debuggee is considered as
inactive by the Controller service.
labels: A set of custom debuggee properties, populated by the agent, to be
displayed to the user.
project: Project the debuggee is associated with. Use the project number
when registering a Google Cloud Platform project.
sourceContexts: References to the locations and revisions of the source
code used in the deployed application. NOTE: This field is deprecated.
Consumers should use `ext_source_contexts` if it is not empty. Debug
agents should populate both this field and `ext_source_contexts`.
status: Human readable message to be displayed to the user about this
debuggee. Absence of this field indicates no status. The message can be
either informational or an error status.
uniquifier: Debuggee uniquifier within the project. Any string that
identifies the application within the project can be used. Including
environment and version or build IDs is recommended.
"""
@encoding.MapUnrecognizedFields('additionalProperties')
class LabelsValue(_messages.Message):
"""A set of custom debuggee properties, populated by the agent, to be
displayed to the user.
Messages:
AdditionalProperty: An additional property for a LabelsValue object.
Fields:
additionalProperties: Additional properties of type LabelsValue
"""
class AdditionalProperty(_messages.Message):
"""An additional property for a LabelsValue 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)
agentVersion = _messages.StringField(1)
description = _messages.StringField(2)
extSourceContexts = _messages.MessageField('ExtendedSourceContext',
3,
repeated=True)
id = _messages.StringField(4)
isDisabled = _messages.BooleanField(5)
isInactive = _messages.BooleanField(6)
labels = _messages.MessageField('LabelsValue', 7)
project = _messages.StringField(8)
sourceContexts = _messages.MessageField('SourceContext', 9, repeated=True)
status = _messages.MessageField('StatusMessage', 10)
uniquifier = _messages.StringField(11)
class RequestLog(_messages.Message):
"""Complete log information about a single HTTP request to an App Engine
application.
Fields:
appEngineRelease: App Engine release version.
appId: Application that handled this request.
cost: An indication of the relative cost of serving this request.
endTime: Time when the request finished.
finished: Whether this request is finished or active.
first: Whether this is the first RequestLog entry for this request. If an
active request has several RequestLog entries written to Stackdriver
Logging, then this field will be set for one of them.
host: Internet host and port number of the resource being requested.
httpVersion: HTTP version of request. Example: "HTTP/1.1".
instanceId: An identifier for the instance that handled the request.
instanceIndex: If the instance processing this request belongs to a
manually scaled module, then this is the 0-based index of the instance.
Otherwise, this value is -1.
ip: Origin IP address.
latency: Latency of the request.
line: A list of log lines emitted by the application while serving this
request.
megaCycles: Number of CPU megacycles used to process request.
method: Request method. Example: "GET", "HEAD", "PUT", "POST", "DELETE".
moduleId: Module of the application that handled this request.
nickname: The logged-in user who made the request.Most likely, this is the
part of the user's email before the @ sign. The field value is the same
for different requests from the same user, but different users can have
similar names. This information is also available to the application via
the App Engine Users API.This field will be populated starting with App
Engine 1.9.21.
pendingTime: Time this request spent in the pending request queue.
referrer: Referrer URL of request.
requestId: Globally unique identifier for a request, which is based on the
request start time. Request IDs for requests which started later will
compare greater as strings than those for requests which started
earlier.
resource: Contains the path and query portion of the URL that was
requested. For example, if the URL was
"http://example.com/app?name=val", the resource would be
"/app?name=val". The fragment identifier, which is identified by the #
character, is not included.
responseSize: Size in bytes sent back to client by request.
sourceReference: Source code for the application that handled this
request. There can be more than one source reference per deployed
application if source code is distributed among multiple repositories.
startTime: Time when the request started.
status: HTTP response status code. Example: 200, 404.
taskName: Task name of the request, in the case of an offline request.
taskQueueName: Queue name of the request, in the case of an offline
request.
traceId: Stackdriver Trace identifier for this request.
urlMapEntry: File or class that handled the request.
userAgent: User agent that made the request.
versionId: Version of the application that handled this request.
wasLoadingRequest: Whether this was a loading request for the instance.
"""
appEngineRelease = _messages.StringField(1)
appId = _messages.StringField(2)
cost = _messages.FloatField(3)
endTime = _messages.StringField(4)
finished = _messages.BooleanField(5)
first = _messages.BooleanField(6)
host = _messages.StringField(7)
httpVersion = _messages.StringField(8)
instanceId = _messages.StringField(9)
instanceIndex = _messages.IntegerField(10, variant=_messages.Variant.INT32)
ip = _messages.StringField(11)
latency = _messages.StringField(12)
line = _messages.MessageField('LogLine', 13, repeated=True)
megaCycles = _messages.IntegerField(14)
method = _messages.StringField(15)
moduleId = _messages.StringField(16)
nickname = _messages.StringField(17)
pendingTime = _messages.StringField(18)
referrer = _messages.StringField(19)
requestId = _messages.StringField(20)
resource = _messages.StringField(21)
responseSize = _messages.IntegerField(22)
sourceReference = _messages.MessageField('SourceReference', 23, repeated=True)
startTime = _messages.StringField(24)
status = _messages.IntegerField(25, variant=_messages.Variant.INT32)
taskName = _messages.StringField(26)
taskQueueName = _messages.StringField(27)
traceId = _messages.StringField(28)
urlMapEntry = _messages.StringField(29)
userAgent = _messages.StringField(30)
versionId = _messages.StringField(31)
wasLoadingRequest = _messages.BooleanField(32)
class Breakpoint(_messages.Message):
"""Represents the breakpoint specification, status and results.
Enums:
ActionValueValuesEnum: Action that the agent should perform when the code
at the breakpoint location is hit.
LogLevelValueValuesEnum: Indicates the severity of the log. Only relevant
when action is `LOG`.
Messages:
LabelsValue: A set of custom breakpoint properties, populated by the
agent, to be displayed to the user.
Fields:
action: Action that the agent should perform when the code at the
breakpoint location is hit.
condition: Condition that triggers the breakpoint. The condition is a
compound boolean expression composed using expressions in a programming
language at the source location.
createTime: Time this breakpoint was created by the server in seconds
resolution.
evaluatedExpressions: Values of evaluated expressions at breakpoint time.
The evaluated expressions appear in exactly the same order they are
listed in the `expressions` field. The `name` field holds the original
expression text, the `value` or `members` field holds the result of the
evaluated expression. If the expression cannot be evaluated, the
`status` inside the `Variable` will indicate an error and contain the
error text.
expressions: List of read-only expressions to evaluate at the breakpoint
location. The expressions are composed using expressions in the
programming language at the source location. If the breakpoint action is
`LOG`, the evaluated expressions are included in log statements.
finalTime: Time this breakpoint was finalized as seen by the server in
seconds resolution.
id: Breakpoint identifier, unique in the scope of the debuggee.
isFinalState: When true, indicates that this is a final result and the
breakpoint state will not change from here on.
labels: A set of custom breakpoint properties, populated by the agent, to
be displayed to the user.
location: Breakpoint source location.
logLevel: Indicates the severity of the log. Only relevant when action is
`LOG`.
logMessageFormat: Only relevant when action is `LOG`. Defines the message
to log when the breakpoint hits. The message may include parameter
placeholders `$0`, `$1`, etc. These placeholders are replaced with the
evaluated value of the appropriate expression. Expressions not
referenced in `log_message_format` are not logged. Example: `Message
received, id = $0, count = $1` with `expressions` = `[ message.id,
message.count ]`.
stackFrames: The stack at breakpoint time.
status: Breakpoint status. The status includes an error flag and a human
readable message. This field is usually unset. The message can be either
informational or an error message. Regardless, clients should always
display the text message back to the user. Error status indicates
complete failure of the breakpoint. Example (non-final state): `Still
loading symbols...` Examples (final state): * `Invalid line number`
referring to location * `Field f not found in class C` referring to
condition
userEmail: E-mail address of the user that created this breakpoint
variableTable: The `variable_table` exists to aid with computation, memory
and network traffic optimization. It enables storing a variable once
and reference it from multiple variables, including variables stored in
the `variable_table` itself. For example, the same `this` object, which
may appear at many levels of the stack, can have all of its data stored
once in this table. The stack frame variables then would hold only a
reference to it. The variable `var_table_index` field is an index into
this repeated field. The stored objects are nameless and get their name
from the referencing variable. The effective variable is a merge of the
referencing variable and the referenced variable.
"""
class ActionValueValuesEnum(_messages.Enum):
"""Action that the agent should perform when the code at the breakpoint
location is hit.
Values:
CAPTURE: Capture stack frame and variables and update the breakpoint.
The data is only captured once. After that the breakpoint is set in a
final state.
LOG: Log each breakpoint hit. The breakpoint remains active until
deleted or expired.
"""
CAPTURE = 0
LOG = 1
class LogLevelValueValuesEnum(_messages.Enum):
"""Indicates the severity of the log. Only relevant when action is `LOG`.
Values:
INFO: Information log message.
WARNING: Warning log message.
ERROR: Error log message.
"""
INFO = 0
WARNING = 1
ERROR = 2
@encoding.MapUnrecognizedFields('additionalProperties')
class LabelsValue(_messages.Message):
"""A set of custom breakpoint properties, populated by the agent, to be
displayed to the user.
Messages:
AdditionalProperty: An additional property for a LabelsValue object.
Fields:
additionalProperties: Additional properties of type LabelsValue
"""
class AdditionalProperty(_messages.Message):
"""An additional property for a LabelsValue 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)
action = _messages.EnumField('ActionValueValuesEnum', 1)
condition = _messages.StringField(2)
createTime = _messages.StringField(3)
evaluatedExpressions = _messages.MessageField('Variable', 4, repeated=True)
expressions = _messages.StringField(5, repeated=True)
finalTime = _messages.StringField(6)
id = _messages.StringField(7)
isFinalState = _messages.BooleanField(8)
labels = _messages.MessageField('LabelsValue', 9)
location = _messages.MessageField('SourceLocation', 10)
logLevel = _messages.EnumField('LogLevelValueValuesEnum', 11)
logMessageFormat = _messages.StringField(12)
stackFrames = _messages.MessageField('StackFrame', 13, repeated=True)
status = _messages.MessageField('StatusMessage', 14)
userEmail = _messages.StringField(15)
variableTable = _messages.MessageField('Variable', 16, repeated=True)
class Operation(_messages.Message):
r"""This resource represents a long-running operation that is the result of
a network API call.
Messages:
MetadataValue: An OperationMetadata or Metadata object. This will always
be returned with the Operation.
ResponseValue: An Empty object.
Fields:
done: If the value is `false`, it means the operation is still in
progress. If `true`, the operation is completed, and either `error` or
`response` is available.
error: The error result of the operation in case of failure or
cancellation.
metadata: An OperationMetadata or Metadata object. This will always be
returned with the Operation.
name: The server-assigned name, which is only unique within the same
service that originally returns it. For example:
`operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
response: An Empty object.
"""
@encoding.MapUnrecognizedFields('additionalProperties')
class MetadataValue(_messages.Message):
r"""An OperationMetadata or Metadata object. This will always be returned
with the Operation.
Messages:
AdditionalProperty: An additional property for a MetadataValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a MetadataValue 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)
@encoding.MapUnrecognizedFields('additionalProperties')
class ResponseValue(_messages.Message):
r"""An Empty object.
Messages:
AdditionalProperty: An additional property for a ResponseValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a ResponseValue 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)
done = _messages.BooleanField(1)
error = _messages.MessageField('Status', 2)
metadata = _messages.MessageField('MetadataValue', 3)
name = _messages.StringField(4)
response = _messages.MessageField('ResponseValue', 5)
class DnsKey(_messages.Message):
"""A DNSSEC key pair.
Enums:
AlgorithmValueValuesEnum: String mnemonic specifying the DNSSEC algorithm
of this key. Immutable after creation time.
TypeValueValuesEnum: One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type
KEY_SIGNING have the Secure Entry Point flag set and, when active, will
be used to sign only resource record sets of type DNSKEY. Otherwise, the
Secure Entry Point flag will be cleared and this key will be used to
sign only resource record sets of other types. Immutable after creation
time.
Fields:
algorithm: String mnemonic specifying the DNSSEC algorithm of this key.
Immutable after creation time.
creationTime: The time that this resource was created in the control
plane. This is in RFC3339 text format. Output only.
description: A mutable string of at most 1024 characters associated with
this resource for the user's convenience. Has no effect on the
resource's function.
digests: Cryptographic hashes of the DNSKEY resource record associated
with this DnsKey. These digests are needed to construct a DS record that
points at this DNS key. Output only.
id: Unique identifier for the resource; defined by the server (output
only).
isActive: Active keys will be used to sign subsequent changes to the
ManagedZone. Inactive keys will still be present as DNSKEY Resource
Records for the use of resolvers validating existing signatures.
keyLength: Length of the key in bits. Specified at creation time then
immutable.
keyTag: The key tag is a non-cryptographic hash of the a DNSKEY resource
record associated with this DnsKey. The key tag can be used to identify
a DNSKEY more quickly (but it is not a unique identifier). In
particular, the key tag is used in a parent zone's DS record to point at
the DNSKEY in this child ManagedZone. The key tag is a number in the
range [0, 65535] and the algorithm to calculate it is specified in
RFC4034 Appendix B. Output only.
kind: Identifies what kind of resource this is. Value: the fixed string
"dns#dnsKey".
publicKey: Base64 encoded public half of this key. Output only.
type: One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING
have the Secure Entry Point flag set and, when active, will be used to
sign only resource record sets of type DNSKEY. Otherwise, the Secure
Entry Point flag will be cleared and this key will be used to sign only
resource record sets of other types. Immutable after creation time.
"""
class AlgorithmValueValuesEnum(_messages.Enum):
"""String mnemonic specifying the DNSSEC algorithm of this key. Immutable
after creation time.
Values:
ecdsap256sha256: <no description>
ecdsap384sha384: <no description>
rsasha1: <no description>
rsasha256: <no description>
rsasha512: <no description>
"""
ecdsap256sha256 = 0
ecdsap384sha384 = 1
rsasha1 = 2
rsasha256 = 3
rsasha512 = 4
class TypeValueValuesEnum(_messages.Enum):
"""One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have
the Secure Entry Point flag set and, when active, will be used to sign
only resource record sets of type DNSKEY. Otherwise, the Secure Entry
Point flag will be cleared and this key will be used to sign only resource
record sets of other types. Immutable after creation time.
Values:
keySigning: <no description>
zoneSigning: <no description>
"""
keySigning = 0
zoneSigning = 1
algorithm = _messages.EnumField('AlgorithmValueValuesEnum', 1)
creationTime = _messages.StringField(2)
description = _messages.StringField(3)
digests = _messages.MessageField('DnsKeyDigest', 4, repeated=True)
id = _messages.StringField(5)
isActive = _messages.BooleanField(6)
keyLength = _messages.IntegerField(7, variant=_messages.Variant.UINT32)
keyTag = _messages.IntegerField(8, variant=_messages.Variant.INT32)
kind = _messages.StringField(9, default=u'dns#dnsKey')
publicKey = _messages.StringField(10)
type = _messages.EnumField('TypeValueValuesEnum', 11)
class Operation(_messages.Message):
r"""This resource represents a long-running operation that is the result of
a network API call.
Messages:
MetadataValue: Service-specific metadata associated with the operation. It
typically contains progress information and common metadata such as
create time. Some services might not provide such metadata. Any method
that returns a long-running operation should document the metadata type,
if any.
ResponseValue: The normal response of the operation in case of success. If
the original method returns no data on success, such as `Delete`, the
response is `google.protobuf.Empty`. If the original method is standard
`Get`/`Create`/`Update`, the response should be the resource. For other
methods, the response should have the type `XxxResponse`, where `Xxx` is
the original method name. For example, if the original method name is
`TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
Fields:
done: If the value is `false`, it means the operation is still in
progress. If `true`, the operation is completed, and either `error` or
`response` is available.
error: The error result of the operation in case of failure or
cancellation.
metadata: Service-specific metadata associated with the operation. It
typically contains progress information and common metadata such as
create time. Some services might not provide such metadata. Any method
that returns a long-running operation should document the metadata type,
if any.
name: The server-assigned name, which is only unique within the same
service that originally returns it. If you use the default HTTP mapping,
the `name` should be a resource name ending with
`operations/{unique_id}`.
response: The normal response of the operation in case of success. If the
original method returns no data on success, such as `Delete`, the
response is `google.protobuf.Empty`. If the original method is standard
`Get`/`Create`/`Update`, the response should be the resource. For other
methods, the response should have the type `XxxResponse`, where `Xxx` is
the original method name. For example, if the original method name is
`TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"""
@encoding.MapUnrecognizedFields('additionalProperties')
class MetadataValue(_messages.Message):
r"""Service-specific metadata associated with the operation. It typically
contains progress information and common metadata such as create time.
Some services might not provide such metadata. Any method that returns a
long-running operation should document the metadata type, if any.
Messages:
AdditionalProperty: An additional property for a MetadataValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a MetadataValue 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)
@encoding.MapUnrecognizedFields('additionalProperties')
class ResponseValue(_messages.Message):
r"""The normal response of the operation in case of success. If the
original method returns no data on success, such as `Delete`, the response
is `google.protobuf.Empty`. If the original method is standard
`Get`/`Create`/`Update`, the response should be the resource. For other
methods, the response should have the type `XxxResponse`, where `Xxx` is
the original method name. For example, if the original method name is
`TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
Messages:
AdditionalProperty: An additional property for a ResponseValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a ResponseValue 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)
done = _messages.BooleanField(1)
error = _messages.MessageField('Status', 2)
metadata = _messages.MessageField('MetadataValue', 3)
name = _messages.StringField(4)
response = _messages.MessageField('ResponseValue', 5)
class Job(_messages.Message):
r"""Configuration for a job. The maximum allowed size for a job is 1MB.
Enums:
StateValueValuesEnum: Output only. State of the job.
Fields:
appEngineHttpTarget: App Engine HTTP target.
attemptDeadline: 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 15 seconds. * For Pub/Sub
targets, this field is ignored.
description: Optionally caller-specified in CreateJob or UpdateJob. A
human-readable description for the job. This string must not contain
more than 500 characters.
httpTarget: HTTP target.
lastAttemptTime: Output only. The time the last job attempt started.
legacyAppEngineCron: Immutable. This field is used to manage the legacy
App Engine Cron jobs using the Cloud Scheduler API. If the field is set
to true, the job will be considered a legacy job. Note that App Engine
Cron jobs have fewer features than Cloud Scheduler jobs, e.g., are only
limited to App Engine targets.
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.
pubsubTarget: Pub/Sub target.
retryConfig: Settings that determine the retry behavior.
schedule: 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](https://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.
scheduleTime: 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.
state: Output only. State of the job.
status: Output only. The response from the target for the last attempted
execution.
timeZone: 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).
userUpdateTime: Output only. The creation time of the job.
"""
class StateValueValuesEnum(_messages.Enum):
r"""Output only. State of the job.
Values:
STATE_UNSPECIFIED: Unspecified state.
ENABLED: The job is executing normally.
PAUSED: The job is paused by the user. It will not execute. A user can
intentionally pause the job using PauseJobRequest.
DISABLED: The job is disabled by the system due to error. The user
cannot directly set a job to be disabled.
UPDATE_FAILED: The job state resulting from a failed
CloudScheduler.UpdateJob operation. To recover a job from this state,
retry CloudScheduler.UpdateJob until a successful response is
received.
"""
STATE_UNSPECIFIED = 0
ENABLED = 1
PAUSED = 2
DISABLED = 3
UPDATE_FAILED = 4
appEngineHttpTarget = _messages.MessageField('AppEngineHttpTarget', 1)
attemptDeadline = _messages.StringField(2)
description = _messages.StringField(3)
httpTarget = _messages.MessageField('HttpTarget', 4)
lastAttemptTime = _messages.StringField(5)
legacyAppEngineCron = _messages.BooleanField(6)
name = _messages.StringField(7)
pubsubTarget = _messages.MessageField('PubsubTarget', 8)
retryConfig = _messages.MessageField('RetryConfig', 9)
schedule = _messages.StringField(10)
scheduleTime = _messages.StringField(11)
state = _messages.EnumField('StateValueValuesEnum', 12)
status = _messages.MessageField('Status', 13)
timeZone = _messages.StringField(14)
userUpdateTime = _messages.StringField(15)
