com.google.api.services.healthcare.v1beta1

Class CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations

java.lang.Object

com.google.api.services.healthcare.v1beta1.CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets.AnnotationStores

public class CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations
extends Object

The "annotations" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations.Create
class	CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations.Delete
class	CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations.Get
class	CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations.List
class	CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations.Patch

Constructor Summary

Constructors

Constructor and Description
Annotations()

Method Summary

Modifier and Type	Method and Description
CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations.Create	create(String parent, Annotation content) Creates a new Annotation record.
CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations.Delete	delete(String name) Deletes an Annotation or returns NOT_FOUND if it does not exist.
CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations.Get	get(String name) Gets an Annotation.
CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations.List	list(String parent) Lists the Annotations in the given Annotation store for a source resource.
CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations.Patch	patch(String name, Annotation content) Updates the Annotation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Annotations

public Annotations()

Method Detail

create

public CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations.Create create(String parent,
                                                                                              Annotation content)
                                                                                       throws IOException

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 a request for the method "annotations.create". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the Annotation

Returns:

the request

Throws:

IOException

delete

public CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations.Delete delete(String name)
                                                                                       throws IOException

Deletes an Annotation or returns NOT_FOUND if it does not exist. Create a request for the method "annotations.delete". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the Annotation to delete.

Returns:

the request

Throws:

IOException

get

public CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations.Get get(String name)
                                                                                 throws IOException

Gets an Annotation. Create a request for the method "annotations.get". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the Annotation to retrieve.

Returns:

the request

Throws:

IOException

list

public CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations.List list(String parent)
                                                                                   throws IOException

Lists the Annotations in the given Annotation store for a source resource. Create a request for the method "annotations.list". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. Name of the Annotation store to retrieve Annotations from.

Returns:

the request

Throws:

IOException

patch

public CloudHealthcare.Projects.Locations.Datasets.AnnotationStores.Annotations.Patch patch(String name,
                                                                                            Annotation content)
                                                                                     throws IOException

Updates the Annotation. Create a request for the method "annotations.patch". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Identifier. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_ id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_i d}`.

content - the Annotation

Returns:

the request

Throws:

IOException