docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html
index 0999538..eb59a8c 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html
@@ -151,12 +151,12 @@
# A health dataset represents a collection of healthcare data pertaining to one
# or more patients. This may include multiple modalities of healthcare data,
# such as electronic medical records or medical imaging data.
+ "name": "A String", # Output only. Resource name of the dataset, of the form
+ # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
"timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA
# time zone name such as "America/New_York" or empty, which defaults to UTC.
# This is used for parsing times in resources, such as HL7 messages, where no
# explicit timezone is specified.
- "name": "A String", # Output only. Resource name of the dataset, of the form
- # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
}
datasetId: string, The ID of the dataset that is being created.
@@ -171,27 +171,6 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
@@ -211,6 +190,27 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
}</pre>
</div>
@@ -240,78 +240,10 @@
The object takes the form of:
{ # Redacts identifying information from the specified dataset.
- "destinationDataset": "A String", # The name of the dataset resource to create and write the redacted data to.
- #
- # * The destination dataset must not exist.
- # * The destination dataset must be in the same project and location as the
- # source dataset. De-identifying data across multiple projects or locations
- # is not supported.
"config": { # Configures de-id options specific to different types of content. # Deidentify configuration.
# Each submessage customizes the handling of an
# https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are
# applied in a nested manner at runtime.
- "dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content.
- "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove.
- "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID,
- # SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched.
- # The Cloud Healthcare API regenerates these UIDs by default based on the
- # DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly
- # to an individual out of context, given access to the original images, or
- # to a database of the original images containing the UIDs, it would be
- # possible to recover the individual's identity."
- # http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html
- "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags.
- "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta
- # Elements, or Directory Structuring Elements, as defined at:
- # http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,.
- # They may be provided by "Keyword" or "Tag". For example "PatientID",
- # "00100010".
- "A String",
- ],
- },
- "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags.
- "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta
- # Elements, or Directory Structuring Elements, as defined at:
- # http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,.
- # They may be provided by "Keyword" or "Tag". For example "PatientID",
- # "00100010".
- "A String",
- ],
- },
- },
- "fhir": { # Specifies how to handle de-identification of a FHIR store. # Configures de-id of application/FHIR content.
- "fieldMetadataList": [ # Specifies FHIR paths to match and how to transform them. Any field that
- # is not matched by a FieldMetadata is passed through to the output
- # dataset unmodified. All extensions are removed in the output.
- # If a field can be matched by more than one FieldMetadata, the first
- # FieldMetadata.Action is applied.
- { # Specifies FHIR paths to match, and how to handle de-identification of
- # matching fields.
- "paths": [ # List of paths to FHIR fields to redact. Each path is a
- # period-separated list where each component is either a field name or
- # FHIR type name. All types begin with an upper case letter. For example,
- # the resource field "Patient.Address.city", which uses a string type,
- # can be matched by "Patient.Address.String". Path also supports partial
- # matching. For example, "Patient.Address.city" can be matched by
- # "Address.city" (Patient omitted). Partial matching and type matching
- # can be combined, for example "Patient.Address.city" can be matched by
- # "Address.String". For "choice" types (those defined in the FHIR spec
- # with the form: field[x]), use two separate components. For example,
- # "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types
- # are: AdministrativeGenderCode, Code, Date, DateTime, Decimal,
- # HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- # The sub-type for HumanName(for example HumanName.given,
- # HumanName.family) can be omitted.
- "A String",
- ],
- "action": "A String", # Deidentify action for one field.
- },
- ],
- },
- "image": { # Specifies how to handle de-identification of image pixels. # Configures de-identification of image pixels wherever they are found in the
- # source_dataset.
- "textRedactionMode": "A String", # Determines how to redact text from image.
- },
"text": { # Configures de-identification of text wherever it is found in the
# source_dataset.
"transformations": [ # The transformations to apply to the detected data.
@@ -343,8 +275,8 @@
},
"cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. # Config for crypto hash.
# Uses SHA-256.
- # Outputs a base64-encoded representation of the hashed output
- # (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`).
+ # Outputs a base64-encoded representation of the hashed output.
+ # For example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`.
"cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the hash to be computed based on this
# key. A default key is generated for each Deidentify operation and is used
# wherever crypto_key is not specified.
@@ -352,7 +284,75 @@
},
],
},
+ "dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content.
+ "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove.
+ "skipIdRedaction": True or False, # If true, skip replacing StudyInstanceUID, SeriesInstanceUID,
+ # SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched.
+ # The Cloud Healthcare API regenerates these UIDs by default based on the
+ # DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly
+ # to an individual out of context, given access to the original images, or
+ # to a database of the original images containing the UIDs, it would be
+ # possible to recover the individual's identity."
+ # http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html
+ "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags.
+ "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta
+ # Elements, or Directory Structuring Elements, as defined at:
+ # http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,.
+ # They may be provided by "Keyword" or "Tag". For example, "PatientID",
+ # "00100010".
+ "A String",
+ ],
+ },
+ "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags.
+ "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta
+ # Elements, or Directory Structuring Elements, as defined at:
+ # http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,.
+ # They may be provided by "Keyword" or "Tag". For example, "PatientID",
+ # "00100010".
+ "A String",
+ ],
+ },
+ },
+ "fhir": { # Specifies how to handle de-identification of a FHIR store. # Configures de-id of application/FHIR content.
+ "fieldMetadataList": [ # Specifies FHIR paths to match and how to transform them. Any field that
+ # is not matched by a FieldMetadata is passed through to the output
+ # dataset unmodified. All extensions are removed in the output.
+ # If a field can be matched by more than one FieldMetadata, the first
+ # FieldMetadata.Action is applied.
+ { # Specifies FHIR paths to match, and how to handle de-identification of
+ # matching fields.
+ "paths": [ # List of paths to FHIR fields to redact. Each path is a
+ # period-separated list where each component is either a field name or
+ # FHIR type name. All types begin with an upper case letter. For example,
+ # the resource field "Patient.Address.city", which uses a string type,
+ # can be matched by "Patient.Address.String". Path also supports partial
+ # matching. For example, "Patient.Address.city" can be matched by
+ # "Address.city" (Patient omitted). Partial matching and type matching
+ # can be combined. For example, "Patient.Address.city" can be matched by
+ # "Address.String". For "choice" types (those defined in the FHIR spec
+ # with the form: field[x]), use two separate components. For example,
+ # "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types
+ # are: AdministrativeGenderCode, Code, Date, DateTime, Decimal,
+ # HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
+ # The sub-type for HumanName, such as HumanName.given or
+ # HumanName.family, can be omitted.
+ "A String",
+ ],
+ "action": "A String", # Deidentify action for one field.
+ },
+ ],
+ },
+ "image": { # Specifies how to handle de-identification of image pixels. # Configures de-identification of image pixels wherever they are found in the
+ # source_dataset.
+ "textRedactionMode": "A String", # Determines how to redact text from image.
+ },
},
+ "destinationDataset": "A String", # The name of the dataset resource to create and write the redacted data to.
+ #
+ # * The destination dataset must not exist.
+ # * The destination dataset must be in the same project and location as the
+ # source dataset. De-identifying data across multiple projects or locations
+ # is not supported.
}
x__xgafv: string, V1 error format.
@@ -365,27 +365,6 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
@@ -405,6 +384,27 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
}</pre>
</div>
@@ -457,12 +457,12 @@
# A health dataset represents a collection of healthcare data pertaining to one
# or more patients. This may include multiple modalities of healthcare data,
# such as electronic medical records or medical imaging data.
+ "name": "A String", # Output only. Resource name of the dataset, of the form
+ # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
"timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA
# time zone name such as "America/New_York" or empty, which defaults to UTC.
# This is used for parsing times in resources, such as HL7 messages, where no
# explicit timezone is specified.
- "name": "A String", # Output only. Resource name of the dataset, of the form
- # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
}</pre>
</div>
@@ -670,12 +670,12 @@
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
- "logType": "A String", # The log type that this config enables.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
"A String",
],
+ "logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
@@ -729,6 +729,8 @@
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
@@ -736,8 +738,6 @@
# reporting, e.g. a file name and a position in the file.
"description": "A String", # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
@@ -816,12 +816,12 @@
# A health dataset represents a collection of healthcare data pertaining to one
# or more patients. This may include multiple modalities of healthcare data,
# such as electronic medical records or medical imaging data.
+ "name": "A String", # Output only. Resource name of the dataset, of the form
+ # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
"timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA
# time zone name such as "America/New_York" or empty, which defaults to UTC.
# This is used for parsing times in resources, such as HL7 messages, where no
# explicit timezone is specified.
- "name": "A String", # Output only. Resource name of the dataset, of the form
- # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
@@ -858,12 +858,12 @@
# A health dataset represents a collection of healthcare data pertaining to one
# or more patients. This may include multiple modalities of healthcare data,
# such as electronic medical records or medical imaging data.
+ "name": "A String", # Output only. Resource name of the dataset, of the form
+ # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
"timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA
# time zone name such as "America/New_York" or empty, which defaults to UTC.
# This is used for parsing times in resources, such as HL7 messages, where no
# explicit timezone is specified.
- "name": "A String", # Output only. Resource name of the dataset, of the form
- # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
}
updateMask: string, The update mask applies to the resource. For the `FieldMask` definition,
@@ -882,12 +882,12 @@
# A health dataset represents a collection of healthcare data pertaining to one
# or more patients. This may include multiple modalities of healthcare data,
# such as electronic medical records or medical imaging data.
+ "name": "A String", # Output only. Resource name of the dataset, of the form
+ # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
"timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA
# time zone name such as "America/New_York" or empty, which defaults to UTC.
# This is used for parsing times in resources, such as HL7 messages, where no
# explicit timezone is specified.
- "name": "A String", # Output only. Resource name of the dataset, of the form
- # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
}</pre>
</div>
@@ -905,6 +905,11 @@
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
+ "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
+ # the fields in the mask will be modified. If no mask is provided, the
+ # following default mask is used:
+ #
+ # `paths: "bindings, etag"`
"policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
# the policy is limited to a few 10s of KB. An empty policy is a
# valid policy but certain Cloud Platform services (such as Projects)
@@ -1083,12 +1088,12 @@
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
- "logType": "A String", # The log type that this config enables.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
"A String",
],
+ "logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
@@ -1142,6 +1147,8 @@
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
@@ -1149,8 +1156,6 @@
# reporting, e.g. a file name and a position in the file.
"description": "A String", # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
@@ -1202,11 +1207,6 @@
},
],
},
- "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
- # the fields in the mask will be modified. If no mask is provided, the
- # following default mask is used:
- #
- # `paths: "bindings, etag"`
}
x__xgafv: string, V1 error format.
@@ -1392,12 +1392,12 @@
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
- "logType": "A String", # The log type that this config enables.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
"A String",
],
+ "logType": "A String", # The log type that this config enables.
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
@@ -1451,6 +1451,8 @@
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
@@ -1458,8 +1460,6 @@
# reporting, e.g. a file name and a position in the file.
"description": "A String", # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values: