Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a new Annotation record. It is valid to create Annotation objects for the same source more than once since a unique ID is assigned to each record by this service.
Deletes an Annotation or returns NOT_FOUND if it does not exist.
Gets an Annotation.
list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists the Annotations in the given Annotation store for a source resource.
list_next(previous_request, previous_response)
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the Annotation.
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a new Annotation record. It is valid to create Annotation objects for the same source more than once since a unique ID is assigned to each record by this service.
Args:
parent: string, The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. (required)
body: object, The request body.
The object takes the form of:
{ # An annotation record.
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source.
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
"name": "A String", # Full path of a Cloud Healthcare API resource.
},
},
"customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign.
"a_key": "A String",
},
"imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons.
"boundingPolys": [ # The list of polygons outlining the sensitive regions in the image.
{ # A bounding polygon for the detected image annotation.
"label": "A String", # A description of this polygon.
"vertices": [ # List of the vertices of this polygon.
{ # A 2D coordinate in an image. The origin is the top-left.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate.
},
],
},
],
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
},
"name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
"label": "A String", # A description of the annotation record.
},
"textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
"details": { # Maps from a resource slice. For example, FHIR resource field path to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3}
"a_key": { # Contains multiple sensitive information findings for each resource slice.
"findings": [
{
"end": "A String", # Zero-based ending index of the found text, exclusively.
"infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address.
"quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig.
"start": "A String", # Zero-based starting index of the found text, inclusively.
},
],
},
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An annotation record.
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source.
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
"name": "A String", # Full path of a Cloud Healthcare API resource.
},
},
"customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign.
"a_key": "A String",
},
"imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons.
"boundingPolys": [ # The list of polygons outlining the sensitive regions in the image.
{ # A bounding polygon for the detected image annotation.
"label": "A String", # A description of this polygon.
"vertices": [ # List of the vertices of this polygon.
{ # A 2D coordinate in an image. The origin is the top-left.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate.
},
],
},
],
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
},
"name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
"label": "A String", # A description of the annotation record.
},
"textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
"details": { # Maps from a resource slice. For example, FHIR resource field path to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3}
"a_key": { # Contains multiple sensitive information findings for each resource slice.
"findings": [
{
"end": "A String", # Zero-based ending index of the found text, exclusively.
"infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address.
"quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig.
"start": "A String", # Zero-based starting index of the found text, inclusively.
},
],
},
},
},
}
delete(name, x__xgafv=None)
Deletes an Annotation or returns NOT_FOUND if it does not exist.
Args:
name: string, The resource name of the Annotation to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}
get(name, x__xgafv=None)
Gets an Annotation.
Args:
name: string, The resource name of the Annotation to retrieve. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An annotation record.
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source.
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
"name": "A String", # Full path of a Cloud Healthcare API resource.
},
},
"customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign.
"a_key": "A String",
},
"imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons.
"boundingPolys": [ # The list of polygons outlining the sensitive regions in the image.
{ # A bounding polygon for the detected image annotation.
"label": "A String", # A description of this polygon.
"vertices": [ # List of the vertices of this polygon.
{ # A 2D coordinate in an image. The origin is the top-left.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate.
},
],
},
],
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
},
"name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
"label": "A String", # A description of the annotation record.
},
"textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
"details": { # Maps from a resource slice. For example, FHIR resource field path to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3}
"a_key": { # Contains multiple sensitive information findings for each resource slice.
"findings": [
{
"end": "A String", # Zero-based ending index of the found text, exclusively.
"infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address.
"quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig.
"start": "A String", # Zero-based starting index of the found text, inclusively.
},
],
},
},
},
}
list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists the Annotations in the given Annotation store for a source resource.
Args:
parent: string, Name of the Annotation store to retrieve Annotations from. (required)
filter: string, Restricts Annotations returned to those matching a filter. Functions available for filtering are: - `matches("annotation_source.cloud_healthcare_source.name", substring)`. Filter on `cloud_healthcare_source.name`. For example: `matches("annotation_source.cloud_healthcare_source.name", "some source")`. - `matches("annotation", substring)`. Filter on all fields of annotation. For example: `matches("annotation", "some-content")`. - `type("text")`, `type("image")`, `type("resource")`. Filter on the type of annotation `data`.
pageSize: integer, Limit on the number of Annotations to return in a single response. If not specified, 100 is used. May not be larger than 1000.
pageToken: string, The next_page_token value returned from the previous List request, if any.
view: string, Controls which fields are populated in the response.
Allowed values
ANNOTATION_VIEW_UNSPECIFIED - Same as BASIC.
ANNOTATION_VIEW_BASIC - Only `name`, `annotation_source` and `custom_data` fields are populated.
ANNOTATION_VIEW_FULL - All fields are populated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Lists the Annotations in the specified Annotation store.
"annotations": [ # The returned Annotations. Won't be more values than the value of page_size in the request. See `AnnotationView` in the request for populated fields.
{ # An annotation record.
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source.
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
"name": "A String", # Full path of a Cloud Healthcare API resource.
},
},
"customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign.
"a_key": "A String",
},
"imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons.
"boundingPolys": [ # The list of polygons outlining the sensitive regions in the image.
{ # A bounding polygon for the detected image annotation.
"label": "A String", # A description of this polygon.
"vertices": [ # List of the vertices of this polygon.
{ # A 2D coordinate in an image. The origin is the top-left.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate.
},
],
},
],
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
},
"name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
"label": "A String", # A description of the annotation record.
},
"textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
"details": { # Maps from a resource slice. For example, FHIR resource field path to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3}
"a_key": { # Contains multiple sensitive information findings for each resource slice.
"findings": [
{
"end": "A String", # Zero-based ending index of the found text, exclusively.
"infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address.
"quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig.
"start": "A String", # Zero-based starting index of the found text, inclusively.
},
],
},
},
},
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more results in the list.
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the Annotation.
Args:
name: string, Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. (required)
body: object, The request body.
The object takes the form of:
{ # An annotation record.
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source.
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
"name": "A String", # Full path of a Cloud Healthcare API resource.
},
},
"customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign.
"a_key": "A String",
},
"imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons.
"boundingPolys": [ # The list of polygons outlining the sensitive regions in the image.
{ # A bounding polygon for the detected image annotation.
"label": "A String", # A description of this polygon.
"vertices": [ # List of the vertices of this polygon.
{ # A 2D coordinate in an image. The origin is the top-left.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate.
},
],
},
],
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
},
"name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
"label": "A String", # A description of the annotation record.
},
"textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
"details": { # Maps from a resource slice. For example, FHIR resource field path to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3}
"a_key": { # Contains multiple sensitive information findings for each resource slice.
"findings": [
{
"end": "A String", # Zero-based ending index of the found text, exclusively.
"infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address.
"quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig.
"start": "A String", # Zero-based starting index of the found text, inclusively.
},
],
},
},
},
}
updateMask: string, The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An annotation record.
"annotationSource": { # AnnotationSource holds the source information of the annotation. # Details of the source.
"cloudHealthcareSource": { # Cloud Healthcare API resource. # Cloud Healthcare API resource.
"name": "A String", # Full path of a Cloud Healthcare API resource.
},
},
"customData": { # Additional information for this annotation record, such as annotator and verifier information or study campaign.
"a_key": "A String",
},
"imageAnnotation": { # Image annotation. # Annotations for images. For example, bounding polygons.
"boundingPolys": [ # The list of polygons outlining the sensitive regions in the image.
{ # A bounding polygon for the detected image annotation.
"label": "A String", # A description of this polygon.
"vertices": [ # List of the vertices of this polygon.
{ # A 2D coordinate in an image. The origin is the top-left.
"x": 3.14, # X coordinate.
"y": 3.14, # Y coordinate.
},
],
},
],
"frameIndex": 42, # 0-based index of the image frame. For example, an image frame in a DICOM instance.
},
"name": "A String", # Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
"resourceAnnotation": { # Resource level annotation. # Annotations for resource. For example, classification tags.
"label": "A String", # A description of the annotation record.
},
"textAnnotation": { # A TextAnnotation specifies a text range that includes sensitive information. # Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
"details": { # Maps from a resource slice. For example, FHIR resource field path to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3}
"a_key": { # Contains multiple sensitive information findings for each resource slice.
"findings": [
{
"end": "A String", # Zero-based ending index of the found text, exclusively.
"infoType": "A String", # The type of information stored in this text range. For example, HumanName, BirthDate, or Address.
"quote": "A String", # The snippet of the sensitive text. This field is only populated during deidentification if `store_quote` is set to true in DeidentifyConfig.
"start": "A String", # Zero-based starting index of the found text, inclusively.
},
],
},
},
},
}