Google Native
getAnnotation
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:
- Annotation
Id string - Annotation
Store stringId - Dataset
Id string - Location string
- Project string
- Annotation
Id string - Annotation
Store stringId - Dataset
Id string - Location string
- Project string
- annotation
Id String - annotation
Store StringId - dataset
Id String - location String
- project String
- annotation
Id string - annotation
Store stringId - dataset
Id string - location string
- project string
- annotation_
id str - annotation_
store_ strid - dataset_
id str - location str
- project str
- annotation
Id String - annotation
Store StringId - dataset
Id String - location String
- project String
getAnnotation Result
The following output properties are available:
- Annotation
Source Pulumi.Google Native. Healthcare. V1Beta1. Outputs. Annotation Source Response Details of the source.
- Custom
Data Dictionary<string, string> Additional information for this annotation record, such as annotator and verifier information or study campaign.
- Image
Annotation Pulumi.Google Native. Healthcare. V1Beta1. Outputs. Image Annotation Response 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}
.- Resource
Annotation Pulumi.Google Native. Healthcare. V1Beta1. Outputs. Resource Annotation Response Annotations for resource. For example, classification tags.
- Text
Annotation Pulumi.Google Native. Healthcare. V1Beta1. Outputs. Sensitive Text Annotation Response Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
- Annotation
Source AnnotationSource Response Details of the source.
- Custom
Data map[string]string Additional information for this annotation record, such as annotator and verifier information or study campaign.
- Image
Annotation ImageAnnotation Response 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}
.- Resource
Annotation ResourceAnnotation Response Annotations for resource. For example, classification tags.
- Text
Annotation SensitiveText Annotation Response Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
- annotation
Source AnnotationSource Response Details of the source.
- custom
Data Map<String,String> Additional information for this annotation record, such as annotator and verifier information or study campaign.
- image
Annotation ImageAnnotation Response 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}
.- resource
Annotation ResourceAnnotation Response Annotations for resource. For example, classification tags.
- text
Annotation SensitiveText Annotation Response Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
- annotation
Source AnnotationSource Response Details of the source.
- custom
Data {[key: string]: string} Additional information for this annotation record, such as annotator and verifier information or study campaign.
- image
Annotation ImageAnnotation Response 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}
.- resource
Annotation ResourceAnnotation Response Annotations for resource. For example, classification tags.
- text
Annotation SensitiveText Annotation Response Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
- annotation_
source AnnotationSource Response 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 ImageAnnotation Response 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 ResourceAnnotation Response Annotations for resource. For example, classification tags.
- text_
annotation SensitiveText Annotation Response Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
- annotation
Source Property Map Details of the source.
- custom
Data Map<String> Additional information for this annotation record, such as annotator and verifier information or study campaign.
- image
Annotation 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}
.- resource
Annotation Property Map Annotations for resource. For example, classification tags.
- text
Annotation Property Map Annotations for sensitive texts. For example, a range that describes the location of sensitive text.
Supporting Types
AnnotationSourceResponse
- Cloud
Healthcare Pulumi.Source Google Native. Healthcare. V1Beta1. Inputs. Cloud Healthcare Source Response Cloud Healthcare API resource.
- Cloud
Healthcare CloudSource Healthcare Source Response Cloud Healthcare API resource.
- cloud
Healthcare CloudSource Healthcare Source Response Cloud Healthcare API resource.
- cloud
Healthcare CloudSource Healthcare Source Response Cloud Healthcare API resource.
- cloud_
healthcare_ Cloudsource Healthcare Source Response Cloud Healthcare API resource.
- cloud
Healthcare Property MapSource Cloud Healthcare API resource.
BoundingPolyResponse
- Label string
A description of this polygon.
- Vertices
List<Pulumi.
Google Native. Healthcare. V1Beta1. Inputs. Vertex Response> List of the vertices of this polygon.
- Label string
A description of this polygon.
- Vertices
[]Vertex
Response List of the vertices of this polygon.
- label String
A description of this polygon.
- vertices
List<Vertex
Response> List of the vertices of this polygon.
- label string
A description of this polygon.
- vertices
Vertex
Response[] List of the vertices of this polygon.
- label str
A description of this polygon.
- vertices
Sequence[Vertex
Response] 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
- Bounding
Polys List<Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Bounding Poly Response> 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.
- Bounding
Polys []BoundingPoly Response 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.
- bounding
Polys List<BoundingPoly Response> The list of polygons outlining the sensitive regions in the image.
- frame
Index Integer 0-based index of the image frame. For example, an image frame in a DICOM instance.
- bounding
Polys BoundingPoly Response[] The list of polygons outlining the sensitive regions in the image.
- frame
Index number 0-based index of the image frame. For example, an image frame in a DICOM instance.
- bounding_
polys Sequence[BoundingPoly Response] 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.
- bounding
Polys List<Property Map> The list of polygons outlining the sensitive regions in the image.
- frame
Index 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
Package Details
- Repository
- https://github.com/pulumi/pulumi-google-native
- License
- Apache-2.0