Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. healthcare
  5. healthcare/v1beta1
  6. getAnnotation

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.getAnnotation

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

    Gets an Annotation.

    Using getAnnotation

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAnnotation(args: GetAnnotationArgs, opts?: InvokeOptions): Promise<GetAnnotationResult>
function getAnnotationOutput(args: GetAnnotationOutputArgs, opts?: InvokeOptions): Output<GetAnnotationResult>
    def get_annotation(annotation_id: Optional[str] = None,
                   annotation_store_id: Optional[str] = None,
                   dataset_id: Optional[str] = None,
                   location: Optional[str] = None,
                   project: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetAnnotationResult
def get_annotation_output(annotation_id: Optional[pulumi.Input[str]] = None,
                   annotation_store_id: Optional[pulumi.Input[str]] = None,
                   dataset_id: Optional[pulumi.Input[str]] = None,
                   location: Optional[pulumi.Input[str]] = None,
                   project: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetAnnotationResult]
    func LookupAnnotation(ctx *Context, args *LookupAnnotationArgs, opts ...InvokeOption) (*LookupAnnotationResult, error)
func LookupAnnotationOutput(ctx *Context, args *LookupAnnotationOutputArgs, opts ...InvokeOption) LookupAnnotationResultOutput

    > Note: This function is named LookupAnnotation in the Go SDK.

    public static class GetAnnotation 
{
    public static Task<GetAnnotationResult> InvokeAsync(GetAnnotationArgs args, InvokeOptions? opts = null)
    public static Output<GetAnnotationResult> Invoke(GetAnnotationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAnnotationResult> getAnnotation(GetAnnotationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:healthcare/v1beta1:getAnnotation
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getAnnotation Result

    The following output properties are available:

    AnnotationSource Pulumi.GoogleNative.Healthcare.V1Beta1.Outputs.AnnotationSourceResponse
    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.Outputs.ImageAnnotationResponse
    Annotations for images. For example, bounding polygons.
    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}.
    ResourceAnnotation Pulumi.GoogleNative.Healthcare.V1Beta1.Outputs.ResourceAnnotationResponse
    Annotations for resource. For example, classification tags.
    TextAnnotation Pulumi.GoogleNative.Healthcare.V1Beta1.Outputs.SensitiveTextAnnotationResponse
    Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
    AnnotationSource AnnotationSourceResponse
    Details of the source.
    CustomData map[string]string
    Additional information for this annotation record, such as annotator and verifier information or study campaign.
    ImageAnnotation ImageAnnotationResponse
    Annotations for images. For example, bounding polygons.
    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}.
    ResourceAnnotation ResourceAnnotationResponse
    Annotations for resource. For example, classification tags.
    TextAnnotation SensitiveTextAnnotationResponse
    Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
    annotationSource AnnotationSourceResponse
    Details of the source.
    customData Map<String,String>
    Additional information for this annotation record, such as annotator and verifier information or study campaign.
    imageAnnotation ImageAnnotationResponse
    Annotations for images. For example, bounding polygons.
    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}.
    resourceAnnotation ResourceAnnotationResponse
    Annotations for resource. For example, classification tags.
    textAnnotation SensitiveTextAnnotationResponse
    Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
    annotationSource AnnotationSourceResponse
    Details of the source.
    customData {[key: string]: string}
    Additional information for this annotation record, such as annotator and verifier information or study campaign.
    imageAnnotation ImageAnnotationResponse
    Annotations for images. For example, bounding polygons.
    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}.
    resourceAnnotation ResourceAnnotationResponse
    Annotations for resource. For example, classification tags.
    textAnnotation SensitiveTextAnnotationResponse
    Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
    annotation_source AnnotationSourceResponse
    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 ImageAnnotationResponse
    Annotations for images. For example, bounding polygons.
    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}.
    resource_annotation ResourceAnnotationResponse
    Annotations for resource. For example, classification tags.
    text_annotation SensitiveTextAnnotationResponse
    Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
    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.
    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}.
    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.

    Supporting Types

    AnnotationSourceResponse

    cloudHealthcareSource Property Map
    Cloud Healthcare API resource.

    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.

    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.

    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.

    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.

    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}

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