# Genomics API . annotationSets

## Instance Methods

Creates a new annotation set. Caller must have WRITE permission for the associated dataset.

Deletes an annotation set. Caller must have WRITE permission for the associated annotation set.

Gets an annotation set. Caller must have READ permission for the associated dataset.

Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset. This method supports patch semantics.

Searches for annotation sets that match the given criteria. Annotation sets are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotation sets in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried datasets.

Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset.

### Method Details

`create(body)`

    Creates a new annotation set. Caller must have WRITE permission for the associated dataset.

    The following fields must be provided when creating an annotation set:
    - datasetId
    - referenceSetId
    All other fields may be optionally specified, unless documented as being server-generated (for example, the id field).

    Args:
      body: object, The request body. (required)
        The object takes the form of:

    { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
      "info": { # A string which maps to an array of values.
        "a_key": [ # A string which maps to an array of values.
          "A String",
        ],
      },
      "name": "A String", # The display name for this annotation set.
      "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
      "type": "A String", # The type of annotations contained within this set.
      "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
      "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
      "datasetId": "A String", # The dataset to which this annotation set belongs.
    }

    Returns:
      An object of the form:

        { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "name": "A String", # The display name for this annotation set.
        "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
        "type": "A String", # The type of annotations contained within this set.
        "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
        "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
        "datasetId": "A String", # The dataset to which this annotation set belongs.
      }

`delete(annotationSetId)`

    Deletes an annotation set. Caller must have WRITE permission for the associated annotation set.

    Args:
      annotationSetId: string, The ID of the annotation set to be deleted. (required)

`get(annotationSetId)`

    Gets an annotation set. Caller must have READ permission for the associated dataset.

    Args:
      annotationSetId: string, The ID of the annotation set to be retrieved. (required)

    Returns:
      An object of the form:

        { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "name": "A String", # The display name for this annotation set.
        "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
        "type": "A String", # The type of annotations contained within this set.
        "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
        "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
        "datasetId": "A String", # The dataset to which this annotation set belongs.
      }

`patch(annotationSetId, body)`

    Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset. This method supports patch semantics.

    Args:
      annotationSetId: string, The ID of the annotation set to be updated. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
      "info": { # A string which maps to an array of values.
        "a_key": [ # A string which maps to an array of values.
          "A String",
        ],
      },
      "name": "A String", # The display name for this annotation set.
      "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
      "type": "A String", # The type of annotations contained within this set.
      "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
      "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
      "datasetId": "A String", # The dataset to which this annotation set belongs.
    }

    Returns:
      An object of the form:

        { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "name": "A String", # The display name for this annotation set.
        "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
        "type": "A String", # The type of annotations contained within this set.
        "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
        "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
        "datasetId": "A String", # The dataset to which this annotation set belongs.
      }

`search(body)`

    Searches for annotation sets that match the given criteria. Annotation sets are returned in an unspecified order. This order is consistent, such that two queries for the same content (regardless of page size) yield annotation sets in the same order across their respective streams of paginated responses. Caller must have READ permission for the queried datasets.

    Args:
      body: object, The request body. (required)
        The object takes the form of:

    {
        "name": "A String", # Only return annotations sets for which a substring of the name matches this string (case insensitive).
        "pageSize": 42, # The maximum number of results to return in a single page. If unspecified, defaults to 128. The maximum value is 1024.
        "datasetIds": [ # The dataset IDs to search within. Caller must have READ access to these datasets.
          "A String",
        ],
        "pageToken": "A String", # The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
        "referenceSetId": "A String", # If specified, only annotation sets associated with the given reference set are returned.
        "types": [ # If specified, only annotation sets that have any of these types are returned.
          "A String",
        ],
      }

    Returns:
      An object of the form:

        {
        "nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. This field will be empty if there aren't any additional results.
        "annotationSets": [ # The matching annotation sets.
          { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
            "info": { # A string which maps to an array of values.
              "a_key": [ # A string which maps to an array of values.
                "A String",
              ],
            },
            "name": "A String", # The display name for this annotation set.
            "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
            "type": "A String", # The type of annotations contained within this set.
            "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
            "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
            "datasetId": "A String", # The dataset to which this annotation set belongs.
          },
        ],
      }

`update(annotationSetId, body)`

    Updates an annotation set. The update must respect all mutability restrictions and other invariants described on the annotation set resource. Caller must have WRITE permission for the associated dataset.

    Args:
      annotationSetId: string, The ID of the annotation set to be updated. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
      "info": { # A string which maps to an array of values.
        "a_key": [ # A string which maps to an array of values.
          "A String",
        ],
      },
      "name": "A String", # The display name for this annotation set.
      "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
      "type": "A String", # The type of annotations contained within this set.
      "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
      "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
      "datasetId": "A String", # The dataset to which this annotation set belongs.
    }

    Returns:
      An object of the form:

        { # An annotation set is a logical grouping of annotations that share consistent type information and provenance. Examples of annotation sets include 'all genes from refseq', and 'all variant annotations from ClinVar'.
        "info": { # A string which maps to an array of values.
          "a_key": [ # A string which maps to an array of values.
            "A String",
          ],
        },
        "name": "A String", # The display name for this annotation set.
        "sourceUri": "A String", # The source URI describing the file from which this annotation set was generated, if any.
        "type": "A String", # The type of annotations contained within this set.
        "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this set's annotations.
        "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
        "datasetId": "A String", # The dataset to which this annotation set belongs.
      }