chore: regens API reference docs (#889)
diff --git a/docs/dyn/dlp_v2.projects.image.html b/docs/dyn/dlp_v2.projects.image.html
index a7defea..7c08870 100644
--- a/docs/dyn/dlp_v2.projects.image.html
+++ b/docs/dyn/dlp_v2.projects.image.html
@@ -75,11 +75,11 @@
<h1><a href="dlp_v2.html">Cloud Data Loss Prevention (DLP) API</a> . <a href="dlp_v2.projects.html">projects</a> . <a href="dlp_v2.projects.image.html">image</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#redact">redact(parent, body, x__xgafv=None)</a></code></p>
+ <code><a href="#redact">redact(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Redacts potentially sensitive info from an image.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="redact">redact(parent, body, x__xgafv=None)</code>
+ <code class="details" id="redact">redact(parent, body=None, x__xgafv=None)</code>
<pre>Redacts potentially sensitive info from an image.
This method has limits on input size, processing time, and output size.
See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to
@@ -91,11 +91,14 @@
Args:
parent: string, The parent resource name, for example projects/my-project-id. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request to search for potentially sensitive info in an image and redact it
# by covering it with a colored rectangle.
+ "locationId": "A String", # The geographic location to process the request. Reserved for future
+ # extensions.
+ # Location is restricted to 'global', 'us', 'asia', and 'europe'.
"byteItem": { # Container for bytes to inspect or redact. # The content must be PNG, JPEG, SVG or BMP.
"type": "A String", # The type of data stored in the bytes string. Default will be TEXT_UTF8.
"data": "A String", # Content data to inspect or redact.
@@ -104,7 +107,7 @@
# When used with redactContent only info_types and min_likelihood are currently
# used.
"excludeInfoTypes": True or False, # When true, excludes type information of the findings.
- "limits": {
+ "limits": { # Configuration to control the number of findings returned. # Configuration to control the number of findings returned.
"maxFindingsPerRequest": 42, # Max number of findings that will be returned per request/job.
# When set within `InspectContentRequest`, the maximum returned is 2000
# regardless if this is set higher.
@@ -119,13 +122,13 @@
# creating a CustomInfoType, or one of the names listed
# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying
# a built-in type. InfoType names should conform to the pattern
- # [a-zA-Z0-9_]{1,64}.
+ # `[a-zA-Z0-9_]{1,64}`.
},
"maxFindings": 42, # Max findings limit for the given infoType.
},
],
"maxFindingsPerItem": 42, # Max number of findings that will be returned for each item scanned.
- # When set within `InspectDataSourceRequest`,
+ # When set within `InspectJobConfig`,
# the maximum returned is 2000 regardless if this is set higher.
# When set within `InspectContentRequest`, this field is ignored.
},
@@ -165,7 +168,7 @@
# creating a CustomInfoType, or one of the names listed
# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying
# a built-in type. InfoType names should conform to the pattern
- # [a-zA-Z0-9_]{1,64}.
+ # `[a-zA-Z0-9_]{1,64}`.
},
"dictionary": { # Custom information type based on a dictionary of words or phrases. This can # A list of phrases to detect as a CustomInfoType.
# be used to match sensitive information specific to the data, such as a list
@@ -229,8 +232,8 @@
# a company office using the hotword regex "\(xxx\)", where "xxx"
# is the area code in question.
# rule.
- "windowAfter": 42, # Number of characters after the finding to consider.
"windowBefore": 42, # Number of characters before the finding to consider.
+ "windowAfter": 42, # Number of characters after the finding to consider.
},
"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.
"pattern": "A String", # Pattern defining the regular expression. Its syntax
@@ -284,8 +287,8 @@
# a company office using the hotword regex "\(xxx\)", where "xxx"
# is the area code in question.
# rule.
- "windowAfter": 42, # Number of characters after the finding to consider.
"windowBefore": 42, # Number of characters before the finding to consider.
+ "windowAfter": 42, # Number of characters after the finding to consider.
},
"hotwordRegex": { # Message defining a custom regular expression. # Regular expression pattern defining what qualifies as a hotword.
"pattern": "A String", # Pattern defining the regular expression. Its syntax
@@ -334,7 +337,7 @@
# creating a CustomInfoType, or one of the names listed
# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying
# a built-in type. InfoType names should conform to the pattern
- # [a-zA-Z0-9_]{1,64}.
+ # `[a-zA-Z0-9_]{1,64}`.
},
],
},
@@ -384,7 +387,7 @@
# creating a CustomInfoType, or one of the names listed
# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying
# a built-in type. InfoType names should conform to the pattern
- # [a-zA-Z0-9_]{1,64}.
+ # `[a-zA-Z0-9_]{1,64}`.
},
],
},
@@ -401,16 +404,15 @@
# system may automatically choose what detectors to run. By default this may
# be all types, but may change over time as detectors are updated.
#
- # The special InfoType name "ALL_BASIC" can be used to trigger all detectors,
- # but may change over time as new InfoTypes are added. If you need precise
- # control and predictability as to what detectors are run you should specify
- # specific InfoTypes listed in the reference.
+ # If you need precise control and predictability as to what detectors are
+ # run you should specify specific InfoTypes listed in the reference,
+ # otherwise a default list will be used, which may change over time.
{ # Type of information detected by the API.
"name": "A String", # Name of the information type. Either a name of your choosing when
# creating a CustomInfoType, or one of the names listed
# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying
# a built-in type. InfoType names should conform to the pattern
- # [a-zA-Z0-9_]{1,64}.
+ # `[a-zA-Z0-9_]{1,64}`.
},
],
},
@@ -426,7 +428,7 @@
# creating a CustomInfoType, or one of the names listed
# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying
# a built-in type. InfoType names should conform to the pattern
- # [a-zA-Z0-9_]{1,64}.
+ # `[a-zA-Z0-9_]{1,64}`.
},
"redactAllText": True or False, # If true, all text found in the image, regardless whether it matches an
# info_type, is redacted. Only one should be provided.
@@ -467,25 +469,40 @@
# creating a CustomInfoType, or one of the names listed
# at https://cloud.google.com/dlp/docs/infotypes-reference when specifying
# a built-in type. InfoType names should conform to the pattern
- # [a-zA-Z0-9_]{1,64}.
+ # `[a-zA-Z0-9_]{1,64}`.
},
+ "name": "A String", # Resource name in format
+ # projects/{project}/locations/{location}/findings/{finding} Populated only
+ # when viewing persisted findings.
"quote": "A String", # The content that was found. Even if the content is not textual, it
# may be converted to a textual representation here.
# Provided if `include_quote` is true and the finding is
# less than or equal to 4096 bytes long. If the finding exceeds 4096 bytes
# in length, the quote may be omitted.
+ "labels": { # The labels associated with this `Finding`.
+ #
+ # 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 10 labels can be associated with a given finding.
+ #
+ # Examples:
+ # * `"environment" : "production"`
+ # * `"pipeline" : "etl"`
+ "a_key": "A String",
+ },
+ "jobName": "A String", # The job that stored the finding.
"quoteInfo": { # Message for infoType-dependent details parsed from quote. # Contains data parsed from quotes. Only populated if include_quote was set
# to true and a supported infoType was requested. Currently supported
# infoTypes: DATE, DATE_OF_BIRTH and TIME.
"dateTime": { # Message for a date time object. # The date time indicated by the quote.
# e.g. 2018-01-01, 5th August.
- "dayOfWeek": "A String",
- "timeZone": {
- "offsetMinutes": 42, # Set only if the offset can be determined. Positive for time ahead of UTC.
- # E.g. For "UTC-9", this value is -540.
- },
- "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # One or more of the following must be set. All fields are optional, but
- # when set must be valid date or time values.
+ "dayOfWeek": "A String", # Day of week
+ "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # One or more of the following must be set.
+ # Must be a valid date or time value.
# and time zone are either specified elsewhere or are not significant. The date
# is relative to the Proleptic Gregorian Calendar. This can represent:
#
@@ -495,15 +512,19 @@
# * A year and month value, with a zero day, e.g. a credit card expiration date
#
# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
+ "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
+ # month and day.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year by itself or a year and month where the day is not
# significant.
- "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
- # month and day.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
},
- "time": { # Represents a time of day. The date and time zone are either not significant
+ "timeZone": { # Time zone of the date time object. # Time zone
+ "offsetMinutes": 42, # Set only if the offset can be determined. Positive for time ahead of UTC.
+ # E.g. For "UTC-9", this value is -540.
+ },
+ "time": { # Represents a time of day. The date and time zone are either not significant # Time of day
# or are specified elsewhere. An API may choose to allow leap seconds. Related
# types are google.type.Date and `google.protobuf.Timestamp`.
"hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
@@ -515,34 +536,62 @@
},
},
},
+ "jobCreateTime": "A String", # Time the job started that produced this finding.
"location": { # Specifies the location of the finding. # Where the content was found.
- "byteRange": { # Generic half-open interval [start, end) # Zero-based byte offsets delimiting the finding.
- # These are relative to the finding's containing element.
- # Note that when the content is not textual, this references
- # the UTF-8 encoded textual representation of the content.
- # Omitted if content is an image.
- "start": "A String", # Index of the first character of the range (inclusive).
- "end": "A String", # Index of the last character of the range (exclusive).
- },
"codepointRange": { # Generic half-open interval [start, end) # Unicode character offsets delimiting the finding.
# These are relative to the finding's containing element.
# Provided when the content is text.
"start": "A String", # Index of the first character of the range (inclusive).
"end": "A String", # Index of the last character of the range (exclusive).
},
+ "container": { # Represents a container that may contain DLP findings. # Information about the container where this finding occurred, if available.
+ # Examples of a container include a file, table, or database record.
+ "updateTime": "A String", # Findings container modification timestamp, if applicable.
+ # For Google Cloud Storage contains last file modification timestamp.
+ # For BigQuery table contains last_modified_time property.
+ # For Datastore - not populated.
+ "relativePath": "A String", # The rest of the path after the root.
+ # Examples:
+ # - For BigQuery table `project_id:dataset_id.table_id`, the relative path is
+ # `table_id`
+ # - Google Cloud Storage file `gs://bucket/folder/filename.txt`, the relative
+ # path is `folder/filename.txt`
+ "rootPath": "A String", # The root of the container.
+ # Examples:
+ # - For BigQuery table `project_id:dataset_id.table_id`, the root is
+ # `dataset_id`
+ # - For Google Cloud Storage file `gs://bucket/folder/filename.txt`, the root
+ # is `gs://bucket`
+ "version": "A String", # Findings container version, if available
+ # ("generation" for Google Cloud Storage).
+ "projectId": "A String", # Project where the finding was found.
+ # Can be different from the project that owns the finding.
+ "fullPath": "A String", # A string representation of the full container name.
+ # Examples:
+ # - BigQuery: 'Project:DataSetId.TableId'
+ # - Google Cloud Storage: 'gs://Bucket/folders/filename.txt'
+ "type": "A String", # Container type, for example BigQuery or Google Cloud Storage.
+ },
"contentLocations": [ # List of nested objects pointing to the precise location of the finding
# within the file or record.
- { # Findings container location data.
+ { # Precise location of the finding within a document, record, image, or metadata
+ # container.
"containerName": "A String", # Name of the container where the finding is located.
# The top level name is the source file name or table name. Names of some
# common storage containers are formatted as follows:
#
- # * BigQuery tables: `<project_id>:<dataset_id>.<table_id>`
- # * Cloud Storage files: `gs://<bucket>/<path>`
- # * Datastore namespace: <namespace>
+ # * BigQuery tables: `{project_id}:{dataset_id}.{table_id}`
+ # * Cloud Storage files: `gs://{bucket}/{path}`
+ # * Datastore namespace: {namespace}
#
# Nested names could be absent if the embedded object has no string
# identifier (for an example an image contained within a document).
+ "metadataLocation": { # Metadata Location # Location within the metadata for inspected content.
+ "type": "A String", # Type of metadata containing the finding.
+ "storageLabel": { # Storage metadata label to indicate which metadata entry contains findings. # Storage metadata.
+ "key": "A String",
+ },
+ },
"containerVersion": "A String", # Findings container version, if available
# ("generation" for Google Cloud Storage).
"containerTimestamp": "A String", # Findings container modification timestamp, if applicable.
@@ -564,29 +613,37 @@
],
},
"recordLocation": { # Location of a finding within a row or record. # Location within a row or record of a database table.
+ "tableLocation": { # Location of a finding within a table. # Location within a `ContentItem.Table`.
+ "rowIndex": "A String", # The zero-based index of the row where the finding is located. Only
+ # populated for resources that have a natural ordering, not BigQuery. In
+ # BigQuery, to identify the row a finding came from, populate
+ # BigQueryOptions.identifying_fields with your primary key column names and
+ # when you store the findings the value of those columns will be stored
+ # inside of Finding.
+ },
"fieldId": { # General identifier of a data field in a storage service. # Field id of the field containing the finding.
"name": "A String", # Name describing the field.
},
- "tableLocation": { # Location of a finding within a table. # Location within a `ContentItem.Table`.
- "rowIndex": "A String", # The zero-based index of the row where the finding is located.
- },
"recordKey": { # Message for a unique key indicating a record that contains a finding. # Key of the finding.
"bigQueryKey": { # Row key for identifying a record in BigQuery table.
"tableReference": { # Message defining the location of a BigQuery table. A table is uniquely # Complete BigQuery table reference.
# identified by its project_id, dataset_id, and table_name. Within a query
# a table is often referenced with a string in the format of:
- # `<project_id>:<dataset_id>.<table_id>` or
- # `<project_id>.<dataset_id>.<table_id>`.
+ # `<project_id>:<dataset_id>.<table_id>` or
+ # `<project_id>.<dataset_id>.<table_id>`.
"projectId": "A String", # The Google Cloud Platform project ID of the project containing the table.
# If omitted, project ID is inferred from the API call.
"tableId": "A String", # Name of the table.
"datasetId": "A String", # Dataset ID of the table.
},
- "rowNumber": "A String", # Absolute number of the row from the beginning of the table at the time
- # of scanning.
+ "rowNumber": "A String", # Row number inferred at the time the table was scanned. This value is
+ # nondeterministic, cannot be queried, and may be null for inspection
+ # jobs. To locate findings within a table, specify
+ # `inspect_job.storage_config.big_query_options.identifying_fields` in
+ # `CreateDlpJobRequest`.
},
"idValues": [ # Values of identifying columns in the given row. Order of values matches
- # the order of field identifiers specified in the scanning request.
+ # the order of `identifying_fields` specified in the scanning request.
"A String",
],
"datastoreKey": { # Record key for a finding in Cloud Datastore.
@@ -637,7 +694,17 @@
},
},
],
+ "byteRange": { # Generic half-open interval [start, end) # Zero-based byte offsets delimiting the finding.
+ # These are relative to the finding's containing element.
+ # Note that when the content is not textual, this references
+ # the UTF-8 encoded textual representation of the content.
+ # Omitted if content is an image.
+ "start": "A String", # Index of the first character of the range (inclusive).
+ "end": "A String", # Index of the last character of the range (exclusive).
+ },
},
+ "triggerName": "A String", # Job trigger name, if applicable, for this finding.
+ "resourceName": "A String", # The job that stored the finding.
"likelihood": "A String", # Confidence of how likely it is that the `info_type` is correct.
"createTime": "A String", # Timestamp when finding was detected.
},