Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. healthcare
  5. healthcare/v1beta1
  6. Annotation

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.healthcare/v1beta1.Annotation

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    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

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Annotation(name: string, args: AnnotationArgs, opts?: CustomResourceOptions);
    @overload
def Annotation(resource_name: str,
               args: AnnotationArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Annotation(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               annotation_store_id: Optional[str] = None,
               dataset_id: Optional[str] = None,
               annotation_source: Optional[AnnotationSourceArgs] = None,
               custom_data: Optional[Mapping[str, 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)
    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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var annotationResource = new GoogleNative.Healthcare.V1Beta1.Annotation("annotationResource", new()
{
    AnnotationStoreId = "string",
    DatasetId = "string",
    AnnotationSource = new GoogleNative.Healthcare.V1Beta1.Inputs.AnnotationSourceArgs
    {
        CloudHealthcareSource = new GoogleNative.Healthcare.V1Beta1.Inputs.CloudHealthcareSourceArgs
        {
            Name = "string",
        },
    },
    CustomData = 
    {
        { "string", "string" },
    },
    ImageAnnotation = new GoogleNative.Healthcare.V1Beta1.Inputs.ImageAnnotationArgs
    {
        BoundingPolys = new[]
        {
            new GoogleNative.Healthcare.V1Beta1.Inputs.BoundingPolyArgs
            {
                Label = "string",
                Vertices = new[]
                {
                    new GoogleNative.Healthcare.V1Beta1.Inputs.VertexArgs
                    {
                        X = 0,
                        Y = 0,
                    },
                },
            },
        },
        FrameIndex = 0,
    },
    Location = "string",
    Name = "string",
    Project = "string",
    ResourceAnnotation = new GoogleNative.Healthcare.V1Beta1.Inputs.ResourceAnnotationArgs
    {
        Label = "string",
    },
    TextAnnotation = new GoogleNative.Healthcare.V1Beta1.Inputs.SensitiveTextAnnotationArgs
    {
        Details = 
        {
            { "string", "string" },
        },
    },
});

    example, err := healthcarev1beta1.NewAnnotation(ctx, "annotationResource", &healthcarev1beta1.AnnotationArgs{
	AnnotationStoreId: pulumi.String("string"),
	DatasetId:         pulumi.String("string"),
	AnnotationSource: &healthcare.AnnotationSourceArgs{
		CloudHealthcareSource: &healthcare.CloudHealthcareSourceArgs{
			Name: pulumi.String("string"),
		},
	},
	CustomData: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ImageAnnotation: &healthcare.ImageAnnotationArgs{
		BoundingPolys: healthcare.BoundingPolyArray{
			&healthcare.BoundingPolyArgs{
				Label: pulumi.String("string"),
				Vertices: healthcare.VertexArray{
					&healthcare.VertexArgs{
						X: pulumi.Float64(0),
						Y: pulumi.Float64(0),
					},
				},
			},
		},
		FrameIndex: pulumi.Int(0),
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Project:  pulumi.String("string"),
	ResourceAnnotation: &healthcare.ResourceAnnotationArgs{
		Label: pulumi.String("string"),
	},
	TextAnnotation: &healthcare.SensitiveTextAnnotationArgs{
		Details: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
})

    var annotationResource = new com.pulumi.googlenative.healthcare_v1beta1.Annotation("annotationResource", com.pulumi.googlenative.healthcare_v1beta1.AnnotationArgs.builder()
    .annotationStoreId("string")
    .datasetId("string")
    .annotationSource(AnnotationSourceArgs.builder()
        .cloudHealthcareSource(CloudHealthcareSourceArgs.builder()
            .name("string")
            .build())
        .build())
    .customData(Map.of("string", "string"))
    .imageAnnotation(ImageAnnotationArgs.builder()
        .boundingPolys(BoundingPolyArgs.builder()
            .label("string")
            .vertices(VertexArgs.builder()
                .x(0.0)
                .y(0.0)
                .build())
            .build())
        .frameIndex(0)
        .build())
    .location("string")
    .name("string")
    .project("string")
    .resourceAnnotation(ResourceAnnotationArgs.builder()
        .label("string")
        .build())
    .textAnnotation(SensitiveTextAnnotationArgs.builder()
        .details(Map.of("string", "string"))
        .build())
    .build());

    annotation_resource = google_native.healthcare.v1beta1.Annotation("annotationResource",
    annotation_store_id="string",
    dataset_id="string",
    annotation_source={
        "cloud_healthcare_source": {
            "name": "string",
        },
    },
    custom_data={
        "string": "string",
    },
    image_annotation={
        "bounding_polys": [{
            "label": "string",
            "vertices": [{
                "x": 0,
                "y": 0,
            }],
        }],
        "frame_index": 0,
    },
    location="string",
    name="string",
    project="string",
    resource_annotation={
        "label": "string",
    },
    text_annotation={
        "details": {
            "string": "string",
        },
    })

    const annotationResource = new google_native.healthcare.v1beta1.Annotation("annotationResource", {
    annotationStoreId: "string",
    datasetId: "string",
    annotationSource: {
        cloudHealthcareSource: {
            name: "string",
        },
    },
    customData: {
        string: "string",
    },
    imageAnnotation: {
        boundingPolys: [{
            label: "string",
            vertices: [{
                x: 0,
                y: 0,
            }],
        }],
        frameIndex: 0,
    },
    location: "string",
    name: "string",
    project: "string",
    resourceAnnotation: {
        label: "string",
    },
    textAnnotation: {
        details: {
            string: "string",
        },
    },
});

    type: google-native:healthcare/v1beta1:Annotation
properties:
    annotationSource:
        cloudHealthcareSource:
            name: string
    annotationStoreId: string
    customData:
        string: string
    datasetId: string
    imageAnnotation:
        boundingPolys:
            - label: string
              vertices:
                - x: 0
                  "y": 0
        frameIndex: 0
    location: string
    name: string
    project: string
    resourceAnnotation:
        label: string
    textAnnotation:
        details:
            string: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Annotation resource accepts the following input properties:

    AnnotationStoreId string
    DatasetId string
    AnnotationSource Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.AnnotationSource
    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.ImageAnnotation
    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.ResourceAnnotation
    Annotations for resource. For example, classification tags.
    TextAnnotation Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.SensitiveTextAnnotation
    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 AnnotationSource
    Details of the source.
    customData Map<String,String>
    Additional information for this annotation record, such as annotator and verifier information or study campaign.
    imageAnnotation ImageAnnotation
    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 ResourceAnnotation
    Annotations for resource. For example, classification tags.
    textAnnotation SensitiveTextAnnotation
    Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
    annotationStoreId string
    datasetId string
    annotationSource AnnotationSource
    Details of the source.
    customData {[key: string]: string}
    Additional information for this annotation record, such as annotator and verifier information or study campaign.
    imageAnnotation ImageAnnotation
    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 ResourceAnnotation
    Annotations for resource. For example, classification tags.
    textAnnotation SensitiveTextAnnotation
    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, AnnotationSourceArgs

    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, AnnotationSourceResponseArgs

    cloudHealthcareSource Property Map
    Cloud Healthcare API resource.

    BoundingPoly, BoundingPolyArgs

    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, BoundingPolyResponseArgs

    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, CloudHealthcareSourceArgs

    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, CloudHealthcareSourceResponseArgs

    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, ImageAnnotationArgs

    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, ImageAnnotationResponseArgs

    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, ResourceAnnotationArgs

    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, ResourceAnnotationResponseArgs

    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, SensitiveTextAnnotationArgs

    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, SensitiveTextAnnotationResponseArgs

    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, VertexArgs

    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, VertexResponseArgs

    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
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native