View Source GoogleApi.AIPlatform.V1.Api.Datasets (google_api_ai_platform v0.13.0)

API calls for all endpoints tagged Datasets.

Summary

Functions

Link to this function

aiplatform_datasets_create(connection, optional_params \\ [], opts \\ [])

View Source
@spec aiplatform_datasets_create(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.AIPlatform.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a Dataset.

Parameters

  • connection (type: GoogleApi.AIPlatform.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :parent (type: String.t) - Required. The resource name of the Location to create the Dataset in. Format: projects/{project}/locations/{location}
    • :body (type: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Dataset.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AIPlatform.V1.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

aiplatform_datasets_dataset_versions_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec aiplatform_datasets_dataset_versions_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AIPlatform.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Create a version from a Dataset.

Parameters

  • connection (type: GoogleApi.AIPlatform.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1DatasetVersion.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AIPlatform.V1.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

aiplatform_datasets_dataset_versions_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec aiplatform_datasets_dataset_versions_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AIPlatform.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a Dataset version.

Parameters

  • connection (type: GoogleApi.AIPlatform.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AIPlatform.V1.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

aiplatform_datasets_dataset_versions_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec aiplatform_datasets_dataset_versions_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1DatasetVersion.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a Dataset version.

Parameters

  • connection (type: GoogleApi.AIPlatform.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the Dataset version to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :readMask (type: String.t) - Mask specifying which fields to read.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1DatasetVersion{}} on success
  • {:error, info} on failure
Link to this function

aiplatform_datasets_dataset_versions_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec aiplatform_datasets_dataset_versions_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1ListDatasetVersionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists DatasetVersions in a Dataset.

Parameters

  • connection (type: GoogleApi.AIPlatform.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The resource name of the Dataset to list DatasetVersions from. Format: projects/{project}/locations/{location}/datasets/{dataset}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. The standard list filter.
    • :orderBy (type: String.t) - Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
    • :pageSize (type: integer()) - Optional. The standard list page size.
    • :pageToken (type: String.t) - Optional. The standard list page token.
    • :readMask (type: String.t) - Optional. Mask specifying which fields to read.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1ListDatasetVersionsResponse{}} on success
  • {:error, info} on failure
Link to this function

aiplatform_datasets_dataset_versions_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec aiplatform_datasets_dataset_versions_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1DatasetVersion.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a DatasetVersion.

Parameters

  • connection (type: GoogleApi.AIPlatform.V1.Connection.t) - Connection to server
  • name (type: String.t) - Output only. Identifier. The resource name of the DatasetVersion.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask. Updatable fields: * display_name
    • :body (type: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1DatasetVersion.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1DatasetVersion{}} on success
  • {:error, info} on failure
Link to this function

aiplatform_datasets_dataset_versions_restore(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec aiplatform_datasets_dataset_versions_restore(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AIPlatform.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Restores a dataset version.

Parameters

  • connection (type: GoogleApi.AIPlatform.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the DatasetVersion resource. Format: projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AIPlatform.V1.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

aiplatform_datasets_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec aiplatform_datasets_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.AIPlatform.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a Dataset.

Parameters

  • connection (type: GoogleApi.AIPlatform.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the Dataset to delete. Format: projects/{project}/locations/{location}/datasets/{dataset}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AIPlatform.V1.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure
Link to this function

aiplatform_datasets_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec aiplatform_datasets_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Dataset.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a Dataset.

Parameters

  • connection (type: GoogleApi.AIPlatform.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the Dataset resource.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :readMask (type: String.t) - Mask specifying which fields to read.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Dataset{}} on success
  • {:error, info} on failure
Link to this function

aiplatform_datasets_list(connection, optional_params \\ [], opts \\ [])

View Source
@spec aiplatform_datasets_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok,
   GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1ListDatasetsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists Datasets in a Location.

Parameters

  • connection (type: GoogleApi.AIPlatform.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. display_name: supports = and != metadata_schema_uri: supports = and != labels supports general map functions that is: labels.key=value - key:value equality `labels.key: or labels:key - key existence A key including a space must be quoted. labels."a key". Some examples: displayName="myDisplayName" labels.myKey="myValue" :orderBy (type: String.t) - A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: display_name create_time update_time :pageSize (type: integer()) - The standard list page size. :pageToken (type: String.t) - The standard list page token. :parent (type: String.t) - Required. The name of the Dataset's parent resource. Format: projects/{project}/locations/{location} :readMask (type: String.t) - Mask specifying which fields to read. opts (type: keyword()) - Call options ## Returns {:ok, %GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1ListDatasetsResponse{}} on success {:error, info} on failure
Link to this function

aiplatform_datasets_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec aiplatform_datasets_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Dataset.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a Dataset.

Parameters

  • connection (type: GoogleApi.AIPlatform.V1.Connection.t) - Connection to server
  • name (type: String.t) - Output only. Identifier. The resource name of the Dataset.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask. Updatable fields: display_name description * labels
    • :body (type: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Dataset.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Dataset{}} on success
  • {:error, info} on failure