class BuildOptions(_messages.Message):
"""Optional arguments to enable specific features of builds.
Enums:
LogStreamingOptionValueValuesEnum: LogStreamingOption to define build log
streaming behavior to Google Cloud Storage.
RequestedVerifyOptionValueValuesEnum: Requested verifiability options.
SourceProvenanceHashValueListEntryValuesEnum:
SubstitutionOptionValueValuesEnum: SubstitutionOption to allow unmatch
substitutions.
Fields:
logStreamingOption: LogStreamingOption to define build log streaming
behavior to Google Cloud Storage.
requestedVerifyOption: Requested verifiability options.
sourceProvenanceHash: Requested hash for SourceProvenance.
substitutionOption: SubstitutionOption to allow unmatch substitutions.
"""
class LogStreamingOptionValueValuesEnum(_messages.Enum):
"""LogStreamingOption to define build log streaming behavior to Google
Cloud Storage.
Values:
STREAM_DEFAULT: Service may automatically determine build log streaming
behavior.
STREAM_ON: Build logs should be streamed to Google Cloud Storage.
STREAM_OFF: Build logs should not be streamed to Google Cloud Storage;
they will be written when the build is completed.
"""
STREAM_DEFAULT = 0
STREAM_ON = 1
STREAM_OFF = 2
class RequestedVerifyOptionValueValuesEnum(_messages.Enum):
"""Requested verifiability options.
Values:
NOT_VERIFIED: Not a verifiable build. (default)
VERIFIED: Verified build.
"""
NOT_VERIFIED = 0
VERIFIED = 1
class SourceProvenanceHashValueListEntryValuesEnum(_messages.Enum):
"""SourceProvenanceHashValueListEntryValuesEnum enum type.
Values:
NONE: <no description>
SHA256: <no description>
"""
NONE = 0
SHA256 = 1
class SubstitutionOptionValueValuesEnum(_messages.Enum):
"""SubstitutionOption to allow unmatch substitutions.
Values:
MUST_MATCH: Fails the build if error in substitutions checks, like
missing a substitution in the template or in the map.
ALLOW_LOOSE: Do not fail the build if error in substitutions checks.
"""
MUST_MATCH = 0
ALLOW_LOOSE = 1
logStreamingOption = _messages.EnumField(
'LogStreamingOptionValueValuesEnum', 1)
requestedVerifyOption = _messages.EnumField(
'RequestedVerifyOptionValueValuesEnum', 2)
sourceProvenanceHash = _messages.EnumField(
'SourceProvenanceHashValueListEntryValuesEnum', 3, repeated=True)
substitutionOption = _messages.EnumField(
'SubstitutionOptionValueValuesEnum', 4)
class DependencyEdge(_messages.Message):
"""Represents dependency parse tree information for a token. (For more
information on dependency labels, see
http://www.aclweb.org/anthology/P13-2017
Enums:
LabelValueValuesEnum: The parse label for the token.
Fields:
headTokenIndex: Represents the head of this token in the dependency tree.
This is the index of the token which has an arc going to this token. The
index is the position of the token in the array of tokens returned by
the API method. If this token is a root token, then the
`head_token_index` is its own index.
label: The parse label for the token.
"""
class LabelValueValuesEnum(_messages.Enum):
"""The parse label for the token.
Values:
UNKNOWN: Unknown
ABBREV: Abbreviation modifier
ACOMP: Adjectival complement
ADVCL: Adverbial clause modifier
ADVMOD: Adverbial modifier
AMOD: Adjectival modifier of an NP
APPOS: Appositional modifier of an NP
ATTR: Attribute dependent of a copular verb
AUX: Auxiliary (non-main) verb
AUXPASS: Passive auxiliary
CC: Coordinating conjunction
CCOMP: Clausal complement of a verb or adjective
CONJ: Conjunct
CSUBJ: Clausal subject
CSUBJPASS: Clausal passive subject
DEP: Dependency (unable to determine)
DET: Determiner
DISCOURSE: Discourse
DOBJ: Direct object
EXPL: Expletive
GOESWITH: Goes with (part of a word in a text not well edited)
IOBJ: Indirect object
MARK: Marker (word introducing a subordinate clause)
MWE: Multi-word expression
MWV: Multi-word verbal expression
NEG: Negation modifier
NN: Noun compound modifier
NPADVMOD: Noun phrase used as an adverbial modifier
NSUBJ: Nominal subject
NSUBJPASS: Passive nominal subject
NUM: Numeric modifier of a noun
NUMBER: Element of compound number
P: Punctuation mark
PARATAXIS: Parataxis relation
PARTMOD: Participial modifier
PCOMP: The complement of a preposition is a clause
POBJ: Object of a preposition
POSS: Possession modifier
POSTNEG: Postverbal negative particle
PRECOMP: Predicate complement
PRECONJ: Preconjunt
PREDET: Predeterminer
PREF: Prefix
PREP: Prepositional modifier
PRONL: The relationship between a verb and verbal morpheme
PRT: Particle
PS: Associative or possessive marker
QUANTMOD: Quantifier phrase modifier
RCMOD: Relative clause modifier
RCMODREL: Complementizer in relative clause
RDROP: Ellipsis without a preceding predicate
REF: Referent
REMNANT: Remnant
REPARANDUM: Reparandum
ROOT: Root
SNUM: Suffix specifying a unit of number
SUFF: Suffix
TMOD: Temporal modifier
TOPIC: Topic marker
VMOD: Clause headed by an infinite form of the verb that modifies a noun
VOCATIVE: Vocative
XCOMP: Open clausal complement
SUFFIX: Name suffix
TITLE: Name title
ADVPHMOD: Adverbial phrase modifier
AUXCAUS: Causative auxiliary
AUXVV: Helper auxiliary
DTMOD: Rentaishi (Prenominal modifier)
FOREIGN: Foreign words
KW: Keyword
LIST: List for chains of comparable items
NOMC: Nominalized clause
NOMCSUBJ: Nominalized clausal subject
NOMCSUBJPASS: Nominalized clausal passive
NUMC: Compound of numeric modifier
COP: Copula
DISLOCATED: Dislocated relation (for fronted/topicalized elements)
"""
UNKNOWN = 0
ABBREV = 1
ACOMP = 2
ADVCL = 3
ADVMOD = 4
AMOD = 5
APPOS = 6
ATTR = 7
AUX = 8
AUXPASS = 9
CC = 10
CCOMP = 11
CONJ = 12
CSUBJ = 13
CSUBJPASS = 14
DEP = 15
DET = 16
DISCOURSE = 17
DOBJ = 18
EXPL = 19
GOESWITH = 20
IOBJ = 21
MARK = 22
MWE = 23
MWV = 24
NEG = 25
NN = 26
NPADVMOD = 27
NSUBJ = 28
NSUBJPASS = 29
NUM = 30
NUMBER = 31
P = 32
PARATAXIS = 33
PARTMOD = 34
PCOMP = 35
POBJ = 36
POSS = 37
POSTNEG = 38
PRECOMP = 39
PRECONJ = 40
PREDET = 41
PREF = 42
PREP = 43
PRONL = 44
PRT = 45
PS = 46
QUANTMOD = 47
RCMOD = 48
RCMODREL = 49
RDROP = 50
REF = 51
REMNANT = 52
REPARANDUM = 53
ROOT = 54
SNUM = 55
SUFF = 56
TMOD = 57
TOPIC = 58
VMOD = 59
VOCATIVE = 60
XCOMP = 61
SUFFIX = 62
TITLE = 63
ADVPHMOD = 64
AUXCAUS = 65
AUXVV = 66
DTMOD = 67
FOREIGN = 68
KW = 69
LIST = 70
NOMC = 71
NOMCSUBJ = 72
NOMCSUBJPASS = 73
NUMC = 74
COP = 75
DISLOCATED = 76
headTokenIndex = _messages.IntegerField(1, variant=_messages.Variant.INT32)
label = _messages.EnumField('LabelValueValuesEnum', 2)
class PartOfSpeech(_messages.Message):
"""Represents part of speech information for a token. Parts of speech are as
defined in http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
Enums:
AspectValueValuesEnum: The grammatical aspect.
CaseValueValuesEnum: The grammatical case.
FormValueValuesEnum: The grammatical form.
GenderValueValuesEnum: The grammatical gender.
MoodValueValuesEnum: The grammatical mood.
NumberValueValuesEnum: The grammatical number.
PersonValueValuesEnum: The grammatical person.
ProperValueValuesEnum: The grammatical properness.
ReciprocityValueValuesEnum: The grammatical reciprocity.
TagValueValuesEnum: The part of speech tag.
TenseValueValuesEnum: The grammatical tense.
VoiceValueValuesEnum: The grammatical voice.
Fields:
aspect: The grammatical aspect.
case: The grammatical case.
form: The grammatical form.
gender: The grammatical gender.
mood: The grammatical mood.
number: The grammatical number.
person: The grammatical person.
proper: The grammatical properness.
reciprocity: The grammatical reciprocity.
tag: The part of speech tag.
tense: The grammatical tense.
voice: The grammatical voice.
"""
class AspectValueValuesEnum(_messages.Enum):
"""The grammatical aspect.
Values:
ASPECT_UNKNOWN: Aspect is not applicable in the analyzed language or is
not predicted.
PERFECTIVE: Perfective
IMPERFECTIVE: Imperfective
PROGRESSIVE: Progressive
"""
ASPECT_UNKNOWN = 0
PERFECTIVE = 1
IMPERFECTIVE = 2
PROGRESSIVE = 3
class CaseValueValuesEnum(_messages.Enum):
"""The grammatical case.
Values:
CASE_UNKNOWN: Case is not applicable in the analyzed language or is not
predicted.
ACCUSATIVE: Accusative
ADVERBIAL: Adverbial
COMPLEMENTIVE: Complementive
DATIVE: Dative
GENITIVE: Genitive
INSTRUMENTAL: Instrumental
LOCATIVE: Locative
NOMINATIVE: Nominative
OBLIQUE: Oblique
PARTITIVE: Partitive
PREPOSITIONAL: Prepositional
REFLEXIVE_CASE: Reflexive
RELATIVE_CASE: Relative
VOCATIVE: Vocative
"""
CASE_UNKNOWN = 0
ACCUSATIVE = 1
ADVERBIAL = 2
COMPLEMENTIVE = 3
DATIVE = 4
GENITIVE = 5
INSTRUMENTAL = 6
LOCATIVE = 7
NOMINATIVE = 8
OBLIQUE = 9
PARTITIVE = 10
PREPOSITIONAL = 11
REFLEXIVE_CASE = 12
RELATIVE_CASE = 13
VOCATIVE = 14
class FormValueValuesEnum(_messages.Enum):
"""The grammatical form.
Values:
FORM_UNKNOWN: Form is not applicable in the analyzed language or is not
predicted.
ADNOMIAL: Adnomial
AUXILIARY: Auxiliary
COMPLEMENTIZER: Complementizer
FINAL_ENDING: Final ending
GERUND: Gerund
REALIS: Realis
IRREALIS: Irrealis
SHORT: Short form
LONG: Long form
ORDER: Order form
SPECIFIC: Specific form
"""
FORM_UNKNOWN = 0
ADNOMIAL = 1
AUXILIARY = 2
COMPLEMENTIZER = 3
FINAL_ENDING = 4
GERUND = 5
REALIS = 6
IRREALIS = 7
SHORT = 8
LONG = 9
ORDER = 10
SPECIFIC = 11
class GenderValueValuesEnum(_messages.Enum):
"""The grammatical gender.
Values:
GENDER_UNKNOWN: Gender is not applicable in the analyzed language or is
not predicted.
FEMININE: Feminine
MASCULINE: Masculine
NEUTER: Neuter
"""
GENDER_UNKNOWN = 0
FEMININE = 1
MASCULINE = 2
NEUTER = 3
class MoodValueValuesEnum(_messages.Enum):
"""The grammatical mood.
Values:
MOOD_UNKNOWN: Mood is not applicable in the analyzed language or is not
predicted.
CONDITIONAL_MOOD: Conditional
IMPERATIVE: Imperative
INDICATIVE: Indicative
INTERROGATIVE: Interrogative
JUSSIVE: Jussive
SUBJUNCTIVE: Subjunctive
"""
MOOD_UNKNOWN = 0
CONDITIONAL_MOOD = 1
IMPERATIVE = 2
INDICATIVE = 3
INTERROGATIVE = 4
JUSSIVE = 5
SUBJUNCTIVE = 6
class NumberValueValuesEnum(_messages.Enum):
"""The grammatical number.
Values:
NUMBER_UNKNOWN: Number is not applicable in the analyzed language or is
not predicted.
SINGULAR: Singular
PLURAL: Plural
DUAL: Dual
"""
NUMBER_UNKNOWN = 0
SINGULAR = 1
PLURAL = 2
DUAL = 3
class PersonValueValuesEnum(_messages.Enum):
"""The grammatical person.
Values:
PERSON_UNKNOWN: Person is not applicable in the analyzed language or is
not predicted.
FIRST: First
SECOND: Second
THIRD: Third
REFLEXIVE_PERSON: Reflexive
"""
PERSON_UNKNOWN = 0
FIRST = 1
SECOND = 2
THIRD = 3
REFLEXIVE_PERSON = 4
class ProperValueValuesEnum(_messages.Enum):
"""The grammatical properness.
Values:
PROPER_UNKNOWN: Proper is not applicable in the analyzed language or is
not predicted.
PROPER: Proper
NOT_PROPER: Not proper
"""
PROPER_UNKNOWN = 0
PROPER = 1
NOT_PROPER = 2
class ReciprocityValueValuesEnum(_messages.Enum):
"""The grammatical reciprocity.
Values:
RECIPROCITY_UNKNOWN: Reciprocity is not applicable in the analyzed
language or is not predicted.
RECIPROCAL: Reciprocal
NON_RECIPROCAL: Non-reciprocal
"""
RECIPROCITY_UNKNOWN = 0
RECIPROCAL = 1
NON_RECIPROCAL = 2
class TagValueValuesEnum(_messages.Enum):
"""The part of speech tag.
Values:
UNKNOWN: Unknown
ADJ: Adjective
ADP: Adposition (preposition and postposition)
ADV: Adverb
CONJ: Conjunction
DET: Determiner
NOUN: Noun (common and proper)
NUM: Cardinal number
PRON: Pronoun
PRT: Particle or other function word
PUNCT: Punctuation
VERB: Verb (all tenses and modes)
X: Other: foreign words, typos, abbreviations
AFFIX: Affix
"""
UNKNOWN = 0
ADJ = 1
ADP = 2
ADV = 3
CONJ = 4
DET = 5
NOUN = 6
NUM = 7
PRON = 8
PRT = 9
PUNCT = 10
VERB = 11
X = 12
AFFIX = 13
class TenseValueValuesEnum(_messages.Enum):
"""The grammatical tense.
Values:
TENSE_UNKNOWN: Tense is not applicable in the analyzed language or is
not predicted.
CONDITIONAL_TENSE: Conditional
FUTURE: Future
PAST: Past
PRESENT: Present
IMPERFECT: Imperfect
PLUPERFECT: Pluperfect
"""
TENSE_UNKNOWN = 0
CONDITIONAL_TENSE = 1
FUTURE = 2
PAST = 3
PRESENT = 4
IMPERFECT = 5
PLUPERFECT = 6
class VoiceValueValuesEnum(_messages.Enum):
"""The grammatical voice.
Values:
VOICE_UNKNOWN: Voice is not applicable in the analyzed language or is
not predicted.
ACTIVE: Active
CAUSATIVE: Causative
PASSIVE: Passive
"""
VOICE_UNKNOWN = 0
ACTIVE = 1
CAUSATIVE = 2
PASSIVE = 3
aspect = _messages.EnumField('AspectValueValuesEnum', 1)
case = _messages.EnumField('CaseValueValuesEnum', 2)
form = _messages.EnumField('FormValueValuesEnum', 3)
gender = _messages.EnumField('GenderValueValuesEnum', 4)
mood = _messages.EnumField('MoodValueValuesEnum', 5)
number = _messages.EnumField('NumberValueValuesEnum', 6)
person = _messages.EnumField('PersonValueValuesEnum', 7)
proper = _messages.EnumField('ProperValueValuesEnum', 8)
reciprocity = _messages.EnumField('ReciprocityValueValuesEnum', 9)
tag = _messages.EnumField('TagValueValuesEnum', 10)
tense = _messages.EnumField('TenseValueValuesEnum', 11)
voice = _messages.EnumField('VoiceValueValuesEnum', 12)
class ScanConfigError(_messages.Message):
r"""Defines a custom error message used by CreateScanConfig and
UpdateScanConfig APIs when scan configuration validation fails. It is also
reported as part of a ScanRunErrorTrace message if scan validation fails due
to a scan configuration error.
Enums:
CodeValueValuesEnum: Indicates the reason code for a configuration
failure.
Fields:
code: Indicates the reason code for a configuration failure.
fieldName: Indicates the full name of the ScanConfig field that triggers
this error, for example "scan_config.max_qps". This field is provided
for troubleshooting purposes only and its actual value can change in the
future.
"""
class CodeValueValuesEnum(_messages.Enum):
r"""Indicates the reason code for a configuration failure.
Values:
CODE_UNSPECIFIED: There is no error.
OK: There is no error.
INTERNAL_ERROR: Indicates an internal server error. Please DO NOT USE
THIS ERROR CODE unless the root cause is truly unknown.
APPENGINE_API_BACKEND_ERROR: One of the seed URLs is an App Engine URL
but we cannot validate the scan settings due to an App Engine API
backend error.
APPENGINE_API_NOT_ACCESSIBLE: One of the seed URLs is an App Engine URL
but we cannot access the App Engine API to validate scan settings.
APPENGINE_DEFAULT_HOST_MISSING: One of the seed URLs is an App Engine
URL but the Default Host of the App Engine is not set.
CANNOT_USE_GOOGLE_COM_ACCOUNT: Google corporate accounts can not be used
for scanning.
CANNOT_USE_OWNER_ACCOUNT: The account of the scan creator can not be
used for scanning.
COMPUTE_API_BACKEND_ERROR: This scan targets Compute Engine, but we
cannot validate scan settings due to a Compute Engine API backend
error.
COMPUTE_API_NOT_ACCESSIBLE: This scan targets Compute Engine, but we
cannot access the Compute Engine API to validate the scan settings.
CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT: The Custom Login
URL does not belong to the current project.
CUSTOM_LOGIN_URL_MALFORMED: The Custom Login URL is malformed (can not
be parsed).
CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS: The Custom Login URL is
mapped to a non-routable IP address in DNS.
CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS: The Custom Login URL is
mapped to an IP address which is not reserved for the current project.
CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS: The Custom Login URL has a
non-routable IP address.
CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS: The Custom Login URL has an
IP address which is not reserved for the current project.
DUPLICATE_SCAN_NAME: Another scan with the same name (case-sensitive)
already exists.
INVALID_FIELD_VALUE: A field is set to an invalid value.
FAILED_TO_AUTHENTICATE_TO_TARGET: There was an error trying to
authenticate to the scan target.
FINDING_TYPE_UNSPECIFIED: Finding type value is not specified in the
list findings request.
FORBIDDEN_TO_SCAN_COMPUTE: Scan targets Compute Engine, yet current
project was not whitelisted for Google Compute Engine Scanning Alpha
access.
FORBIDDEN_UPDATE_TO_MANAGED_SCAN: User tries to update managed scan
MALFORMED_FILTER: The supplied filter is malformed. For example, it can
not be parsed, does not have a filter type in expression, or the same
filter type appears more than once.
MALFORMED_RESOURCE_NAME: The supplied resource name is malformed (can
not be parsed).
PROJECT_INACTIVE: The current project is not in an active state.
REQUIRED_FIELD: A required field is not set.
RESOURCE_NAME_INCONSISTENT: Project id, scanconfig id, scanrun id, or
finding id are not consistent with each other in resource name.
SCAN_ALREADY_RUNNING: The scan being requested to start is already
running.
SCAN_NOT_RUNNING: The scan that was requested to be stopped is not
running.
SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT: One of the seed URLs does
not belong to the current project.
SEED_URL_MALFORMED: One of the seed URLs is malformed (can not be
parsed).
SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS: One of the seed URLs is mapped
to a non-routable IP address in DNS.
SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS: One of the seed URLs is mapped to
an IP address which is not reserved for the current project.
SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS: One of the seed URLs has on-
routable IP address.
SEED_URL_HAS_UNRESERVED_IP_ADDRESS: One of the seed URLs has an IP
address that is not reserved for the current project.
SERVICE_ACCOUNT_NOT_CONFIGURED: The Web Security Scanner service account
is not configured under the project.
TOO_MANY_SCANS: A project has reached the maximum number of scans.
UNABLE_TO_RESOLVE_PROJECT_INFO: Resolving the details of the current
project fails.
UNSUPPORTED_BLACKLIST_PATTERN_FORMAT: One or more blacklist patterns
were in the wrong format.
UNSUPPORTED_FILTER: The supplied filter is not supported.
UNSUPPORTED_FINDING_TYPE: The supplied finding type is not supported.
For example, we do not provide findings of the given finding type.
UNSUPPORTED_URL_SCHEME: The URL scheme of one or more of the supplied
URLs is not supported.
"""
CODE_UNSPECIFIED = 0
OK = 1
INTERNAL_ERROR = 2
APPENGINE_API_BACKEND_ERROR = 3
APPENGINE_API_NOT_ACCESSIBLE = 4
APPENGINE_DEFAULT_HOST_MISSING = 5
CANNOT_USE_GOOGLE_COM_ACCOUNT = 6
CANNOT_USE_OWNER_ACCOUNT = 7
COMPUTE_API_BACKEND_ERROR = 8
COMPUTE_API_NOT_ACCESSIBLE = 9
CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT = 10
CUSTOM_LOGIN_URL_MALFORMED = 11
CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS = 12
CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS = 13
CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS = 14
CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS = 15
DUPLICATE_SCAN_NAME = 16
INVALID_FIELD_VALUE = 17
FAILED_TO_AUTHENTICATE_TO_TARGET = 18
FINDING_TYPE_UNSPECIFIED = 19
FORBIDDEN_TO_SCAN_COMPUTE = 20
FORBIDDEN_UPDATE_TO_MANAGED_SCAN = 21
MALFORMED_FILTER = 22
MALFORMED_RESOURCE_NAME = 23
PROJECT_INACTIVE = 24
REQUIRED_FIELD = 25
RESOURCE_NAME_INCONSISTENT = 26
SCAN_ALREADY_RUNNING = 27
SCAN_NOT_RUNNING = 28
SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT = 29
SEED_URL_MALFORMED = 30
SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS = 31
SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS = 32
SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS = 33
SEED_URL_HAS_UNRESERVED_IP_ADDRESS = 34
SERVICE_ACCOUNT_NOT_CONFIGURED = 35
TOO_MANY_SCANS = 36
UNABLE_TO_RESOLVE_PROJECT_INFO = 37
UNSUPPORTED_BLACKLIST_PATTERN_FORMAT = 38
UNSUPPORTED_FILTER = 39
UNSUPPORTED_FINDING_TYPE = 40
UNSUPPORTED_URL_SCHEME = 41
code = _messages.EnumField('CodeValueValuesEnum', 1)
fieldName = _messages.StringField(2)
class Finding(_messages.Message):
r"""A Finding resource represents a vulnerability instance identified during
a ScanRun.
Enums:
SeverityValueValuesEnum: The severity level of the reported vulnerability.
Fields:
body: The body of the request that triggered the vulnerability.
description: The description of the vulnerability.
finalUrl: The URL where the browser lands when the vulnerability is
detected.
findingType: The type of the Finding. Detailed and up-to-date information
on findings can be found here: https://cloud.google.com/security-
command-center/docs/how-to-remediate-web-security-scanner
form: An addon containing information reported for a vulnerability with an
HTML form, if any.
frameUrl: If the vulnerability was originated from nested IFrame, the
immediate parent IFrame is reported.
fuzzedUrl: The URL produced by the server-side fuzzer and used in the
request that triggered the vulnerability.
httpMethod: The http method of the request that triggered the
vulnerability, in uppercase.
name: The resource name of the Finding. The name follows the format of 'pr
ojects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findi
ngs/{findingId}'. The finding IDs are generated by the system.
outdatedLibrary: An addon containing information about outdated libraries.
reproductionUrl: The URL containing human-readable payload that user can
leverage to reproduce the vulnerability.
severity: The severity level of the reported vulnerability.
trackingId: The tracking ID uniquely identifies a vulnerability instance
across multiple ScanRuns.
violatingResource: An addon containing detailed information regarding any
resource causing the vulnerability such as JavaScript sources, image,
audio files, etc.
vulnerableHeaders: An addon containing information about vulnerable or
missing HTTP headers.
vulnerableParameters: An addon containing information about request
parameters which were found to be vulnerable.
xss: An addon containing information reported for an XSS, if any.
"""
class SeverityValueValuesEnum(_messages.Enum):
r"""The severity level of the reported vulnerability.
Values:
SEVERITY_UNSPECIFIED: No severity specified. The default value.
CRITICAL: Critical severity.
HIGH: High severity.
MEDIUM: Medium severity.
LOW: Low severity.
"""
SEVERITY_UNSPECIFIED = 0
CRITICAL = 1
HIGH = 2
MEDIUM = 3
LOW = 4
body = _messages.StringField(1)
description = _messages.StringField(2)
finalUrl = _messages.StringField(3)
findingType = _messages.StringField(4)
form = _messages.MessageField('Form', 5)
frameUrl = _messages.StringField(6)
fuzzedUrl = _messages.StringField(7)
httpMethod = _messages.StringField(8)
name = _messages.StringField(9)
outdatedLibrary = _messages.MessageField('OutdatedLibrary', 10)
reproductionUrl = _messages.StringField(11)
severity = _messages.EnumField('SeverityValueValuesEnum', 12)
trackingId = _messages.StringField(13)
violatingResource = _messages.MessageField('ViolatingResource', 14)
vulnerableHeaders = _messages.MessageField('VulnerableHeaders', 15)
vulnerableParameters = _messages.MessageField('VulnerableParameters', 16)
xss = _messages.MessageField('Xss', 17)
class MembershipStatus(_messages.Message):
r"""Status of the Membership resource.
Enums:
CodeValueValuesEnum: Code indicating the status of the Membership
resource.
Messages:
DetailsValue: Structured information about the problem.
Fields:
code: Code indicating the status of the Membership resource.
description: Human readable description of the issue.
details: Structured information about the problem.
updateTime: The last update time of this status by the controllers
"""
class CodeValueValuesEnum(_messages.Enum):
r"""Code indicating the status of the Membership resource.
Values:
CODE_UNSPECIFIED: Not set.
CREATING: CREATING indicates the cluster is being registered.
READY: READY indicates the cluster is registered.
DELETING: DELETING indicates that the cluster is being unregistered.
UPDATING: UPDATING indicates that the cluster registration is being
updated.
"""
CODE_UNSPECIFIED = 0
CREATING = 1
READY = 2
DELETING = 3
UPDATING = 4
@encoding.MapUnrecognizedFields('additionalProperties')
class DetailsValue(_messages.Message):
r"""Structured information about the problem.
Messages:
AdditionalProperty: An additional property for a DetailsValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a DetailsValue 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)
code = _messages.EnumField('CodeValueValuesEnum', 1)
description = _messages.StringField(2)
details = _messages.MessageField('DetailsValue', 3)
updateTime = _messages.StringField(4)
class WarningValue(_messages.Message):
"""[Output Only] Informational warning message.
Enums:
CodeValueValuesEnum: [Output Only] A warning code, if applicable. For
example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no
results in the response.
Messages:
DataValueListEntry: A DataValueListEntry object.
Fields:
code: [Output Only] A warning code, if applicable. For example, Compute
Engine returns NO_RESULTS_ON_PAGE if there are no results in the
response.
data: [Output Only] Metadata about this warning in key: value format.
For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
message: [Output Only] A human-readable description of the warning code.
"""
class CodeValueValuesEnum(_messages.Enum):
"""[Output Only] A warning code, if applicable. For example, Compute
Engine returns NO_RESULTS_ON_PAGE if there are no results in the
response.
Values:
CLEANUP_FAILED: <no description>
DEPRECATED_RESOURCE_USED: <no description>
DEPRECATED_TYPE_USED: <no description>
DISK_SIZE_LARGER_THAN_IMAGE_SIZE: <no description>
EXPERIMENTAL_TYPE_USED: <no description>
EXTERNAL_API_WARNING: <no description>
FIELD_VALUE_OVERRIDEN: <no description>
INJECTED_KERNELS_DEPRECATED: <no description>
MISSING_TYPE_DEPENDENCY: <no description>
NEXT_HOP_ADDRESS_NOT_ASSIGNED: <no description>
NEXT_HOP_CANNOT_IP_FORWARD: <no description>
NEXT_HOP_INSTANCE_NOT_FOUND: <no description>
NEXT_HOP_INSTANCE_NOT_ON_NETWORK: <no description>
NEXT_HOP_NOT_RUNNING: <no description>
NOT_CRITICAL_ERROR: <no description>
NO_RESULTS_ON_PAGE: <no description>
REQUIRED_TOS_AGREEMENT: <no description>
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING: <no description>
RESOURCE_NOT_DELETED: <no description>
SCHEMA_VALIDATION_IGNORED: <no description>
SINGLE_INSTANCE_PROPERTY_TEMPLATE: <no description>
UNDECLARED_PROPERTIES: <no description>
UNREACHABLE: <no description>
"""
CLEANUP_FAILED = 0
DEPRECATED_RESOURCE_USED = 1
DEPRECATED_TYPE_USED = 2
DISK_SIZE_LARGER_THAN_IMAGE_SIZE = 3
EXPERIMENTAL_TYPE_USED = 4
EXTERNAL_API_WARNING = 5
FIELD_VALUE_OVERRIDEN = 6
INJECTED_KERNELS_DEPRECATED = 7
MISSING_TYPE_DEPENDENCY = 8
NEXT_HOP_ADDRESS_NOT_ASSIGNED = 9
NEXT_HOP_CANNOT_IP_FORWARD = 10
NEXT_HOP_INSTANCE_NOT_FOUND = 11
NEXT_HOP_INSTANCE_NOT_ON_NETWORK = 12
NEXT_HOP_NOT_RUNNING = 13
NOT_CRITICAL_ERROR = 14
NO_RESULTS_ON_PAGE = 15
REQUIRED_TOS_AGREEMENT = 16
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING = 17
RESOURCE_NOT_DELETED = 18
SCHEMA_VALIDATION_IGNORED = 19
SINGLE_INSTANCE_PROPERTY_TEMPLATE = 20
UNDECLARED_PROPERTIES = 21
UNREACHABLE = 22
class DataValueListEntry(_messages.Message):
"""A DataValueListEntry object.
Fields:
key: [Output Only] A key that provides more detail on the warning
being returned. For example, for warnings where there are no results
in a list request for a particular zone, this key might be scope and
the key value might be the zone name. Other examples might be a key
indicating a deprecated resource and a suggested replacement, or a
warning about invalid network settings (for example, if an instance
attempts to perform IP forwarding but is not enabled for IP
forwarding).
value: [Output Only] A warning data value corresponding to the key.
"""
key = _messages.StringField(1)
value = _messages.StringField(2)
code = _messages.EnumField('CodeValueValuesEnum', 1)
data = _messages.MessageField('DataValueListEntry', 2, repeated=True)
message = _messages.StringField(3)
class Instance(_messages.Message):
r"""A Google Cloud Redis instance.
Enums:
StateValueValuesEnum: Output only. The current state of this instance.
TierValueValuesEnum: Required. The service tier of the 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: * maxmemory-policy * notify-keyspace-events
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].
authorizedNetwork: Optional. The full name of the Google Compute Engine
[network](/compute/docs/networks-and-firewalls#networks) to which the
instance is connected. If left unspecified, the `default` network will
be used.
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.
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: * maxmemory-policy * notify-keyspace-events
redisVersion: Optional. The version of Redis software. If not provided,
latest supported version will be used. Updating the version will perform
an upgrade/downgrade to the new version. Currently, the supported values
are `REDIS_3_2` for Redis 3.2.
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.
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.
"""
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. Details
can be found in the `status_message` field.
MAINTENANCE: Maintenance is being performed on this Redis instance.
EXPORTING: Redis instance is exporting data.
IMPORTING: Redis instance is importing data (availability may be
affected).
"""
STATE_UNSPECIFIED = 0
CREATING = 1
READY = 2
UPDATING = 3
DELETING = 4
REPAIRING = 5
MAINTENANCE = 6
EXPORTING = 7
IMPORTING = 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
@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: * maxmemory-policy * notify-keyspace-events
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)
authorizedNetwork = _messages.StringField(2)
createTime = _messages.StringField(3)
currentLocationId = _messages.StringField(4)
displayName = _messages.StringField(5)
host = _messages.StringField(6)
labels = _messages.MessageField('LabelsValue', 7)
locationId = _messages.StringField(8)
memorySizeGb = _messages.IntegerField(9, variant=_messages.Variant.INT32)
name = _messages.StringField(10)
port = _messages.IntegerField(11, variant=_messages.Variant.INT32)
redisConfigs = _messages.MessageField('RedisConfigsValue', 12)
redisVersion = _messages.StringField(13)
reservedIpRange = _messages.StringField(14)
state = _messages.EnumField('StateValueValuesEnum', 15)
statusMessage = _messages.StringField(16)
tier = _messages.EnumField('TierValueValuesEnum', 17)
class ClouderrorreportingProjectsGroupStatsListRequest(_messages.Message):
r"""A ClouderrorreportingProjectsGroupStatsListRequest object.
Enums:
AlignmentValueValuesEnum: Optional. The alignment of the timed counts to
be returned. Default is `ALIGNMENT_EQUAL_AT_END`.
OrderValueValuesEnum: Optional. The sort order in which the results are
returned. Default is `COUNT_DESC`.
TimeRangePeriodValueValuesEnum: Restricts the query to the specified time
range.
Fields:
alignment: Optional. The alignment of the timed counts to be returned.
Default is `ALIGNMENT_EQUAL_AT_END`.
alignmentTime: Optional. Time where the timed counts shall be aligned if
rounded alignment is chosen. Default is 00:00 UTC.
groupId: Optional. List all <code>ErrorGroupStats</code> with these IDs.
order: Optional. The sort order in which the results are returned. Default
is `COUNT_DESC`.
pageSize: Optional. The maximum number of results to return per response.
Default is 20.
pageToken: Optional. A `next_page_token` provided by a previous response.
To view additional results, pass this token along with the identical
query parameters as the first request.
projectName: Required. The resource name of the Google Cloud Platform
project. Written as `projects/{projectID}`, where `{projectID}` is the
[Google Cloud Platform project
ID](https://support.google.com/cloud/answer/6158840). Example:
`projects/my-project-123`.
serviceFilter_resourceType: Optional. The exact value to match against
[`ServiceContext.resource_type`](/error-
reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).
serviceFilter_service: Optional. The exact value to match against
[`ServiceContext.service`](/error-
reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).
serviceFilter_version: Optional. The exact value to match against
[`ServiceContext.version`](/error-
reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).
timeRange_period: Restricts the query to the specified time range.
timedCountDuration: Optional. The preferred duration for a single returned
`TimedCount`. If not set, no timed counts are returned.
"""
class AlignmentValueValuesEnum(_messages.Enum):
r"""Optional. The alignment of the timed counts to be returned. Default is
`ALIGNMENT_EQUAL_AT_END`.
Values:
ERROR_COUNT_ALIGNMENT_UNSPECIFIED: <no description>
ALIGNMENT_EQUAL_ROUNDED: <no description>
ALIGNMENT_EQUAL_AT_END: <no description>
"""
ERROR_COUNT_ALIGNMENT_UNSPECIFIED = 0
ALIGNMENT_EQUAL_ROUNDED = 1
ALIGNMENT_EQUAL_AT_END = 2
class OrderValueValuesEnum(_messages.Enum):
r"""Optional. The sort order in which the results are returned. Default is
`COUNT_DESC`.
Values:
GROUP_ORDER_UNSPECIFIED: <no description>
COUNT_DESC: <no description>
LAST_SEEN_DESC: <no description>
CREATED_DESC: <no description>
AFFECTED_USERS_DESC: <no description>
"""
GROUP_ORDER_UNSPECIFIED = 0
COUNT_DESC = 1
LAST_SEEN_DESC = 2
CREATED_DESC = 3
AFFECTED_USERS_DESC = 4
class TimeRangePeriodValueValuesEnum(_messages.Enum):
r"""Restricts the query to the specified time range.
Values:
PERIOD_UNSPECIFIED: <no description>
PERIOD_1_HOUR: <no description>
PERIOD_6_HOURS: <no description>
PERIOD_1_DAY: <no description>
PERIOD_1_WEEK: <no description>
PERIOD_30_DAYS: <no description>
"""
PERIOD_UNSPECIFIED = 0
PERIOD_1_HOUR = 1
PERIOD_6_HOURS = 2
PERIOD_1_DAY = 3
PERIOD_1_WEEK = 4
PERIOD_30_DAYS = 5
alignment = _messages.EnumField('AlignmentValueValuesEnum', 1)
alignmentTime = _messages.StringField(2)
groupId = _messages.StringField(3, repeated=True)
order = _messages.EnumField('OrderValueValuesEnum', 4)
pageSize = _messages.IntegerField(5, variant=_messages.Variant.INT32)
pageToken = _messages.StringField(6)
projectName = _messages.StringField(7, required=True)
serviceFilter_resourceType = _messages.StringField(8)
serviceFilter_service = _messages.StringField(9)
serviceFilter_version = _messages.StringField(10)
timeRange_period = _messages.EnumField('TimeRangePeriodValueValuesEnum',
11)
timedCountDuration = _messages.StringField(12)
class Project(_messages.Message):
"""A Project is a high-level Google Cloud Platform entity. It is a
container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud
Platform resources.
Enums:
LifecycleStateValueValuesEnum: The Project lifecycle state. Read-only.
Messages:
LabelsValue: The labels associated with this Project. Label keys must be
between 1 and 63 characters long and must conform to the following
regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must
be between 0 and 63 characters long and must conform to the regular
expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels
can be associated with a given resource. Clients should store labels in
a representation such as JSON that does not depend on specific
characters being disallowed. Example: <code>"environment" :
"dev"</code> Read-write.
Fields:
createTime: Creation time. Read-only.
labels: The labels associated with this Project. Label keys must be
between 1 and 63 characters long and must conform to the following
regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must
be between 0 and 63 characters long and must conform to the regular
expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels
can be associated with a given resource. Clients should store labels in
a representation such as JSON that does not depend on specific
characters being disallowed. Example: <code>"environment" :
"dev"</code> Read-write.
lifecycleState: The Project lifecycle state. Read-only.
name: The user-assigned display name of the Project. It must be 4 to 30
characters. Allowed characters are: lowercase and uppercase letters,
numbers, hyphen, single-quote, double-quote, space, and exclamation
point. Example: <code>My Project</code> Read-write.
parent: An optional reference to a parent Resource. The only supported
parent type is "organization". Once set, the parent cannot be modified.
The `parent` can be set on creation or using the `UpdateProject` method;
the end user must have the `resourcemanager.projects.create` permission
on the parent. Read-write.
projectId: The unique, user-assigned ID of the Project. It must be 6 to 30
lowercase letters, digits, or hyphens. It must start with a letter.
Trailing hyphens are prohibited. Example: <code>tokyo-rain-123</code>
Read-only after creation.
projectNumber: The number uniquely identifying the project. Example:
<code>415104041262</code> Read-only.
"""
class LifecycleStateValueValuesEnum(_messages.Enum):
"""The Project lifecycle state. Read-only.
Values:
LIFECYCLE_STATE_UNSPECIFIED: Unspecified state. This is only
used/useful for distinguishing unset values.
ACTIVE: The normal and active state.
DELETE_REQUESTED: The project has been marked for deletion by the user
(by invoking DeleteProject) or by the system (Google Cloud Platform).
This can generally be reversed by invoking UndeleteProject.
DELETE_IN_PROGRESS: This lifecycle state is no longer used and is not
returned by the API.
"""
LIFECYCLE_STATE_UNSPECIFIED = 0
ACTIVE = 1
DELETE_REQUESTED = 2
DELETE_IN_PROGRESS = 3
@encoding.MapUnrecognizedFields('additionalProperties')
class LabelsValue(_messages.Message):
"""The labels associated with this Project. Label keys must be between 1
and 63 characters long and must conform to the following regular
expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be
between 0 and 63 characters long and must conform to the regular
expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 256 labels
can be associated with a given resource. Clients should store labels in a
representation such as JSON that does not depend on specific characters
being disallowed. Example: <code>"environment" : "dev"</code> Read-write.
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)
createTime = _messages.StringField(1)
labels = _messages.MessageField('LabelsValue', 2)
lifecycleState = _messages.EnumField('LifecycleStateValueValuesEnum', 3)
name = _messages.StringField(4)
parent = _messages.MessageField('ResourceId', 5)
projectId = _messages.StringField(6)
projectNumber = _messages.IntegerField(7)
class GoogleCloudBillingBudgetsV1beta1Filter(_messages.Message):
r"""A filter for a budget, limiting the scope of the cost to calculate.
Enums:
CreditTypesTreatmentValueValuesEnum: Optional. If not set, default
behavior is `INCLUDE_ALL_CREDITS`.
Messages:
LabelsValue: Optional. A single label and value pair specifying that usage
from only this set of labeled resources should be included in the
budget. Currently, multiple entries or multiple values per entry are not
allowed. If omitted, the report will include all labeled and unlabeled
usage.
Fields:
creditTypes: Optional. If Filter.credit_types_treatment is
INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be
subtracted from gross cost to determine the spend for threshold
calculations. If Filter.credit_types_treatment is **not**
INCLUDE_SPECIFIED_CREDITS, this field must be empty. See [a list of
acceptable credit type
values](https://cloud.google.com/billing/docs/how-to/export-data-
bigquery-tables#credits-type).
creditTypesTreatment: Optional. If not set, default behavior is
`INCLUDE_ALL_CREDITS`.
labels: Optional. A single label and value pair specifying that usage from
only this set of labeled resources should be included in the budget.
Currently, multiple entries or multiple values per entry are not
allowed. If omitted, the report will include all labeled and unlabeled
usage.
projects: Optional. A set of projects of the form `projects/{project}`,
specifying that usage from only this set of projects should be included
in the budget. If omitted, the report will include all usage for the
billing account, regardless of which project the usage occurred on. Only
zero or one project can be specified currently.
services: Optional. A set of services of the form `services/{service_id}`,
specifying that usage from only this set of services should be included
in the budget. If omitted, the report will include usage for all the
services. The service names are available through the Catalog API:
https://cloud.google.com/billing/v1/how-tos/catalog-api.
subaccounts: Optional. A set of subaccounts of the form
`billingAccounts/{account_id}`, specifying that usage from only this set
of subaccounts should be included in the budget. If a subaccount is set
to the name of the parent account, usage from the parent account will be
included. If omitted, the report will include usage from the parent
account and all subaccounts, if they exist.
"""
class CreditTypesTreatmentValueValuesEnum(_messages.Enum):
r"""Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.
Values:
CREDIT_TYPES_TREATMENT_UNSPECIFIED: <no description>
INCLUDE_ALL_CREDITS: All types of credit are subtracted from the gross
cost to determine the spend for threshold calculations.
EXCLUDE_ALL_CREDITS: All types of credit are added to the net cost to
determine the spend for threshold calculations.
INCLUDE_SPECIFIED_CREDITS: Credit types specified in the credit_types
field are subtracted from the gross cost to determine the spend for
threshold calculations.
"""
CREDIT_TYPES_TREATMENT_UNSPECIFIED = 0
INCLUDE_ALL_CREDITS = 1
EXCLUDE_ALL_CREDITS = 2
INCLUDE_SPECIFIED_CREDITS = 3
@encoding.MapUnrecognizedFields('additionalProperties')
class LabelsValue(_messages.Message):
r"""Optional. A single label and value pair specifying that usage from
only this set of labeled resources should be included in the budget.
Currently, multiple entries or multiple values per entry are not allowed.
If omitted, the report will include all labeled and unlabeled usage.
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 extra_types.JsonValue attribute.
"""
key = _messages.StringField(1)
value = _messages.MessageField('extra_types.JsonValue',
2,
repeated=True)
additionalProperties = _messages.MessageField('AdditionalProperty',
1,
repeated=True)
creditTypes = _messages.StringField(1, repeated=True)
creditTypesTreatment = _messages.EnumField(
'CreditTypesTreatmentValueValuesEnum', 2)
labels = _messages.MessageField('LabelsValue', 3)
projects = _messages.StringField(4, repeated=True)
services = _messages.StringField(5, repeated=True)
subaccounts = _messages.StringField(6, repeated=True)
class Policy(_messages.Message):
r"""A policy for container image binary authorization.
Enums:
GlobalPolicyEvaluationModeValueValuesEnum: Optional. Controls the
evaluation of a Google-maintained global admission policy for common
system-level images. Images not covered by the global policy will be
subject to the project admission policy. This setting has no effect when
specified inside a global admission policy.
Messages:
ClusterAdmissionRulesValue: Optional. Per-cluster admission rules. Cluster
spec format: `location.clusterId`. There can be at most one admission
rule per cluster spec. A `location` is either a compute zone (e.g. us-
central1-a) or a region (e.g. us-central1). For `clusterId` syntax
restrictions see https://cloud.google.com/container-
engine/reference/rest/v1/projects.zones.clusters.
Fields:
admissionWhitelistPatterns: Optional. Admission policy allowlisting. A
matching admission request will always be permitted. This feature is
typically used to exclude Google or third-party infrastructure images
from Binary Authorization policies.
clusterAdmissionRules: Optional. Per-cluster admission rules. Cluster spec
format: `location.clusterId`. There can be at most one admission rule
per cluster spec. A `location` is either a compute zone (e.g. us-
central1-a) or a region (e.g. us-central1). For `clusterId` syntax
restrictions see https://cloud.google.com/container-
engine/reference/rest/v1/projects.zones.clusters.
defaultAdmissionRule: Required. Default admission rule for a cluster
without a per-cluster, per- kubernetes-service-account, or per-istio-
service-identity admission rule.
description: Optional. A descriptive comment.
globalPolicyEvaluationMode: Optional. Controls the evaluation of a Google-
maintained global admission policy for common system-level images.
Images not covered by the global policy will be subject to the project
admission policy. This setting has no effect when specified inside a
global admission policy.
name: Output only. The resource name, in the format `projects/*/policy`.
There is at most one policy per project.
updateTime: Output only. Time when the policy was last updated.
"""
class GlobalPolicyEvaluationModeValueValuesEnum(_messages.Enum):
r"""Optional. Controls the evaluation of a Google-maintained global
admission policy for common system-level images. Images not covered by the
global policy will be subject to the project admission policy. This
setting has no effect when specified inside a global admission policy.
Values:
GLOBAL_POLICY_EVALUATION_MODE_UNSPECIFIED: Not specified: DISABLE is
assumed.
ENABLE: Enables global policy evaluation.
DISABLE: Disables global policy evaluation.
"""
GLOBAL_POLICY_EVALUATION_MODE_UNSPECIFIED = 0
ENABLE = 1
DISABLE = 2
@encoding.MapUnrecognizedFields('additionalProperties')
class ClusterAdmissionRulesValue(_messages.Message):
r"""Optional. Per-cluster admission rules. Cluster spec format:
`location.clusterId`. There can be at most one admission rule per cluster
spec. A `location` is either a compute zone (e.g. us-central1-a) or a
region (e.g. us-central1). For `clusterId` syntax restrictions see
https://cloud.google.com/container-
engine/reference/rest/v1/projects.zones.clusters.
Messages:
AdditionalProperty: An additional property for a
ClusterAdmissionRulesValue object.
Fields:
additionalProperties: Additional properties of type
ClusterAdmissionRulesValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a ClusterAdmissionRulesValue object.
Fields:
key: Name of the additional property.
value: A AdmissionRule attribute.
"""
key = _messages.StringField(1)
value = _messages.MessageField('AdmissionRule', 2)
additionalProperties = _messages.MessageField('AdditionalProperty',
1,
repeated=True)
admissionWhitelistPatterns = _messages.MessageField(
'AdmissionWhitelistPattern', 1, repeated=True)
clusterAdmissionRules = _messages.MessageField(
'ClusterAdmissionRulesValue', 2)
defaultAdmissionRule = _messages.MessageField('AdmissionRule', 3)
description = _messages.StringField(4)
globalPolicyEvaluationMode = _messages.EnumField(
'GlobalPolicyEvaluationModeValueValuesEnum', 5)
name = _messages.StringField(6)
updateTime = _messages.StringField(7)
class PkixPublicKey(_messages.Message):
r"""A public key in the PkixPublicKey format (see
https://tools.ietf.org/html/rfc5280#section-4.1.2.7 for details). Public
keys of this type are typically textually encoded using the PEM format.
Enums:
SignatureAlgorithmValueValuesEnum: The signature algorithm used to verify
a message against a signature using this key. These signature algorithm
must match the structure and any object identifiers encoded in
`public_key_pem` (i.e. this algorithm must match that of the public
key).
Fields:
publicKeyPem: A PEM-encoded public key, as described in
https://tools.ietf.org/html/rfc7468#section-13
signatureAlgorithm: The signature algorithm used to verify a message
against a signature using this key. These signature algorithm must match
the structure and any object identifiers encoded in `public_key_pem`
(i.e. this algorithm must match that of the public key).
"""
class SignatureAlgorithmValueValuesEnum(_messages.Enum):
r"""The signature algorithm used to verify a message against a signature
using this key. These signature algorithm must match the structure and any
object identifiers encoded in `public_key_pem` (i.e. this algorithm must
match that of the public key).
Values:
SIGNATURE_ALGORITHM_UNSPECIFIED: Not specified.
RSA_PSS_2048_SHA256: RSASSA-PSS 2048 bit key with a SHA256 digest.
RSA_PSS_3072_SHA256: RSASSA-PSS 3072 bit key with a SHA256 digest.
RSA_PSS_4096_SHA256: RSASSA-PSS 4096 bit key with a SHA256 digest.
RSA_PSS_4096_SHA512: RSASSA-PSS 4096 bit key with a SHA512 digest.
RSA_SIGN_PKCS1_2048_SHA256: RSASSA-PKCS1-v1_5 with a 2048 bit key and a
SHA256 digest.
RSA_SIGN_PKCS1_3072_SHA256: RSASSA-PKCS1-v1_5 with a 3072 bit key and a
SHA256 digest.
RSA_SIGN_PKCS1_4096_SHA256: RSASSA-PKCS1-v1_5 with a 4096 bit key and a
SHA256 digest.
RSA_SIGN_PKCS1_4096_SHA512: RSASSA-PKCS1-v1_5 with a 4096 bit key and a
SHA512 digest.
ECDSA_P256_SHA256: ECDSA on the NIST P-256 curve with a SHA256 digest.
EC_SIGN_P256_SHA256: ECDSA on the NIST P-256 curve with a SHA256 digest.
ECDSA_P384_SHA384: ECDSA on the NIST P-384 curve with a SHA384 digest.
EC_SIGN_P384_SHA384: ECDSA on the NIST P-384 curve with a SHA384 digest.
ECDSA_P521_SHA512: ECDSA on the NIST P-521 curve with a SHA512 digest.
EC_SIGN_P521_SHA512: ECDSA on the NIST P-521 curve with a SHA512 digest.
"""
SIGNATURE_ALGORITHM_UNSPECIFIED = 0
RSA_PSS_2048_SHA256 = 1
RSA_PSS_3072_SHA256 = 2
RSA_PSS_4096_SHA256 = 3
RSA_PSS_4096_SHA512 = 4
RSA_SIGN_PKCS1_2048_SHA256 = 5
RSA_SIGN_PKCS1_3072_SHA256 = 6
RSA_SIGN_PKCS1_4096_SHA256 = 7
RSA_SIGN_PKCS1_4096_SHA512 = 8
ECDSA_P256_SHA256 = 9
EC_SIGN_P256_SHA256 = 10
ECDSA_P384_SHA384 = 11
EC_SIGN_P384_SHA384 = 12
ECDSA_P521_SHA512 = 13
EC_SIGN_P521_SHA512 = 14
publicKeyPem = _messages.StringField(1)
signatureAlgorithm = _messages.EnumField(
'SignatureAlgorithmValueValuesEnum', 2)
class Condition(_messages.Message):
"""A condition to be met.
Enums:
IamValueValuesEnum: Trusted attributes supplied by the IAM system.
OpValueValuesEnum: An operator to apply the subject with.
SysValueValuesEnum: Trusted attributes supplied by any service that owns
resources and uses the IAM system for access control.
Fields:
iam: Trusted attributes supplied by the IAM system.
op: An operator to apply the subject with.
svc: Trusted attributes discharged by the service.
sys: Trusted attributes supplied by any service that owns resources and
uses the IAM system for access control.
value: DEPRECATED. Use 'values' instead.
values: The objects of the condition. This is mutually exclusive with
'value'.
"""
class IamValueValuesEnum(_messages.Enum):
"""Trusted attributes supplied by the IAM system.
Values:
NO_ATTR: Default non-attribute.
AUTHORITY: Either principal or (if present) authority selector.
ATTRIBUTION: The principal (even if an authority selector is present),
which must only be used for attribution, not authorization.
SECURITY_REALM: Any of the security realms in the IAMContext (go
/security-realms). When used with IN, the condition indicates "any of
the request's realms match one of the given values; with NOT_IN, "none
of the realms match any of the given values". It is not permitted to
grant access based on the *absence* of a realm, so realm conditions
can only be used in a "positive" context (e.g., ALLOW/IN or
DENY/NOT_IN).
APPROVER: An approver (distinct from the requester) that has authorized
this request. When used with IN, the condition indicates that one of
the approvers associated with the request matches the specified
principal, or is a member of the specified group. Approvers can only
grant additional access, and are thus only used in a strictly positive
context (e.g. ALLOW/IN or DENY/NOT_IN). See: go/rpc-security-policy-
dynamicauth.
JUSTIFICATION_TYPE: What types of justifications have been supplied with
this request. String values should match enum names from
tech.iam.JustificationType, e.g. "MANUAL_STRING". It is not permitted
to grant access based on the *absence* of a justification, so
justification conditions can only be used in a "positive" context
(e.g., ALLOW/IN or DENY/NOT_IN). Multiple justifications, e.g., a
Buganizer ID and a manually-entered reason, are normal and supported.
"""
NO_ATTR = 0
AUTHORITY = 1
ATTRIBUTION = 2
SECURITY_REALM = 3
APPROVER = 4
JUSTIFICATION_TYPE = 5
class OpValueValuesEnum(_messages.Enum):
"""An operator to apply the subject with.
Values:
NO_OP: Default no-op.
EQUALS: DEPRECATED. Use IN instead.
NOT_EQUALS: DEPRECATED. Use NOT_IN instead.
IN: The condition is true if the subject (or any element of it if it is
a set) matches any of the supplied values.
NOT_IN: The condition is true if the subject (or every element of it if
it is a set) matches none of the supplied values.
DISCHARGED: Subject is discharged
"""
NO_OP = 0
EQUALS = 1
NOT_EQUALS = 2
IN = 3
NOT_IN = 4
DISCHARGED = 5
class SysValueValuesEnum(_messages.Enum):
"""Trusted attributes supplied by any service that owns resources and uses
the IAM system for access control.
Values:
NO_ATTR: Default non-attribute type
REGION: Region of the resource
SERVICE: Service name
NAME: Resource name
IP: IP address of the caller
"""
NO_ATTR = 0
REGION = 1
SERVICE = 2
NAME = 3
IP = 4
iam = _messages.EnumField('IamValueValuesEnum', 1)
op = _messages.EnumField('OpValueValuesEnum', 2)
svc = _messages.StringField(3)
sys = _messages.EnumField('SysValueValuesEnum', 4)
value = _messages.StringField(5)
values = _messages.StringField(6, repeated=True)
class GoogleCloudSaasacceleratorManagementProvidersV1Instance(_messages.Message):
r"""Instance represents the interface for SLM services to actuate the state
of control plane resources. Example Instance in JSON, where consumer-
project=snapchat, producer-project=cloud-sql: ```json Instance: {
"name": "projects/snapchat/locations/us-east1/instances/prod-instance",
"create_time": { "seconds": 1526406431, }, "labels": { "env":
"prod", "foo": "bar" }, "state": READY, "software_versions": {
"software_update": "cloud-sql-09-28-2018", },
"maintenance_policy_names": { "UpdatePolicy":
"projects/snapchat/locations/us-east1/maintenancePolicies/prod-update-
policy", } "rollout_metadata": { "projects/cloud-
sql/locations/global/rolloutTypes/software_update": { "release":
"projects/cloud-sql/locations/global/releases/cloud-sql-09-28-2018",
"rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-
sql-09-28-2018-canary", }, "projects/cloud-
sql/locations/global/rolloutTypes/instance_restart": { "release":
"projects/cloud-sql/locations/global/releases/cloud-sql-09-20-repair",
"rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-
sql-09-20-repair-100-percent", } } "tenant_project_id": "cloud-sql-
test-tenant", "producer_metadata": { "cloud-sql-tier": "basic",
"cloud-sql-instance-size": "1G", }, "provisioned_resources": [ {
"resource-type": "compute-instance", "resource-url":
"https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-
east1-b/instances/vm-1", } ], "maintenance_schedules": {
"csa_rollout": { "start_time": { "seconds": 1526406431,
}, "end_time": { "seconds": 1535406431, }, },
"ncsa_rollout": { "start_time": { "seconds": 1526406431,
}, "end_time": { "seconds": 1535406431, }, }
}, "consumer_defined_name": "my-sql-instance1", } ```
Enums:
StateValueValuesEnum: Output only. Current lifecycle state of the resource
(e.g. if it's being created or ready to use).
Messages:
LabelsValue: Optional. Resource labels to represent user provided
metadata. Each label is a key-value pair, where both the key and the
value are arbitrary strings provided by the user.
MaintenancePolicyNamesValue: The MaintenancePolicies that have been
attached to the instance. The key must be of the type name of the oneof
policy name defined in MaintenancePolicy, and the referenced policy must
define the same policy type. For complete details of MaintenancePolicy,
please refer to go/cloud-saas-mw-ug.
MaintenanceSchedulesValue: The MaintenanceSchedule contains the scheduling
information of published maintenance schedule.
ProducerMetadataValue: Output only. Custom string attributes used
primarily to expose producer-specific information in monitoring
dashboards. See go/get-instance-metadata.
RolloutMetadataValue: The map between RolloutType and the corresponding
RolloutMetadata. This is only mutated by rollout service. For actuation
implementation, this information is pass-through for Rollout management.
Producer shall not modify by itself. For update of a single entry in
this map, the update field mask shall follow this sementics: go
/advanced-field-masks
SoftwareVersionsValue: Software versions that are used to deploy this
instance. This can be mutated by rollout services.
Fields:
consumerDefinedName: consumer_defined_name is the name that is set by the
consumer. On the other hand Name field represents system-assigned id of
an instance so consumers are not necessarily aware of it.
consumer_defined_name is used for notification/UI purposes for consumer
to recognize their instances.
createTime: Output only. Timestamp when the resource was created.
labels: Optional. Resource labels to represent user provided metadata.
Each label is a key-value pair, where both the key and the value are
arbitrary strings provided by the user.
maintenancePolicyNames: The MaintenancePolicies that have been attached to
the instance. The key must be of the type name of the oneof policy name
defined in MaintenancePolicy, and the referenced policy must define the
same policy type. For complete details of MaintenancePolicy, please
refer to go/cloud-saas-mw-ug.
maintenanceSchedules: The MaintenanceSchedule contains the scheduling
information of published maintenance schedule.
name: Unique name of the resource. It uses the form:
`projects/{project_id}/locations/{location_id}/instances/{instance_id}`
producerMetadata: Output only. Custom string attributes used primarily to
expose producer-specific information in monitoring dashboards. See go
/get-instance-metadata.
provisionedResources: Output only. The list of data plane resources
provisioned for this instance, e.g. compute VMs. See go/get-instance-
metadata.
rolloutMetadata: The map between RolloutType and the corresponding
RolloutMetadata. This is only mutated by rollout service. For actuation
implementation, this information is pass-through for Rollout management.
Producer shall not modify by itself. For update of a single entry in
this map, the update field mask shall follow this sementics: go
/advanced-field-masks
sloMetadata: Output only. SLO metadata for instance classification in the
Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for
feature description.
softwareVersions: Software versions that are used to deploy this instance.
This can be mutated by rollout services.
state: Output only. Current lifecycle state of the resource (e.g. if it's
being created or ready to use).
tenantProjectId: Output only. ID of the associated GCP tenant project. See
go/get-instance-metadata.
updateTime: Output only. Timestamp when the resource was last modified.
"""
class StateValueValuesEnum(_messages.Enum):
r"""Output only. Current lifecycle state of the resource (e.g. if it's
being created or ready to use).
Values:
STATE_UNSPECIFIED: Unspecified state.
CREATING: Instance is being created.
READY: Instance has been created and is ready to use.
UPDATING: Instance is being updated.
REPAIRING: Instance is unheathy and under repair.
DELETING: Instance is being deleted.
"""
STATE_UNSPECIFIED = 0
CREATING = 1
READY = 2
UPDATING = 3
REPAIRING = 4
DELETING = 5
@encoding.MapUnrecognizedFields('additionalProperties')
class LabelsValue(_messages.Message):
r"""Optional. Resource labels to represent user provided metadata. Each
label is a key-value pair, where both the key and the value are arbitrary
strings provided by the user.
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 MaintenancePolicyNamesValue(_messages.Message):
r"""The MaintenancePolicies that have been attached to the instance. The
key must be of the type name of the oneof policy name defined in
MaintenancePolicy, and the referenced policy must define the same policy
type. For complete details of MaintenancePolicy, please refer to go/cloud-
saas-mw-ug.
Messages:
AdditionalProperty: An additional property for a
MaintenancePolicyNamesValue object.
Fields:
additionalProperties: Additional properties of type
MaintenancePolicyNamesValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a MaintenancePolicyNamesValue 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 MaintenanceSchedulesValue(_messages.Message):
r"""The MaintenanceSchedule contains the scheduling information of
published maintenance schedule.
Messages:
AdditionalProperty: An additional property for a
MaintenanceSchedulesValue object.
Fields:
additionalProperties: Additional properties of type
MaintenanceSchedulesValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a MaintenanceSchedulesValue object.
Fields:
key: Name of the additional property.
value: A
GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule
attribute.
"""
key = _messages.StringField(1)
value = _messages.MessageField('GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule', 2)
additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
@encoding.MapUnrecognizedFields('additionalProperties')
class ProducerMetadataValue(_messages.Message):
r"""Output only. Custom string attributes used primarily to expose
producer-specific information in monitoring dashboards. See go/get-
instance-metadata.
Messages:
AdditionalProperty: An additional property for a ProducerMetadataValue
object.
Fields:
additionalProperties: Additional properties of type
ProducerMetadataValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a ProducerMetadataValue 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 RolloutMetadataValue(_messages.Message):
r"""The map between RolloutType and the corresponding RolloutMetadata.
This is only mutated by rollout service. For actuation implementation,
this information is pass-through for Rollout management. Producer shall
not modify by itself. For update of a single entry in this map, the update
field mask shall follow this sementics: go/advanced-field-masks
Messages:
AdditionalProperty: An additional property for a RolloutMetadataValue
object.
Fields:
additionalProperties: Additional properties of type RolloutMetadataValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a RolloutMetadataValue object.
Fields:
key: Name of the additional property.
value: A
GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata
attribute.
"""
key = _messages.StringField(1)
value = _messages.MessageField('GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata', 2)
additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)
@encoding.MapUnrecognizedFields('additionalProperties')
class SoftwareVersionsValue(_messages.Message):
r"""Software versions that are used to deploy this instance. This can be
mutated by rollout services.
Messages:
AdditionalProperty: An additional property for a SoftwareVersionsValue
object.
Fields:
additionalProperties: Additional properties of type
SoftwareVersionsValue
"""
class AdditionalProperty(_messages.Message):
r"""An additional property for a SoftwareVersionsValue 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)
consumerDefinedName = _messages.StringField(1)
createTime = _messages.StringField(2)
labels = _messages.MessageField('LabelsValue', 3)
maintenancePolicyNames = _messages.MessageField('MaintenancePolicyNamesValue', 4)
maintenanceSchedules = _messages.MessageField('MaintenanceSchedulesValue', 5)
name = _messages.StringField(6)
producerMetadata = _messages.MessageField('ProducerMetadataValue', 7)
provisionedResources = _messages.MessageField('GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource', 8, repeated=True)
rolloutMetadata = _messages.MessageField('RolloutMetadataValue', 9)
sloMetadata = _messages.MessageField('GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata', 10)
softwareVersions = _messages.MessageField('SoftwareVersionsValue', 11)
state = _messages.EnumField('StateValueValuesEnum', 12)
tenantProjectId = _messages.StringField(13)
updateTime = _messages.StringField(14)
class GoogleFirestoreAdminV1beta2Index(_messages.Message):
r"""Cloud Firestore indexes enable simple and complex queries against
documents in a database.
Enums:
QueryScopeValueValuesEnum: Indexes with a collection query scope specified
allow queries against a collection that is the child of a specific
document, specified at query time, and that has the same collection id.
Indexes with a collection group query scope specified allow queries
against all collections descended from a specific document, specified at
query time, and that have the same collection id as this index.
StateValueValuesEnum: Output only. The serving state of the index.
Fields:
fields: The fields supported by this index. For composite indexes, this
is always 2 or more fields. The last field entry is always for the field
path `__name__`. If, on creation, `__name__` was not specified as the
last field, it will be added automatically with the same direction as
that of the last field defined. If the final field in a composite index
is not directional, the `__name__` will be ordered ASCENDING (unless
explicitly specified). For single field indexes, this will always be
exactly one entry with a field path equal to the field path of the
associated field.
name: Output only. A server defined name for this index. The form of this
name for composite indexes will be: `projects/{project_id}/databases/{da
tabase_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}
` For single field indexes, this field will be empty.
queryScope: Indexes with a collection query scope specified allow queries
against a collection that is the child of a specific document, specified
at query time, and that has the same collection id. Indexes with a
collection group query scope specified allow queries against all
collections descended from a specific document, specified at query time,
and that have the same collection id as this index.
state: Output only. The serving state of the index.
"""
class QueryScopeValueValuesEnum(_messages.Enum):
r"""Indexes with a collection query scope specified allow queries against
a collection that is the child of a specific document, specified at query
time, and that has the same collection id. Indexes with a collection
group query scope specified allow queries against all collections
descended from a specific document, specified at query time, and that have
the same collection id as this index.
Values:
QUERY_SCOPE_UNSPECIFIED: The query scope is unspecified. Not a valid
option.
COLLECTION: Indexes with a collection query scope specified allow
queries against a collection that is the child of a specific document,
specified at query time, and that has the collection id specified by
the index.
COLLECTION_GROUP: Indexes with a collection group query scope specified
allow queries against all collections that has the collection id
specified by the index.
"""
QUERY_SCOPE_UNSPECIFIED = 0
COLLECTION = 1
COLLECTION_GROUP = 2
class StateValueValuesEnum(_messages.Enum):
r"""Output only. The serving state of the index.
Values:
STATE_UNSPECIFIED: The state is unspecified.
CREATING: The index is being created. There is an active long-running
operation for the index. The index is updated when writing a document.
Some index data may exist.
READY: The index is ready to be used. The index is updated when writing
a document. The index is fully populated from all stored documents it
applies to.
NEEDS_REPAIR: The index was being created, but something went wrong.
There is no active long-running operation for the index, and the most
recently finished long-running operation failed. The index is not
updated when writing a document. Some index data may exist. Use the
google.longrunning.Operations API to determine why the operation that
last attempted to create this index failed, then re-create the index.
"""
STATE_UNSPECIFIED = 0
CREATING = 1
READY = 2
NEEDS_REPAIR = 3
fields = _messages.MessageField('GoogleFirestoreAdminV1beta2IndexField',
1,
repeated=True)
name = _messages.StringField(2)
queryScope = _messages.EnumField('QueryScopeValueValuesEnum', 3)
state = _messages.EnumField('StateValueValuesEnum', 4)
class Instance(_messages.Message):
r"""A Cloud Filestore instance.
Enums:
StateValueValuesEnum: Output only. The instance state.
TierValueValuesEnum: The service tier of the instance.
Messages:
LabelsValue: Resource labels to represent user provided metadata.
Fields:
createTime: Output only. The time when the instance was created.
description: Optional. A description of the instance (2048 characters or
less).
etag: Server-specified ETag for the instance resource to prevent
simultaneous updates from overwriting each other.
fileShares: File system shares on the instance. For this version, only a
single file share is supported.
labels: Resource labels to represent user provided metadata.
name: Output only. The resource name of the instance, in the format
projects/{project_id}/locations/{location_id}/instances/{instance_id}.
networks: VPC networks to which the instance is connected. For this
version, only a single network is supported.
state: Output only. The instance state.
statusMessage: Output only. Additional information about the instance
state, if available.
tier: The service tier of the instance.
"""
class StateValueValuesEnum(_messages.Enum):
r"""Output only. The instance state.
Values:
STATE_UNSPECIFIED: State not set.
CREATING: The instance is being created.
READY: The instance is available for use.
REPAIRING: Work is being done on the instance. You can get further
details from the `statusMessage` field of the `Instance` resource.
DELETING: The instance is shutting down.
ERROR: The instance is experiencing an issue and might be unusable. You
can get further details from the `statusMessage` field of the
`Instance` resource.
"""
STATE_UNSPECIFIED = 0
CREATING = 1
READY = 2
REPAIRING = 3
DELETING = 4
ERROR = 5
class TierValueValuesEnum(_messages.Enum):
r"""The service tier of the instance.
Values:
TIER_UNSPECIFIED: Not set.
STANDARD: STANDARD tier.
PREMIUM: PREMIUM tier.
"""
TIER_UNSPECIFIED = 0
STANDARD = 1
PREMIUM = 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)
createTime = _messages.StringField(1)
description = _messages.StringField(2)
etag = _messages.StringField(3)
fileShares = _messages.MessageField('FileShareConfig', 4, repeated=True)
labels = _messages.MessageField('LabelsValue', 5)
name = _messages.StringField(6)
networks = _messages.MessageField('NetworkConfig', 7, repeated=True)
state = _messages.EnumField('StateValueValuesEnum', 8)
statusMessage = _messages.StringField(9)
tier = _messages.EnumField('TierValueValuesEnum', 10)
class Instance(_messages.Message):
r"""A Google Cloud Redis instance.
Enums:
ConnectModeValueValuesEnum: Optional. The connect mode of Redis instance.
If not provided, default one will be used. Current default:
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 3.2 and above: * maxmemory-policy * notify-keyspace-events
Redis 4.0 and above: * activedefrag * lfu-log-factor * lfu-decay-time
Fields:
alternativeLocationId: Optional. Only applicable to standard 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](/compute/docs/networks-and-firewalls#networks) to which the
instance is connected. If left unspecified, the `default` network will
be used.
connectMode: Optional. The connect mode of Redis instance. If not
provided, default one will be used. Current default: DIRECT_PEERING.
createTime: Output only. The time the instance was created.
currentLocationId: Output only. The current zone where the Redis endpoint
is placed. In single zone deployments, this will always be the same as
[location_id] provided by the user at creation time. In cross-zone
instances (only applicable in standard tier), this can be either
[location_id] or [alternative_location_id] and can change on 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 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 GB, up to 200GB.
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 get to 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.
persistenceConfig: Optional. Persistence configuration parameters
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 3.2 and above: * maxmemory-policy * notify-keyspace-events
Redis 4.0 and above: * activedefrag * lfu-log-factor * lfu-decay-time
redisVersion: Optional. The version of Redis software. If not provided,
latest supported version will be used. Updating the version will perform
an upgrade/downgrade to the new version. Currently, the supported values
are: * `REDIS_4_0` for Redis 4.0 compatibility * `REDIS_3_2` for Redis
3.2 compatibility (default)
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 a network.
serverCaCerts: Output only. List of server CA certificates for the
instance. The visibility of this data will be controlled by a
GetInstanceRequest.view field once CCFE support partial view of
GetInstance. https://google.aip.dev/157.
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 connect mode of Redis instance. If not provided, default
one will be used. Current default: DIRECT_PEERING.
Values:
CONNECT_MODE_UNSPECIFIED: Not set.
DIRECT_PEERING: Connect via directly peering with memorystore redis
hosted service.
PRIVATE_SERVICE_ACCESS: Connect with google via private service access
and share connection across google managed services.
"""
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. Details
can be found in the `status_message` field.
PERFORMING_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
PERFORMING_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: In-transit 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 3.2 and above: * maxmemory-policy * notify-keyspace-events
Redis 4.0 and above: * activedefrag * lfu-log-factor * lfu-decay-time
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)
persistenceConfig = _messages.MessageField('PersistenceConfig', 13)
persistenceIamIdentity = _messages.StringField(14)
port = _messages.IntegerField(15, variant=_messages.Variant.INT32)
redisConfigs = _messages.MessageField('RedisConfigsValue', 16)
redisVersion = _messages.StringField(17)
reservedIpRange = _messages.StringField(18)
serverCaCerts = _messages.MessageField('TlsCertificate', 19, repeated=True)
state = _messages.EnumField('StateValueValuesEnum', 20)
statusMessage = _messages.StringField(21)
tier = _messages.EnumField('TierValueValuesEnum', 22)
transitEncryptionMode = _messages.EnumField(
'TransitEncryptionModeValueValuesEnum', 23)
class Operation(_messages.Message):
"""An Operation resource, used to manage asynchronous API requests. (==
resource_for v1.globalOperations ==) (== resource_for beta.globalOperations
==) (== resource_for v1.regionOperations ==) (== resource_for
beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (==
resource_for beta.zoneOperations ==)
Enums:
StatusValueValuesEnum: [Output Only] The status of the operation, which
can be one of the following: PENDING, RUNNING, or DONE.
Messages:
ErrorValue: [Output Only] If errors are generated during processing of the
operation, this field will be populated.
WarningsValueListEntry: A WarningsValueListEntry object.
Fields:
clientOperationId: [Output Only] Reserved for future use.
creationTimestamp: [Deprecated] This field is deprecated.
description: [Output Only] A textual description of the operation, which
is set when the operation is created.
endTime: [Output Only] The time that this operation was completed. This
value is in RFC3339 text format.
error: [Output Only] If errors are generated during processing of the
operation, this field will be populated.
httpErrorMessage: [Output Only] If the operation fails, this field
contains the HTTP error message that was returned, such as NOT FOUND.
httpErrorStatusCode: [Output Only] If the operation fails, this field
contains the HTTP error status code that was returned. For example, a
404 means the resource was not found.
id: [Output Only] The unique identifier for the resource. This identifier
is defined by the server.
insertTime: [Output Only] The time that this operation was requested. This
value is in RFC3339 text format.
kind: [Output Only] Type of the resource. Always compute#operation for
Operation resources.
name: [Output Only] Name of the resource.
operationType: [Output Only] The type of operation, such as insert,
update, or delete, and so on.
progress: [Output Only] An optional progress indicator that ranges from 0
to 100. There is no requirement that this be linear or support any
granularity of operations. This should not be used to guess when the
operation will be complete. This number should monotonically increase as
the operation progresses.
region: [Output Only] The URL of the region where the operation resides.
Only available when performing regional operations. You must specify
this field as part of the HTTP request URL. It is not settable as a
field in the request body.
selfLink: [Output Only] Server-defined URL for the resource.
startTime: [Output Only] The time that this operation was started by the
server. This value is in RFC3339 text format.
status: [Output Only] The status of the operation, which can be one of the
following: PENDING, RUNNING, or DONE.
statusMessage: [Output Only] An optional textual description of the
current status of the operation.
targetId: [Output Only] The unique target ID, which identifies a specific
incarnation of the target resource.
targetLink: [Output Only] The URL of the resource that the operation
modifies. For operations related to creating a snapshot, this points to
the persistent disk that the snapshot was created from.
user: [Output Only] User who requested the operation, for example:
[email protected].
warnings: [Output Only] If warning messages are generated during
processing of the operation, this field will be populated.
zone: [Output Only] The URL of the zone where the operation resides. Only
available when performing per-zone operations. You must specify this
field as part of the HTTP request URL. It is not settable as a field in
the request body.
"""
class StatusValueValuesEnum(_messages.Enum):
"""[Output Only] The status of the operation, which can be one of the
following: PENDING, RUNNING, or DONE.
Values:
DONE: <no description>
PENDING: <no description>
RUNNING: <no description>
"""
DONE = 0
PENDING = 1
RUNNING = 2
class ErrorValue(_messages.Message):
"""[Output Only] If errors are generated during processing of the
operation, this field will be populated.
Messages:
ErrorsValueListEntry: A ErrorsValueListEntry object.
Fields:
errors: [Output Only] The array of errors encountered while processing
this operation.
"""
class ErrorsValueListEntry(_messages.Message):
"""A ErrorsValueListEntry object.
Fields:
code: [Output Only] The error type identifier for this error.
location: [Output Only] Indicates the field in the request that caused
the error. This property is optional.
message: [Output Only] An optional, human-readable error message.
"""
code = _messages.StringField(1)
location = _messages.StringField(2)
message = _messages.StringField(3)
errors = _messages.MessageField('ErrorsValueListEntry', 1, repeated=True)
class WarningsValueListEntry(_messages.Message):
"""A WarningsValueListEntry object.
Enums:
CodeValueValuesEnum: [Output Only] A warning code, if applicable. For
example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no
results in the response.
Messages:
DataValueListEntry: A DataValueListEntry object.
Fields:
code: [Output Only] A warning code, if applicable. For example, Compute
Engine returns NO_RESULTS_ON_PAGE if there are no results in the
response.
data: [Output Only] Metadata about this warning in key: value format.
For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
message: [Output Only] A human-readable description of the warning code.
"""
class CodeValueValuesEnum(_messages.Enum):
"""[Output Only] A warning code, if applicable. For example, Compute
Engine returns NO_RESULTS_ON_PAGE if there are no results in the
response.
Values:
CLEANUP_FAILED: <no description>
DEPRECATED_RESOURCE_USED: <no description>
DEPRECATED_TYPE_USED: <no description>
DISK_SIZE_LARGER_THAN_IMAGE_SIZE: <no description>
EXPERIMENTAL_TYPE_USED: <no description>
EXTERNAL_API_WARNING: <no description>
FIELD_VALUE_OVERRIDEN: <no description>
INJECTED_KERNELS_DEPRECATED: <no description>
MISSING_TYPE_DEPENDENCY: <no description>
NEXT_HOP_ADDRESS_NOT_ASSIGNED: <no description>
NEXT_HOP_CANNOT_IP_FORWARD: <no description>
NEXT_HOP_INSTANCE_NOT_FOUND: <no description>
NEXT_HOP_INSTANCE_NOT_ON_NETWORK: <no description>
NEXT_HOP_NOT_RUNNING: <no description>
NOT_CRITICAL_ERROR: <no description>
NO_RESULTS_ON_PAGE: <no description>
REQUIRED_TOS_AGREEMENT: <no description>
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING: <no description>
RESOURCE_NOT_DELETED: <no description>
SCHEMA_VALIDATION_IGNORED: <no description>
SINGLE_INSTANCE_PROPERTY_TEMPLATE: <no description>
UNDECLARED_PROPERTIES: <no description>
UNREACHABLE: <no description>
"""
CLEANUP_FAILED = 0
DEPRECATED_RESOURCE_USED = 1
DEPRECATED_TYPE_USED = 2
DISK_SIZE_LARGER_THAN_IMAGE_SIZE = 3
EXPERIMENTAL_TYPE_USED = 4
EXTERNAL_API_WARNING = 5
FIELD_VALUE_OVERRIDEN = 6
INJECTED_KERNELS_DEPRECATED = 7
MISSING_TYPE_DEPENDENCY = 8
NEXT_HOP_ADDRESS_NOT_ASSIGNED = 9
NEXT_HOP_CANNOT_IP_FORWARD = 10
NEXT_HOP_INSTANCE_NOT_FOUND = 11
NEXT_HOP_INSTANCE_NOT_ON_NETWORK = 12
NEXT_HOP_NOT_RUNNING = 13
NOT_CRITICAL_ERROR = 14
NO_RESULTS_ON_PAGE = 15
REQUIRED_TOS_AGREEMENT = 16
RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING = 17
RESOURCE_NOT_DELETED = 18
SCHEMA_VALIDATION_IGNORED = 19
SINGLE_INSTANCE_PROPERTY_TEMPLATE = 20
UNDECLARED_PROPERTIES = 21
UNREACHABLE = 22
class DataValueListEntry(_messages.Message):
"""A DataValueListEntry object.
Fields:
key: [Output Only] A key that provides more detail on the warning
being returned. For example, for warnings where there are no results
in a list request for a particular zone, this key might be scope and
the key value might be the zone name. Other examples might be a key
indicating a deprecated resource and a suggested replacement, or a
warning about invalid network settings (for example, if an instance
attempts to perform IP forwarding but is not enabled for IP
forwarding).
value: [Output Only] A warning data value corresponding to the key.
"""
key = _messages.StringField(1)
value = _messages.StringField(2)
code = _messages.EnumField('CodeValueValuesEnum', 1)
data = _messages.MessageField('DataValueListEntry', 2, repeated=True)
message = _messages.StringField(3)
clientOperationId = _messages.StringField(1)
creationTimestamp = _messages.StringField(2)
description = _messages.StringField(3)
endTime = _messages.StringField(4)
error = _messages.MessageField('ErrorValue', 5)
httpErrorMessage = _messages.StringField(6)
httpErrorStatusCode = _messages.IntegerField(7, variant=_messages.Variant.INT32)
id = _messages.IntegerField(8, variant=_messages.Variant.UINT64)
insertTime = _messages.StringField(9)
kind = _messages.StringField(10, default=u'clouduseraccounts#operation')
name = _messages.StringField(11)
operationType = _messages.StringField(12)
progress = _messages.IntegerField(13, variant=_messages.Variant.INT32)
region = _messages.StringField(14)
selfLink = _messages.StringField(15)
startTime = _messages.StringField(16)
status = _messages.EnumField('StatusValueValuesEnum', 17)
statusMessage = _messages.StringField(18)
targetId = _messages.IntegerField(19, variant=_messages.Variant.UINT64)
targetLink = _messages.StringField(20)
user = _messages.StringField(21)
warnings = _messages.MessageField('WarningsValueListEntry', 22, repeated=True)
zone = _messages.StringField(23)
class PersistenceConfig(_messages.Message):
r"""Configuration of the persistence functionality.
Enums:
PersistenceModeValueValuesEnum: Optional. Controls whether Persistence
features are enabled. If not provided, the existing value will be used.
RdbSnapshotPeriodValueValuesEnum: Optional. Time period for snapshot
scheduling. Snapshots will be created every period starting from the
provided snapshot start time. Example, start time of 00:00 and SIX_HOURS
snapshort period configuration will trigger snapshots every day at
00:00, 06:00, 12:00 and 18:00. If not provided TWENTY_FOUR_HOURS will be
used as default.
Fields:
persistenceMode: Optional. Controls whether Persistence features are
enabled. If not provided, the existing value will be used.
rdbSnapshotPeriod: Optional. Time period for snapshot scheduling.
Snapshots will be created every period starting from the provided
snapshot start time. Example, start time of 00:00 and SIX_HOURS
snapshort period configuration will trigger snapshots every day at
00:00, 06:00, 12:00 and 18:00. If not provided TWENTY_FOUR_HOURS will be
used as default.
rdbSnapshotStartTime: Optional. Time of the day when the snapshots are
going to be triggered. If backup is already ongoing the trigger will be
skipped. If not provided the current time will be used.
"""
class PersistenceModeValueValuesEnum(_messages.Enum):
r"""Optional. Controls whether Persistence features are enabled. If not
provided, the existing value will be used.
Values:
PERSISTENCE_MODE_UNSPECIFIED: Not set.
DISABLED: Persistence is disabled for the instance.
RDB: RDB based Persistence is enabled.
"""
PERSISTENCE_MODE_UNSPECIFIED = 0
DISABLED = 1
RDB = 2
class RdbSnapshotPeriodValueValuesEnum(_messages.Enum):
r"""Optional. Time period for snapshot scheduling. Snapshots will be
created every period starting from the provided snapshot start time.
Example, start time of 00:00 and SIX_HOURS snapshort period configuration
will trigger snapshots every day at 00:00, 06:00, 12:00 and 18:00. If not
provided TWENTY_FOUR_HOURS will be used as default.
Values:
SNAPSHOT_PERIOD_UNSPECIFIED: Not set.
FIFTEEN_MINUTES: Snapshot every 15 minutes.
THIRTY_MINUTES: Snapshot every 30 minutes.
ONE_HOUR: Snapshot every 1 hour.
SIX_HOURS: Snapshot every 6 hours.
TWELVE_HOURS: Snapshot every 12 hours.
TWENTY_FOUR_HOURS: Snapshot every 24 horus.
"""
SNAPSHOT_PERIOD_UNSPECIFIED = 0
FIFTEEN_MINUTES = 1
THIRTY_MINUTES = 2
ONE_HOUR = 3
SIX_HOURS = 4
TWELVE_HOURS = 5
TWENTY_FOUR_HOURS = 6
persistenceMode = _messages.EnumField('PersistenceModeValueValuesEnum', 1)
rdbSnapshotPeriod = _messages.EnumField('RdbSnapshotPeriodValueValuesEnum',
2)
rdbSnapshotStartTime = _messages.MessageField('TimeOfDay', 3)
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 GoogleCloudDatacatalogV1beta1Entry(_messages.Message):
r"""Entry Metadata. A Data Catalog Entry resource represents another
resource in Google Cloud Platform, such as a BigQuery dataset or a Cloud
Pub/Sub topic. Clients can use the `linked_resource` field in the Entry
resource to refer to the original resource ID of the source system. An
Entry resource contains resource details, such as its schema. An Entry can
also be used to attach flexible metadata, such as a Tag.
Enums:
TypeValueValuesEnum: The type of the entry.
Fields:
bigqueryDateShardedSpec: Specification for a group of BigQuery tables with
name pattern `[prefix]YYYYMMDD`. Context:
https://cloud.google.com/bigquery/docs/partitioned-
tables#partitioning_versus_sharding.
bigqueryTableSpec: Specification that applies to a BigQuery table. This is
only valid on entries of type `TABLE`.
description: Optional. Entry description, which can consist of several
sentences or paragraphs that describe entry contents. Default value is
an empty string.
displayName: Optional. Display information such as title and description.
A short name to identify the entry, for example, "Analytics Data - Jan
2011". Default value is an empty string.
linkedResource: Output only. The resource this metadata entry refers to.
For Google Cloud Platform resources, `linked_resource` is the [full name
of the resource](https://cloud.google.com/apis/design/resource_names#ful
l_resource_name). For example, the `linked_resource` for a table
resource from BigQuery is: * //bigquery.googleapis.com/projects/project
Id/datasets/datasetId/tables/tableId
name: Required when used in UpdateEntryRequest. The Data Catalog resource
name of the entry in URL format. Example: * projects/{project_id}/locat
ions/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note
that this Entry and its child resources may not actually be stored in
the location in this name.
schema: Optional. Schema of the entry. An entry might not have any schema
attached to it.
sourceSystemTimestamps: Output only. Timestamps about the underlying
Google Cloud Platform resource -- not about this Data Catalog Entry.
type: The type of the entry.
"""
class TypeValueValuesEnum(_messages.Enum):
r"""The type of the entry.
Values:
ENTRY_TYPE_UNSPECIFIED: Default unknown type
TABLE: Output only. The type of entry that has a GoogleSQL schema,
including logical views.
DATA_STREAM: Output only. An entry type which is used for streaming
entries. Example: Cloud Pub/Sub topic.
"""
ENTRY_TYPE_UNSPECIFIED = 0
TABLE = 1
DATA_STREAM = 2
bigqueryDateShardedSpec = _messages.MessageField('GoogleCloudDatacatalogV1beta1BigQueryDateShardedSpec', 1)
bigqueryTableSpec = _messages.MessageField('GoogleCloudDatacatalogV1beta1BigQueryTableSpec', 2)
description = _messages.StringField(3)
displayName = _messages.StringField(4)
linkedResource = _messages.StringField(5)
name = _messages.StringField(6)
schema = _messages.MessageField('GoogleCloudDatacatalogV1beta1Schema', 7)
sourceSystemTimestamps = _messages.MessageField('GoogleCloudDatacatalogV1beta1SystemTimestamps', 8)
type = _messages.EnumField('TypeValueValuesEnum', 9)
class ScanRun(_messages.Message):
r"""A ScanRun is a output-only resource representing an actual run of the
scan. Next id: 12
Enums:
ExecutionStateValueValuesEnum: The execution state of the ScanRun.
ResultStateValueValuesEnum: The result state of the ScanRun. This field is
only available after the execution state reaches "FINISHED".
Fields:
endTime: The time at which the ScanRun reached termination state - that
the ScanRun is either finished or stopped by user.
errorTrace: If result_state is an ERROR, this field provides the primary
reason for scan's termination and more details, if such are available.
executionState: The execution state of the ScanRun.
hasVulnerabilities: Whether the scan run has found any vulnerabilities.
name: 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: 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: The result state of the ScanRun. This field is only available
after the execution state reaches "FINISHED".
startTime: The time at which the ScanRun started.
urlsCrawledCount: 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: 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: A list of warnings, if such are encountered during this
scan run.
"""
class ExecutionStateValueValuesEnum(_messages.Enum):
r"""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"""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 Node(_messages.Message):
r"""A TPU instance.
Enums:
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: The type of hardware accelerators associated with this
node. Required.
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.
name: Output only. The immutable 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.
port: Output only. DEPRECATED! Use network_endpoints instead. The network
port for the TPU Node as visible to Compute Engine instances.
schedulingConfig: A SchedulingConfig attribute.
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.
tensorflowVersion: The version of Tensorflow running in the Node.
Required.
"""
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 and is fully usable.
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)
cidrBlock = _messages.StringField(2)
createTime = _messages.StringField(3)
description = _messages.StringField(4)
health = _messages.EnumField('HealthValueValuesEnum', 5)
healthDescription = _messages.StringField(6)
ipAddress = _messages.StringField(7)
labels = _messages.MessageField('LabelsValue', 8)
name = _messages.StringField(9)
network = _messages.StringField(10)
networkEndpoints = _messages.MessageField('NetworkEndpoint', 11, repeated=True)
port = _messages.StringField(12)
schedulingConfig = _messages.MessageField('SchedulingConfig', 13)
serviceAccount = _messages.StringField(14)
state = _messages.EnumField('StateValueValuesEnum', 15)
tensorflowVersion = _messages.StringField(16)
class Condition(_messages.Message):
r"""A condition to be met.
Enums:
IamValueValuesEnum: Trusted attributes supplied by the IAM system.
OpValueValuesEnum: An operator to apply the subject with.
SysValueValuesEnum: Trusted attributes supplied by any service that owns
resources and uses the IAM system for access control.
Fields:
iam: Trusted attributes supplied by the IAM system.
op: An operator to apply the subject with.
svc: Trusted attributes discharged by the service.
sys: Trusted attributes supplied by any service that owns resources and
uses the IAM system for access control.
value: DEPRECATED. Use 'values' instead.
values: The objects of the condition. This is mutually exclusive with
'value'.
"""
class IamValueValuesEnum(_messages.Enum):
r"""Trusted attributes supplied by the IAM system.
Values:
NO_ATTR: Default non-attribute.
AUTHORITY: Either principal or (if present) authority
ATTRIBUTION: selector Always the original principal, but making clear
"""
NO_ATTR = 0
AUTHORITY = 1
ATTRIBUTION = 2
class OpValueValuesEnum(_messages.Enum):
r"""An operator to apply the subject with.
Values:
NO_OP: Default no-op.
EQUALS: DEPRECATED. Use IN instead.
NOT_EQUALS: DEPRECATED. Use NOT_IN instead.
IN: Set-inclusion check.
NOT_IN: Set-exclusion check.
DISCHARGED: Subject is discharged
"""
NO_OP = 0
EQUALS = 1
NOT_EQUALS = 2
IN = 3
NOT_IN = 4
DISCHARGED = 5
class SysValueValuesEnum(_messages.Enum):
r"""Trusted attributes supplied by any service that owns resources and
uses the IAM system for access control.
Values:
NO_ATTR: Default non-attribute type
REGION: Region of the resource
SERVICE: Service name
NAME: Resource name
IP: IP address of the caller
"""
NO_ATTR = 0
REGION = 1
SERVICE = 2
NAME = 3
IP = 4
iam = _messages.EnumField('IamValueValuesEnum', 1)
op = _messages.EnumField('OpValueValuesEnum', 2)
svc = _messages.StringField(3)
sys = _messages.EnumField('SysValueValuesEnum', 4)
value = _messages.StringField(5)
values = _messages.StringField(6, repeated=True)
class CryptoKey(_messages.Message):
r"""A CryptoKey represents a logical key that can be used for cryptographic
operations. A CryptoKey is made up of one or more versions, which represent
the actual key material used in cryptographic operations.
Enums:
PurposeValueValuesEnum: The immutable purpose of this CryptoKey.
Currently, the only acceptable purpose is ENCRYPT_DECRYPT.
Messages:
LabelsValue: Labels with user-defined metadata. For more information, see
[Labeling Keys](/kms/docs/labeling-keys).
Fields:
createTime: Output only. The time at which this CryptoKey was created.
labels: Labels with user-defined metadata. For more information, see
[Labeling Keys](/kms/docs/labeling-keys).
name: Output only. The resource name for this CryptoKey in the format
`projects/*/locations/*/keyRings/*/cryptoKeys/*`.
nextRotationTime: At next_rotation_time, the Key Management Service will
automatically: 1. Create a new version of this CryptoKey. 2. Mark the
new version as primary. Key rotations performed manually via
CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect
next_rotation_time.
primary: Output only. A copy of the "primary" CryptoKeyVersion that will
be used by Encrypt when this CryptoKey is given in EncryptRequest.name.
The CryptoKey's primary version can be updated via
UpdateCryptoKeyPrimaryVersion.
purpose: The immutable purpose of this CryptoKey. Currently, the only
acceptable purpose is ENCRYPT_DECRYPT.
rotationPeriod: next_rotation_time will be advanced by this period when
the service automatically rotates a key. Must be at least one day. If
rotation_period is set, next_rotation_time must also be set.
"""
class PurposeValueValuesEnum(_messages.Enum):
r"""The immutable purpose of this CryptoKey. Currently, the only
acceptable purpose is ENCRYPT_DECRYPT.
Values:
CRYPTO_KEY_PURPOSE_UNSPECIFIED: Not specified.
ENCRYPT_DECRYPT: CryptoKeys with this purpose may be used with Encrypt
and Decrypt.
"""
CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0
ENCRYPT_DECRYPT = 1
@encoding.MapUnrecognizedFields('additionalProperties')
class LabelsValue(_messages.Message):
r"""Labels with user-defined metadata. For more information, see [Labeling
Keys](/kms/docs/labeling-keys).
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)
createTime = _messages.StringField(1)
labels = _messages.MessageField('LabelsValue', 2)
name = _messages.StringField(3)
nextRotationTime = _messages.StringField(4)
primary = _messages.MessageField('CryptoKeyVersion', 5)
purpose = _messages.EnumField('PurposeValueValuesEnum', 6)
rotationPeriod = _messages.StringField(7)
class Entity(_messages.Message):
"""Represents a phrase in the text that is a known entity, such as a person,
an organization, or location. The API associates information, such as
salience and mentions, with entities.
Enums:
TypeValueValuesEnum: The entity type.
Messages:
MetadataValue: Metadata associated with the entity. Currently, Wikipedia
URLs and Knowledge Graph MIDs are provided, if available. The associated
keys are "wikipedia_url" and "mid", respectively.
Fields:
mentions: The mentions of this entity in the input document. The API
currently supports proper noun mentions.
metadata: Metadata associated with the entity. Currently, Wikipedia URLs
and Knowledge Graph MIDs are provided, if available. The associated keys
are "wikipedia_url" and "mid", respectively.
name: The representative name for the entity.
salience: The salience score associated with the entity in the [0, 1.0]
range. The salience score for an entity provides information about the
importance or centrality of that entity to the entire document text.
Scores closer to 0 are less salient, while scores closer to 1.0 are
highly salient.
type: The entity type.
"""
class TypeValueValuesEnum(_messages.Enum):
"""The entity type.
Values:
UNKNOWN: Unknown
PERSON: Person
LOCATION: Location
ORGANIZATION: Organization
EVENT: Event
WORK_OF_ART: Work of art
CONSUMER_GOOD: Consumer goods
OTHER: Other types
"""
UNKNOWN = 0
PERSON = 1
LOCATION = 2
ORGANIZATION = 3
EVENT = 4
WORK_OF_ART = 5
CONSUMER_GOOD = 6
OTHER = 7
@encoding.MapUnrecognizedFields('additionalProperties')
class MetadataValue(_messages.Message):
"""Metadata associated with the entity. Currently, Wikipedia URLs and
Knowledge Graph MIDs are provided, if available. The associated keys are
"wikipedia_url" and "mid", respectively.
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)
mentions = _messages.MessageField('EntityMention', 1, repeated=True)
metadata = _messages.MessageField('MetadataValue', 2)
name = _messages.StringField(3)
salience = _messages.FloatField(4, variant=_messages.Variant.FLOAT)
type = _messages.EnumField('TypeValueValuesEnum', 5)
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 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 Build(_messages.Message):
"""A build resource in the Container Builder API. At a high level, a Build
describes where to find source code, how to build it (for example, the
builder image to run on the source), and what tag to apply to the built
image when it is pushed to Google Container Registry. Fields can include
the following variables which will be expanded when the build is created: -
$PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID
of the build. - $REPO_NAME: the source repository name specified by
RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. -
$TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or
$COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the
specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or
$COMMIT_SHA.
Enums:
StatusValueValuesEnum: Status of the build. @OutputOnly
Messages:
SubstitutionsValue: Substitutions data for Build resource.
Fields:
buildTriggerId: The ID of the BuildTrigger that triggered this build, if
it was triggered automatically. @OutputOnly
createTime: Time at which the request to create the build was received.
@OutputOnly
finishTime: Time at which execution of the build was finished. The
difference between finish_time and start_time is the duration of the
build's execution. @OutputOnly
id: Unique identifier of the build. @OutputOnly
images: A list of images to be pushed upon the successful completion of
all build steps. The images will be pushed using the builder service
account's credentials. The digests of the pushed images will be stored
in the Build resource's results field. If any of the images fail to be
pushed, the build is marked FAILURE.
logUrl: URL to logs for this build in Google Cloud Logging. @OutputOnly
logsBucket: Google Cloud Storage bucket where logs should be written (see
[Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-
naming#requirements)). Logs file names will be of the format
`${logs_bucket}/log-${build_id}.txt`.
options: Special options for this build.
projectId: ID of the project. @OutputOnly.
results: Results of the build. @OutputOnly
secrets: Secrets to decrypt using Cloud KMS.
source: Describes where to find the source files to build.
sourceProvenance: A permanent fixed identifier for source. @OutputOnly
startTime: Time at which execution of the build was started. @OutputOnly
status: Status of the build. @OutputOnly
statusDetail: Customer-readable message about the current status.
@OutputOnly
steps: Describes the operations to be performed on the workspace.
substitutions: Substitutions data for Build resource.
tags: Tags for annotation of a Build. These are not docker tags.
timeout: Amount of time that this build should be allowed to run, to
second granularity. If this amount of time elapses, work on the build
will cease and the build status will be TIMEOUT. Default time is ten
minutes.
"""
class StatusValueValuesEnum(_messages.Enum):
"""Status of the build. @OutputOnly
Values:
STATUS_UNKNOWN: Status of the build is unknown.
QUEUED: Build is queued; work has not yet begun.
WORKING: Build is being executed.
SUCCESS: Build finished successfully.
FAILURE: Build failed to complete successfully.
INTERNAL_ERROR: Build failed due to an internal cause.
TIMEOUT: Build took longer than was allowed.
CANCELLED: Build was canceled by a user.
"""
STATUS_UNKNOWN = 0
QUEUED = 1
WORKING = 2
SUCCESS = 3
FAILURE = 4
INTERNAL_ERROR = 5
TIMEOUT = 6
CANCELLED = 7
@encoding.MapUnrecognizedFields('additionalProperties')
class SubstitutionsValue(_messages.Message):
"""Substitutions data for Build resource.
Messages:
AdditionalProperty: An additional property for a SubstitutionsValue
object.
Fields:
additionalProperties: Additional properties of type SubstitutionsValue
"""
class AdditionalProperty(_messages.Message):
"""An additional property for a SubstitutionsValue 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)
buildTriggerId = _messages.StringField(1)
createTime = _messages.StringField(2)
finishTime = _messages.StringField(3)
id = _messages.StringField(4)
images = _messages.StringField(5, repeated=True)
logUrl = _messages.StringField(6)
logsBucket = _messages.StringField(7)
options = _messages.MessageField('BuildOptions', 8)
projectId = _messages.StringField(9)
results = _messages.MessageField('Results', 10)
secrets = _messages.MessageField('Secret', 11, repeated=True)
source = _messages.MessageField('Source', 12)
sourceProvenance = _messages.MessageField('SourceProvenance', 13)
startTime = _messages.StringField(14)
status = _messages.EnumField('StatusValueValuesEnum', 15)
statusDetail = _messages.StringField(16)
steps = _messages.MessageField('BuildStep', 17, repeated=True)
substitutions = _messages.MessageField('SubstitutionsValue', 18)
tags = _messages.StringField(19, repeated=True)
timeout = _messages.StringField(20)
