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.

Create Annotation Resource

new Annotation(name: string, args: AnnotationArgs, opts?: CustomResourceOptions);
@overload
def Annotation(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               annotation_source: Optional[AnnotationSourceArgs] = None,
               annotation_store_id: Optional[str] = None,
               custom_data: Optional[Mapping[str, str]] = None,
               dataset_id: Optional[str] = None,
               image_annotation: Optional[ImageAnnotationArgs] = None,
               location: Optional[str] = None,
               name: Optional[str] = None,
               project: Optional[str] = None,
               resource_annotation: Optional[ResourceAnnotationArgs] = None,
               text_annotation: Optional[SensitiveTextAnnotationArgs] = None)
@overload
def Annotation(resource_name: str,
               args: AnnotationArgs,
               opts: Optional[ResourceOptions] = None)
func NewAnnotation(ctx *Context, name string, args AnnotationArgs, opts ...ResourceOption) (*Annotation, error)
public Annotation(string name, AnnotationArgs args, CustomResourceOptions? opts = null)
public Annotation(String name, AnnotationArgs args)
public Annotation(String name, AnnotationArgs args, CustomResourceOptions options)
type: google-native:healthcare/v1beta1:Annotation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AnnotationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args AnnotationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args AnnotationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AnnotationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AnnotationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Annotation Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Annotation resource accepts the following input properties:

AnnotationStoreId string
DatasetId string
AnnotationSource Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.AnnotationSourceArgs

Details of the source.

CustomData Dictionary<string, string>

Additional information for this annotation record, such as annotator and verifier information or study campaign.

ImageAnnotation Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.ImageAnnotationArgs

Annotations for images. For example, bounding polygons.

Location string
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}.

Project string
ResourceAnnotation Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.ResourceAnnotationArgs

Annotations for resource. For example, classification tags.

TextAnnotation Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.SensitiveTextAnnotationArgs

Annotations for sensitive texts. For example, a range that describes the location of sensitive text.

AnnotationStoreId string
DatasetId string
AnnotationSource AnnotationSourceArgs

Details of the source.

CustomData map[string]string

Additional information for this annotation record, such as annotator and verifier information or study campaign.

ImageAnnotation ImageAnnotationArgs

Annotations for images. For example, bounding polygons.

Location string
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}.

Project string
ResourceAnnotation ResourceAnnotationArgs

Annotations for resource. For example, classification tags.

TextAnnotation SensitiveTextAnnotationArgs

Annotations for sensitive texts. For example, a range that describes the location of sensitive text.

annotationStoreId String
datasetId String
annotationSource AnnotationSourceArgs

Details of the source.

customData Map<String,String>

Additional information for this annotation record, such as annotator and verifier information or study campaign.

imageAnnotation ImageAnnotationArgs

Annotations for images. For example, bounding polygons.

location String
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}.

project String
resourceAnnotation ResourceAnnotationArgs

Annotations for resource. For example, classification tags.

textAnnotation SensitiveTextAnnotationArgs

Annotations for sensitive texts. For example, a range that describes the location of sensitive text.

annotationStoreId string
datasetId string
annotationSource AnnotationSourceArgs

Details of the source.

customData {[key: string]: string}

Additional information for this annotation record, such as annotator and verifier information or study campaign.

imageAnnotation ImageAnnotationArgs

Annotations for images. For example, bounding polygons.

location string
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}.

project string
resourceAnnotation ResourceAnnotationArgs

Annotations for resource. For example, classification tags.

textAnnotation SensitiveTextAnnotationArgs

Annotations for sensitive texts. For example, a range that describes the location of sensitive text.

annotation_store_id str
dataset_id str
annotation_source AnnotationSourceArgs

Details of the source.

custom_data Mapping[str, str]

Additional information for this annotation record, such as annotator and verifier information or study campaign.

image_annotation ImageAnnotationArgs

Annotations for images. For example, bounding polygons.

location str
name str

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

project str
resource_annotation ResourceAnnotationArgs

Annotations for resource. For example, classification tags.

text_annotation SensitiveTextAnnotationArgs

Annotations for sensitive texts. For example, a range that describes the location of sensitive text.

annotationStoreId String
datasetId String
annotationSource Property Map

Details of the source.

customData Map<String>

Additional information for this annotation record, such as annotator and verifier information or study campaign.

imageAnnotation Property Map

Annotations for images. For example, bounding polygons.

location String
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}.

project String
resourceAnnotation Property Map

Annotations for resource. For example, classification tags.

textAnnotation Property Map

Annotations for sensitive texts. For example, a range that describes the location of sensitive text.

Outputs

All input properties are implicitly available as output properties. Additionally, the Annotation resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Supporting Types

AnnotationSource

CloudHealthcareSource CloudHealthcareSource

Cloud Healthcare API resource.

cloudHealthcareSource CloudHealthcareSource

Cloud Healthcare API resource.

cloudHealthcareSource CloudHealthcareSource

Cloud Healthcare API resource.

cloud_healthcare_source CloudHealthcareSource

Cloud Healthcare API resource.

cloudHealthcareSource Property Map

Cloud Healthcare API resource.

AnnotationSourceResponse

cloudHealthcareSource Property Map

Cloud Healthcare API resource.

BoundingPoly

Label string

A description of this polygon.

Vertices List<Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.Vertex>

List of the vertices of this polygon.

Label string

A description of this polygon.

Vertices []Vertex

List of the vertices of this polygon.

label String

A description of this polygon.

vertices List<Vertex>

List of the vertices of this polygon.

label string

A description of this polygon.

vertices Vertex[]

List of the vertices of this polygon.

label str

A description of this polygon.

vertices Sequence[Vertex]

List of the vertices of this polygon.

label String

A description of this polygon.

vertices List<Property Map>

List of the vertices of this polygon.

BoundingPolyResponse

Label string

A description of this polygon.

Vertices List<Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.VertexResponse>

List of the vertices of this polygon.

Label string

A description of this polygon.

Vertices []VertexResponse

List of the vertices of this polygon.

label String

A description of this polygon.

vertices List<VertexResponse>

List of the vertices of this polygon.

label string

A description of this polygon.

vertices VertexResponse[]

List of the vertices of this polygon.

label str

A description of this polygon.

vertices Sequence[VertexResponse]

List of the vertices of this polygon.

label String

A description of this polygon.

vertices List<Property Map>

List of the vertices of this polygon.

CloudHealthcareSource

Name string

Full path of a Cloud Healthcare API resource.

Name string

Full path of a Cloud Healthcare API resource.

name String

Full path of a Cloud Healthcare API resource.

name string

Full path of a Cloud Healthcare API resource.

name str

Full path of a Cloud Healthcare API resource.

name String

Full path of a Cloud Healthcare API resource.

CloudHealthcareSourceResponse

Name string

Full path of a Cloud Healthcare API resource.

Name string

Full path of a Cloud Healthcare API resource.

name String

Full path of a Cloud Healthcare API resource.

name string

Full path of a Cloud Healthcare API resource.

name str

Full path of a Cloud Healthcare API resource.

name String

Full path of a Cloud Healthcare API resource.

ImageAnnotation

BoundingPolys List<Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.BoundingPoly>

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

FrameIndex int

0-based index of the image frame. For example, an image frame in a DICOM instance.

BoundingPolys []BoundingPoly

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

FrameIndex int

0-based index of the image frame. For example, an image frame in a DICOM instance.

boundingPolys List<BoundingPoly>

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

frameIndex Integer

0-based index of the image frame. For example, an image frame in a DICOM instance.

boundingPolys BoundingPoly[]

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

frameIndex number

0-based index of the image frame. For example, an image frame in a DICOM instance.

bounding_polys Sequence[BoundingPoly]

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

frame_index int

0-based index of the image frame. For example, an image frame in a DICOM instance.

boundingPolys List<Property Map>

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

frameIndex Number

0-based index of the image frame. For example, an image frame in a DICOM instance.

ImageAnnotationResponse

BoundingPolys List<Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.BoundingPolyResponse>

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

FrameIndex int

0-based index of the image frame. For example, an image frame in a DICOM instance.

BoundingPolys []BoundingPolyResponse

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

FrameIndex int

0-based index of the image frame. For example, an image frame in a DICOM instance.

boundingPolys List<BoundingPolyResponse>

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

frameIndex Integer

0-based index of the image frame. For example, an image frame in a DICOM instance.

boundingPolys BoundingPolyResponse[]

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

frameIndex number

0-based index of the image frame. For example, an image frame in a DICOM instance.

bounding_polys Sequence[BoundingPolyResponse]

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

frame_index int

0-based index of the image frame. For example, an image frame in a DICOM instance.

boundingPolys List<Property Map>

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

frameIndex Number

0-based index of the image frame. For example, an image frame in a DICOM instance.

ResourceAnnotation

Label string

A description of the annotation record.

Label string

A description of the annotation record.

label String

A description of the annotation record.

label string

A description of the annotation record.

label str

A description of the annotation record.

label String

A description of the annotation record.

ResourceAnnotationResponse

Label string

A description of the annotation record.

Label string

A description of the annotation record.

label String

A description of the annotation record.

label string

A description of the annotation record.

label str

A description of the annotation record.

label String

A description of the annotation record.

SensitiveTextAnnotation

Details Dictionary<string, string>

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}

Details map[string]string

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}

details Map<String,String>

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}

details {[key: string]: string}

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}

details Mapping[str, str]

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}

details Map<String>

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}

SensitiveTextAnnotationResponse

Details Dictionary<string, string>

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}

Details map[string]string

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}

details Map<String,String>

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}

details {[key: string]: string}

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}

details Mapping[str, str]

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}

details Map<String>

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}

Vertex

X double

X coordinate.

Y double

Y coordinate.

X float64

X coordinate.

Y float64

Y coordinate.

x Double

X coordinate.

y Double

Y coordinate.

x number

X coordinate.

y number

Y coordinate.

x float

X coordinate.

y float

Y coordinate.

x Number

X coordinate.

y Number

Y coordinate.

VertexResponse

X double

X coordinate.

Y double

Y coordinate.

X float64

X coordinate.

Y float64

Y coordinate.

x Double

X coordinate.

y Double

Y coordinate.

x number

X coordinate.

y number

Y coordinate.

x float

X coordinate.

y float

Y coordinate.

x Number

X coordinate.

y Number

Y coordinate.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0