# Genomics API . referencesets

## Instance Methods

Gets a reference set.

Searches for reference sets which match the given criteria.

Retrieves the next page of results.

### Method Details

`get(referenceSetId, x__xgafv=None)`

    Gets a reference set.

    For the definitions of references and other genomics resources, see
    [Fundamentals of Google
    Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

    Implements
    [GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).

    Args:
      referenceSetId: string, The ID of the reference set. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A reference set is a set of references which typically comprise a reference
          # assembly for a species, such as `GRCh38` which is representative
          # of the human genome. A reference set defines a common coordinate space for
          # comparing reference-aligned experimental data. A reference set contains 1 or
          # more references.
          #
          # For more genomics resource definitions, see [Fundamentals of Google
          # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
        "description": "A String", # Free text description of this reference set.
        "sourceUri": "A String", # The URI from which the references were obtained.
        "referenceIds": [ # The IDs of the reference objects that are part of this set.
            # `Reference.md5checksum` must be unique within this set.
          "A String",
        ],
        "assemblyId": "A String", # Public id of this reference set, such as `GRCh37`.
        "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally
            # with a version number, for example `NC_000001.11`.
          "A String",
        ],
        "md5checksum": "A String", # Order-independent MD5 checksum which identifies this reference set. The
            # checksum is computed by sorting all lower case hexidecimal string
            # `reference.md5checksum` (for all reference in this set) in
            # ascending lexicographic order, concatenating, and taking the MD5 of that
            # value. The resulting value is represented in lower case hexadecimal format.
        "id": "A String", # The server-generated reference set ID, unique across all reference sets.
        "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human)
            # indicating the species which this reference set is intended to model. Note
            # that contained references may specify a different `ncbiTaxonId`, as
            # assemblies may contain reference sequences which do not belong to the
            # modeled species, for example EBV in a human reference genome.
      }

`search(body, x__xgafv=None)`

    Searches for reference sets which match the given criteria.

    For the definitions of references and other genomics resources, see
    [Fundamentals of Google
    Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)

    Implements
    [GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L71)

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

    {
        "md5checksums": [ # If present, return reference sets for which the
            # md5checksum matches exactly.
          "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.
        "accessions": [ # If present, return reference sets for which a prefix of any of
            # sourceAccessions
            # match any of these strings. Accession numbers typically have a main number
            # and a version, for example `NC_000001.11`.
          "A String",
        ],
        "pageSize": 42, # The maximum number of results to return in a single page. If unspecified,
            # defaults to 1024. The maximum value is 4096.
        "assemblyId": "A String", # If present, return reference sets for which a substring of their
            # `assemblyId` matches this string (case insensitive).
      }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    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.
        "referenceSets": [ # The matching references sets.
          { # A reference set is a set of references which typically comprise a reference
              # assembly for a species, such as `GRCh38` which is representative
              # of the human genome. A reference set defines a common coordinate space for
              # comparing reference-aligned experimental data. A reference set contains 1 or
              # more references.
              #
              # For more genomics resource definitions, see [Fundamentals of Google
              # Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
            "description": "A String", # Free text description of this reference set.
            "sourceUri": "A String", # The URI from which the references were obtained.
            "referenceIds": [ # The IDs of the reference objects that are part of this set.
                # `Reference.md5checksum` must be unique within this set.
              "A String",
            ],
            "assemblyId": "A String", # Public id of this reference set, such as `GRCh37`.
            "sourceAccessions": [ # All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally
                # with a version number, for example `NC_000001.11`.
              "A String",
            ],
            "md5checksum": "A String", # Order-independent MD5 checksum which identifies this reference set. The
                # checksum is computed by sorting all lower case hexidecimal string
                # `reference.md5checksum` (for all reference in this set) in
                # ascending lexicographic order, concatenating, and taking the MD5 of that
                # value. The resulting value is represented in lower case hexadecimal format.
            "id": "A String", # The server-generated reference set ID, unique across all reference sets.
            "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human)
                # indicating the species which this reference set is intended to model. Note
                # that contained references may specify a different `ncbiTaxonId`, as
                # assemblies may contain reference sequences which do not belong to the
                # modeled species, for example EBV in a human reference genome.
          },
        ],
      }

`search_next(previous_request, previous_response)`

    Retrieves the next page of results.

    Args:
      previous_request: The request for the previous page. (required)
      previous_response: The response from the request for the previous page. (required)

    Returns:
      A request object that you can call 'execute()' on to request the next
      page. Returns None if there are no more items in the collection.