Package google.cloud.healthcare.v1alpha2.annotation

Index

AnnotationService

A service for handling Cloud Healthcare Data Annotations.

CreateAnnotation

rpc CreateAnnotation(CreateAnnotationRequest) returns (Annotation)

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.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CreateAnnotationStore

rpc CreateAnnotationStore(CreateAnnotationStoreRequest) returns (AnnotationStore)

Creates a new Annotation store within the parent dataset.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteAnnotation

rpc DeleteAnnotation(DeleteAnnotationRequest) returns (Empty)

Deletes an Annotation or returns NOT_FOUND if it does not exist.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteAnnotationStore

rpc DeleteAnnotationStore(DeleteAnnotationStoreRequest) returns (Empty)

Deletes the specified Annotation store and removes all annotations that are contained within it.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetAnnotation

rpc GetAnnotation(GetAnnotationRequest) returns (Annotation)

Gets an Annotation.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetAnnotationStore

rpc GetAnnotationStore(GetAnnotationStoreRequest) returns (AnnotationStore)

Gets the specified Annotation store or returns NOT_FOUND if it does not exist.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetIamPolicy

rpc GetIamPolicy(GetIamPolicyRequest) returns (Policy)

Gets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set.

Authorization requires the Google IAM permission healthcare.AnnotationStores.getIamPolicy on the specified resource

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListAnnotationStores

rpc ListAnnotationStores(ListAnnotationStoresRequest) returns (ListAnnotationStoresResponse)

Lists the Annotation stores in the given dataset for a source store.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListAnnotations

rpc ListAnnotations(ListAnnotationsRequest) returns (ListAnnotationsResponse)

Lists the Annotations in the given Annotation store for a source resource.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

SetIamPolicy

rpc SetIamPolicy(SetIamPolicyRequest) returns (Policy)

POLICIES Sets the access control policy for a resource. Replaces any existing policy.

Authorization requires the Google IAM permission 'healthcare.annotationStores.setIamPolicy' on the specified resource

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

TestIamPermissions

rpc TestIamPermissions(TestIamPermissionsRequest) returns (TestIamPermissionsResponse)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

There is no permission required to make this API call.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

UpdateAnnotation

rpc UpdateAnnotation(UpdateAnnotationRequest) returns (Annotation)

Updates the Annotation.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

UpdateAnnotationStore

rpc UpdateAnnotationStore(UpdateAnnotationStoreRequest) returns (AnnotationStore)

Updates the specified Annotation store.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Annotation

An annotation record.

Fields
name

string

Output only. Resource name of the Annotation, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}.

annotation_source

AnnotationSource

Details of the source.

Union field data.

data can be only one of the following:

resource_annotation

ResourceAnnotation

Annotations for resource, e.g., classification tags.

image_annotation

ImageAnnotation

Annnotations for images, e.g., bounding polygons.

text_annotation

SensitiveTextAnnotation

Annotations for sentitive texts, e.g., range of such texts.

AnnotationSource

AnnotationSource holds the source information of the annotation.

Fields
cloud_healthcare_source

CloudHealthcareSource

Cloud Healthcare API resource.

CloudHealthcareSource

Cloud Healthcare API resource.

Fields
name

string

Full path of a Cloud Healthcare API resource.

AnnotationStore

An Annotation store that can store annotation resources such as labels and tags for text, image and audio.

Fields
name

string

Output only. Resource name of the Annotation store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}.

labels

map<string, string>

User-supplied key-value pairs used to organize Annotation stores.

Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}

Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}

No more than 64 labels can be associated with a given store.

CreateAnnotationRequest

Creates an Annotation record for a source and adds it to Annotation store.

Fields
parent

string

The name of the Annotation store this annotation belongs to. For example, projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore.

annotation

Annotation

Annotation to create.

CreateAnnotationStoreRequest

Request to create a new Annotation store.

Fields
parent

string

The name of the dataset this Annotation store belongs to.

annotation_store_id

string

The ID of the Annotation store that is being created. The string must match the following regex: [\p{L}\p{N}_\-\.]{1,256}.

annotation_store

AnnotationStore

Configuration info for this Annotation store.

DeleteAnnotationRequest

Deletes an Annotation from the specified Annotation store.

Fields
name

string

The resource name of the Annotation to delete.

DeleteAnnotationStoreRequest

Deletes the specified Annotation store.

Fields
name

string

The resource name of the Annotation store to delete.

GetAnnotationRequest

Gets an Annotation from the specified Annotation store.

Fields
name

string

The resource name of the Annotation to retrieve.

GetAnnotationStoreRequest

Gets an Annotation store.

Fields
name

string

The resource name of the Annotation store to get.

ImageAnnotation

Image annotation.

Fields
bounding_polys[]

BoundingPoly

The list of polygons outlining the sensitive regions in the image.

BoundingPoly

A bounding polygon for the detected image annotation.

Fields
vertices[]

Vertex

label

string

Vertex

A 2D coordinate in an image. The origin is the top-left.

Fields
x

float

X coordinate.

y

float

Y coordinate.

ListAnnotationStoresRequest

Lists the Annotation stores in the given dataset, for a given source store.

Fields
parent

string

Name of the dataset.

page_size

int32

Limit on the number of Annotation stores to return in a single response. If zero the default page size of 100 is used.

page_token

string

The next_page_token value returned from the previous List request, if any.

filter

string

Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example labels.key=value.

ListAnnotationStoresResponse

Lists the Annotation stores in the given dataset.

Fields
annotation_stores[]

AnnotationStore

The returned Annotation stores. Won't be more Annotation stores than the value of page_size in the request.

next_page_token

string

Token to retrieve the next page of results or empty if there are no more results in the list.

ListAnnotationsRequest

Lists the Annotations in the specified Annotation store.

Fields
parent

string

Name of the Annotation store to retrieve Annotations from.

page_size

int32

Limit on the number of Annotations to return in a single response. If zero the default page size of 100 is used.

page_token

string

The next_page_token value returned from the previous List request, if any.

filter

string

Restricts Annotations returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: - source_version

ListAnnotationsResponse

Lists the Annotations in the specified Annotation store.

Fields
annotations[]

string

The returned Annotations names. Won't be more values than the value of page_size in the request.

next_page_token

string

Token to retrieve the next page of results or empty if there are no more results in the list.

ResourceAnnotation

Resource level annotation.

Fields
label

string

SensitiveTextAnnotation

A TextAnnotation specifies a text range that includes sensitive information.

Fields
details

map<string, Detail>

Maps from a resource slice (e.g. FHIR resource field path) to a set of sensitive text findings. For example, Appointment.Narrative text1 --> {findings_1, findings_2, findings_3}

Detail

Contains multiple sensitive information findings for each resource slice.

Fields
findings[]

Finding

Finding

Fields
info_type

string

The type of information stored in this text range (e.g. HumanName, BirthDate, Address, etc.)

start

int64

Zero-based starting index of the found text, inclusively.

end

int64

Zero-based ending index of the found text, exclusively.

UpdateAnnotationRequest

Request to update the given Annotation.

Fields
annotation

Annotation

The annotation resource which updates the resource on the server. Only fields listed in update_mask will be required or applied.

update_mask

FieldMask

The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

UpdateAnnotationStoreRequest

Updates an Annotation store.

Fields
annotation_store

AnnotationStore

The Annotation store resource that updates the resource on the server. Only updating labels is supported.

update_mask

FieldMask

The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

¿Te ha resultado útil esta página? Enviar comentarios:

Enviar comentarios sobre...

Cloud Healthcare API