# Agent Platform API . datasets . datasetVersions

## Instance Methods

Close httplib2 connections.

Create a version from a Dataset.

Deletes a Dataset version.

Gets a Dataset version.

Lists DatasetVersions in a Dataset.

Retrieves the next page of results.

Updates a DatasetVersion.

Restores a dataset version.

### Method Details

`close()`

    Close httplib2 connections.

`create(parent, body=None, x__xgafv=None)`

    Create a version from a Dataset.

    Args:
      parent: string, Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}` (required)
      body: object, The request body.
        The object takes the form of:

    { # Describes the dataset version.
      "bigQueryDatasetName": "A String", # Output only. Name of the associated BigQuery dataset.
      "createTime": "A String", # Output only. Timestamp when this DatasetVersion was created.
      "displayName": "A String", # The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters.
      "etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
      "metadata": "", # Required. Output only. Additional information about the DatasetVersion.
      "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
      "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
      "satisfiesPzi": True or False, # Output only. Reserved for future use.
      "satisfiesPzs": True or False, # Output only. Reserved for future use.
      "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
    }

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

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }

`delete(name, x__xgafv=None)`

    Deletes a Dataset version.

    Args:
      name: string, Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}` (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }

`get(name, readMask=None, x__xgafv=None)`

    Gets a Dataset version.

    Args:
      name: string, Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}` (required)
      readMask: string, Mask specifying which fields to read.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Describes the dataset version.
      "bigQueryDatasetName": "A String", # Output only. Name of the associated BigQuery dataset.
      "createTime": "A String", # Output only. Timestamp when this DatasetVersion was created.
      "displayName": "A String", # The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters.
      "etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
      "metadata": "", # Required. Output only. Additional information about the DatasetVersion.
      "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
      "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
      "satisfiesPzi": True or False, # Output only. Reserved for future use.
      "satisfiesPzs": True or False, # Output only. Reserved for future use.
      "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
    }

`list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)`

    Lists DatasetVersions in a Dataset.

    Args:
      parent: string, Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}` (required)
      filter: string, Optional. The standard list filter.
      orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
      pageSize: integer, Optional. The standard list page size.
      pageToken: string, Optional. The standard list page token.
      readMask: string, Optional. Mask specifying which fields to read.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response message for DatasetService.ListDatasetVersions.
      "datasetVersions": [ # A list of DatasetVersions that matches the specified filter in the request.
        { # Describes the dataset version.
          "bigQueryDatasetName": "A String", # Output only. Name of the associated BigQuery dataset.
          "createTime": "A String", # Output only. Timestamp when this DatasetVersion was created.
          "displayName": "A String", # The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters.
          "etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
          "metadata": "", # Required. Output only. Additional information about the DatasetVersion.
          "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
          "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
          "satisfiesPzi": True or False, # Output only. Reserved for future use.
          "satisfiesPzs": True or False, # Output only. Reserved for future use.
          "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
        },
      ],
      "nextPageToken": "A String", # The standard List next-page token.
    }

`list_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.

`patch(name, body=None, updateMask=None, x__xgafv=None)`

    Updates a DatasetVersion.

    Args:
      name: string, Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}` (required)
      body: object, The request body.
        The object takes the form of:

    { # Describes the dataset version.
      "bigQueryDatasetName": "A String", # Output only. Name of the associated BigQuery dataset.
      "createTime": "A String", # Output only. Timestamp when this DatasetVersion was created.
      "displayName": "A String", # The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters.
      "etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
      "metadata": "", # Required. Output only. Additional information about the DatasetVersion.
      "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
      "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
      "satisfiesPzi": True or False, # Output only. Reserved for future use.
      "satisfiesPzs": True or False, # Output only. Reserved for future use.
      "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
    }

      updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Describes the dataset version.
      "bigQueryDatasetName": "A String", # Output only. Name of the associated BigQuery dataset.
      "createTime": "A String", # Output only. Timestamp when this DatasetVersion was created.
      "displayName": "A String", # The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters.
      "etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
      "metadata": "", # Required. Output only. Additional information about the DatasetVersion.
      "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
      "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
      "satisfiesPzi": True or False, # Output only. Reserved for future use.
      "satisfiesPzs": True or False, # Output only. Reserved for future use.
      "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
    }

`restore(name, x__xgafv=None)`

    Restores a dataset version.

    Args:
      name: string, Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}` (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }