- 0.50.0 (latest)
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::DatasetService::Client.
Client for the DatasetService service.
The service that manages Vertex AI Dataset and its child resources.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the DatasetService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all DatasetService clients ::Google::Cloud::AIPlatform::V1::DatasetService::Client.configure do |config| config.timeout = 10.0 end
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the DatasetService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_dataset
def create_dataset(request, options = nil) -> ::Gapic::Operation
def create_dataset(parent: nil, dataset: nil) -> ::Gapic::Operation
Creates a Dataset.
def create_dataset(request, options = nil) -> ::Gapic::Operation
create_dataset
via a request object, either of type
CreateDatasetRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::CreateDatasetRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_dataset(parent: nil, dataset: nil) -> ::Gapic::Operation
create_dataset
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The resource name of the Location to create the Dataset in.
Format:
projects/{project}/locations/{location}
- dataset (::Google::Cloud::AIPlatform::V1::Dataset, ::Hash) — Required. The Dataset to create.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::CreateDatasetRequest.new # Call the create_dataset method. result = client.create_dataset request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#create_dataset_version
def create_dataset_version(request, options = nil) -> ::Gapic::Operation
def create_dataset_version(parent: nil, dataset_version: nil) -> ::Gapic::Operation
Create a version from a Dataset.
def create_dataset_version(request, options = nil) -> ::Gapic::Operation
create_dataset_version
via a request object, either of type
CreateDatasetVersionRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::CreateDatasetVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_dataset_version(parent: nil, dataset_version: nil) -> ::Gapic::Operation
create_dataset_version
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The name of the Dataset resource.
Format:
projects/{project}/locations/{location}/datasets/{dataset}
- dataset_version (::Google::Cloud::AIPlatform::V1::DatasetVersion, ::Hash) — Required. The version to be created. The same CMEK policies with the original Dataset will be applied the dataset version. So here we don't need to specify the EncryptionSpecType here.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::CreateDatasetVersionRequest.new # Call the create_dataset_version method. result = client.create_dataset_version request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#delete_dataset
def delete_dataset(request, options = nil) -> ::Gapic::Operation
def delete_dataset(name: nil) -> ::Gapic::Operation
Deletes a Dataset.
def delete_dataset(request, options = nil) -> ::Gapic::Operation
delete_dataset
via a request object, either of type
Google::Cloud::AIPlatform::V1::DeleteDatasetRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::DeleteDatasetRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_dataset(name: nil) -> ::Gapic::Operation
delete_dataset
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The resource name of the Dataset to delete.
Format:
projects/{project}/locations/{location}/datasets/{dataset}
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::DeleteDatasetRequest.new # Call the delete_dataset method. result = client.delete_dataset request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#delete_dataset_version
def delete_dataset_version(request, options = nil) -> ::Gapic::Operation
def delete_dataset_version(name: nil) -> ::Gapic::Operation
Deletes a Dataset version.
def delete_dataset_version(request, options = nil) -> ::Gapic::Operation
delete_dataset_version
via a request object, either of type
Google::Cloud::AIPlatform::V1::DeleteDatasetVersionRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::DeleteDatasetVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_dataset_version(name: nil) -> ::Gapic::Operation
delete_dataset_version
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The resource name of the Dataset version to delete.
Format:
projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::DeleteDatasetVersionRequest.new # Call the delete_dataset_version method. result = client.delete_dataset_version request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#delete_saved_query
def delete_saved_query(request, options = nil) -> ::Gapic::Operation
def delete_saved_query(name: nil) -> ::Gapic::Operation
Deletes a SavedQuery.
def delete_saved_query(request, options = nil) -> ::Gapic::Operation
delete_saved_query
via a request object, either of type
Google::Cloud::AIPlatform::V1::DeleteSavedQueryRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::DeleteSavedQueryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_saved_query(name: nil) -> ::Gapic::Operation
delete_saved_query
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The resource name of the SavedQuery to delete.
Format:
projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::DeleteSavedQueryRequest.new # Call the delete_saved_query method. result = client.delete_saved_query request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#export_data
def export_data(request, options = nil) -> ::Gapic::Operation
def export_data(name: nil, export_config: nil) -> ::Gapic::Operation
Exports data from a Dataset.
def export_data(request, options = nil) -> ::Gapic::Operation
export_data
via a request object, either of type
ExportDataRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::ExportDataRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def export_data(name: nil, export_config: nil) -> ::Gapic::Operation
export_data
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The name of the Dataset resource.
Format:
projects/{project}/locations/{location}/datasets/{dataset}
- export_config (::Google::Cloud::AIPlatform::V1::ExportDataConfig, ::Hash) — Required. The desired output location.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::ExportDataRequest.new # Call the export_data method. result = client.export_data request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#get_annotation_spec
def get_annotation_spec(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::AnnotationSpec
def get_annotation_spec(name: nil, read_mask: nil) -> ::Google::Cloud::AIPlatform::V1::AnnotationSpec
Gets an AnnotationSpec.
def get_annotation_spec(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::AnnotationSpec
get_annotation_spec
via a request object, either of type
GetAnnotationSpecRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::GetAnnotationSpecRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_annotation_spec(name: nil, read_mask: nil) -> ::Google::Cloud::AIPlatform::V1::AnnotationSpec
get_annotation_spec
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The name of the AnnotationSpec resource.
Format:
projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}
- read_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask specifying which fields to read.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::AIPlatform::V1::AnnotationSpec)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::GetAnnotationSpecRequest.new # Call the get_annotation_spec method. result = client.get_annotation_spec request # The returned object is of type Google::Cloud::AIPlatform::V1::AnnotationSpec. p result
#get_dataset
def get_dataset(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::Dataset
def get_dataset(name: nil, read_mask: nil) -> ::Google::Cloud::AIPlatform::V1::Dataset
Gets a Dataset.
def get_dataset(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::Dataset
get_dataset
via a request object, either of type
GetDatasetRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::GetDatasetRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_dataset(name: nil, read_mask: nil) -> ::Google::Cloud::AIPlatform::V1::Dataset
get_dataset
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- name (::String) — Required. The name of the Dataset resource.
- read_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask specifying which fields to read.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::AIPlatform::V1::Dataset)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::GetDatasetRequest.new # Call the get_dataset method. result = client.get_dataset request # The returned object is of type Google::Cloud::AIPlatform::V1::Dataset. p result
#get_dataset_version
def get_dataset_version(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::DatasetVersion
def get_dataset_version(name: nil, read_mask: nil) -> ::Google::Cloud::AIPlatform::V1::DatasetVersion
Gets a Dataset version.
def get_dataset_version(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::DatasetVersion
get_dataset_version
via a request object, either of type
GetDatasetVersionRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::GetDatasetVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_dataset_version(name: nil, read_mask: nil) -> ::Google::Cloud::AIPlatform::V1::DatasetVersion
get_dataset_version
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The resource name of the Dataset version to delete.
Format:
projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}
- read_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask specifying which fields to read.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::AIPlatform::V1::DatasetVersion)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::GetDatasetVersionRequest.new # Call the get_dataset_version method. result = client.get_dataset_version request # The returned object is of type Google::Cloud::AIPlatform::V1::DatasetVersion. p result
#iam_policy_client
def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client
Get the associated client for mix-in of the IAMPolicy.
- (Google::Iam::V1::IAMPolicy::Client)
#import_data
def import_data(request, options = nil) -> ::Gapic::Operation
def import_data(name: nil, import_configs: nil) -> ::Gapic::Operation
Imports data into a Dataset.
def import_data(request, options = nil) -> ::Gapic::Operation
import_data
via a request object, either of type
ImportDataRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::ImportDataRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def import_data(name: nil, import_configs: nil) -> ::Gapic::Operation
import_data
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The name of the Dataset resource.
Format:
projects/{project}/locations/{location}/datasets/{dataset}
- import_configs (::Array<::Google::Cloud::AIPlatform::V1::ImportDataConfig, ::Hash>) — Required. The desired input locations. The contents of all input locations will be imported in one batch.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::ImportDataRequest.new # Call the import_data method. result = client.import_data request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#initialize
def initialize() { |config| ... } -> Client
Create a new DatasetService client object.
- (config) — Configure the DatasetService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::AIPlatform::V1::DatasetService::Client.new do |config| config.timeout = 10.0 end
#list_annotations
def list_annotations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Annotation>
def list_annotations(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Annotation>
Lists Annotations belongs to a dataitem
def list_annotations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Annotation>
list_annotations
via a request object, either of type
ListAnnotationsRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::ListAnnotationsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_annotations(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Annotation>
list_annotations
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The resource name of the DataItem to list Annotations from.
Format:
projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}
- filter (::String) — The standard list filter.
- page_size (::Integer) — The standard list page size.
- page_token (::String) — The standard list page token.
- read_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask specifying which fields to read.
- order_by (::String) — A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Annotation>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Annotation>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::ListAnnotationsRequest.new # Call the list_annotations method. result = client.list_annotations request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::AIPlatform::V1::Annotation. p item end
#list_data_items
def list_data_items(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataItem>
def list_data_items(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataItem>
Lists DataItems in a Dataset.
def list_data_items(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataItem>
list_data_items
via a request object, either of type
ListDataItemsRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::ListDataItemsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_data_items(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataItem>
list_data_items
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The resource name of the Dataset to list DataItems from.
Format:
projects/{project}/locations/{location}/datasets/{dataset}
- filter (::String) — The standard list filter.
- page_size (::Integer) — The standard list page size.
- page_token (::String) — The standard list page token.
- read_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask specifying which fields to read.
- order_by (::String) — A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataItem>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataItem>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::ListDataItemsRequest.new # Call the list_data_items method. result = client.list_data_items request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::AIPlatform::V1::DataItem. p item end
#list_dataset_versions
def list_dataset_versions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DatasetVersion>
def list_dataset_versions(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DatasetVersion>
Lists DatasetVersions in a Dataset.
def list_dataset_versions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DatasetVersion>
list_dataset_versions
via a request object, either of type
ListDatasetVersionsRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::ListDatasetVersionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_dataset_versions(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DatasetVersion>
list_dataset_versions
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The resource name of the Dataset to list DatasetVersions from.
Format:
projects/{project}/locations/{location}/datasets/{dataset}
- filter (::String) — Optional. The standard list filter.
- page_size (::Integer) — Optional. The standard list page size.
- page_token (::String) — Optional. The standard list page token.
- read_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Mask specifying which fields to read.
- order_by (::String) — Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DatasetVersion>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DatasetVersion>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::ListDatasetVersionsRequest.new # Call the list_dataset_versions method. result = client.list_dataset_versions request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::AIPlatform::V1::DatasetVersion. p item end
#list_datasets
def list_datasets(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Dataset>
def list_datasets(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Dataset>
Lists Datasets in a Location.
def list_datasets(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Dataset>
list_datasets
via a request object, either of type
ListDatasetsRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::ListDatasetsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_datasets(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Dataset>
list_datasets
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The name of the Dataset's parent resource.
Format:
projects/{project}/locations/{location}
-
filter (::String) —
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"
- page_size (::Integer) — The standard list page size.
- page_token (::String) — The standard list page token.
- read_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask specifying which fields to read.
-
order_by (::String) —
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
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Dataset>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::Dataset>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::ListDatasetsRequest.new # Call the list_datasets method. result = client.list_datasets request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::AIPlatform::V1::Dataset. p item end
#list_saved_queries
def list_saved_queries(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::SavedQuery>
def list_saved_queries(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::SavedQuery>
Lists SavedQueries in a Dataset.
def list_saved_queries(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::SavedQuery>
list_saved_queries
via a request object, either of type
ListSavedQueriesRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::ListSavedQueriesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_saved_queries(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::SavedQuery>
list_saved_queries
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The resource name of the Dataset to list SavedQueries from.
Format:
projects/{project}/locations/{location}/datasets/{dataset}
- filter (::String) — The standard list filter.
- page_size (::Integer) — The standard list page size.
- page_token (::String) — The standard list page token.
- read_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask specifying which fields to read.
- order_by (::String) — A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::SavedQuery>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::SavedQuery>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::ListSavedQueriesRequest.new # Call the list_saved_queries method. result = client.list_saved_queries request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::AIPlatform::V1::SavedQuery. p item end
#location_client
def location_client() -> Google::Cloud::Location::Locations::Client
Get the associated client for mix-in of the Locations.
- (Google::Cloud::Location::Locations::Client)
#operations_client
def operations_client() -> ::Google::Cloud::AIPlatform::V1::DatasetService::Operations
Get the associated client for long-running operations.
#restore_dataset_version
def restore_dataset_version(request, options = nil) -> ::Gapic::Operation
def restore_dataset_version(name: nil) -> ::Gapic::Operation
Restores a dataset version.
def restore_dataset_version(request, options = nil) -> ::Gapic::Operation
restore_dataset_version
via a request object, either of type
RestoreDatasetVersionRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::RestoreDatasetVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def restore_dataset_version(name: nil) -> ::Gapic::Operation
restore_dataset_version
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The name of the DatasetVersion resource.
Format:
projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::RestoreDatasetVersionRequest.new # Call the restore_dataset_version method. result = client.restore_dataset_version request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#search_data_items
def search_data_items(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataItemView>
def search_data_items(order_by_data_item: nil, order_by_annotation: nil, dataset: nil, saved_query: nil, data_labeling_job: nil, data_item_filter: nil, annotations_filter: nil, annotation_filters: nil, field_mask: nil, annotations_limit: nil, page_size: nil, order_by: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataItemView>
Searches DataItems in a Dataset.
def search_data_items(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataItemView>
search_data_items
via a request object, either of type
SearchDataItemsRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def search_data_items(order_by_data_item: nil, order_by_annotation: nil, dataset: nil, saved_query: nil, data_labeling_job: nil, data_item_filter: nil, annotations_filter: nil, annotation_filters: nil, field_mask: nil, annotations_limit: nil, page_size: nil, order_by: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataItemView>
search_data_items
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- order_by_data_item (::String) — A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
- order_by_annotation (::Google::Cloud::AIPlatform::V1::SearchDataItemsRequest::OrderByAnnotation, ::Hash) — Expression that allows ranking results based on annotation's property.
-
dataset (::String) — Required. The resource name of the Dataset from which to search DataItems.
Format:
projects/{project}/locations/{location}/datasets/{dataset}
-
saved_query (::String) — The resource name of a SavedQuery(annotation set in UI).
Format:
projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}
All of the search will be done in the context of this SavedQuery. -
data_labeling_job (::String) — The resource name of a DataLabelingJob.
Format:
projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}
If this field is set, all of the search will be done in the context of this DataLabelingJob. -
data_item_filter (::String) —
An expression for filtering the DataItem that will be returned.
data_item_id
- for = or !=.labeled
- for = or !=.has_annotation(ANNOTATION_SPEC_ID)
- true only for DataItem that have at least one annotation with annotation_spec_id =ANNOTATION_SPEC_ID
in the context of SavedQuery or DataLabelingJob.
For example:
data_item=1
has_annotation(5)
-
annotations_filter (::String) —
An expression for filtering the Annotations that will be returned per DataItem.
annotation_spec_id
- for = or !=.
-
annotation_filters (::Array<::String>) —
An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned.
annotation_spec_id
- for = or !=. Must specifysaved_query_id=
- saved query id that annotations should belong to.
- field_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask specifying which fields of DataItemView to read.
- annotations_limit (::Integer) — If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used.
- page_size (::Integer) — Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.
- order_by (::String) — A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
- page_token (::String) — A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataItemView>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::DataItemView>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::SearchDataItemsRequest.new # Call the search_data_items method. result = client.search_data_items request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::AIPlatform::V1::DataItemView. p item end
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_dataset
def update_dataset(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::Dataset
def update_dataset(dataset: nil, update_mask: nil) -> ::Google::Cloud::AIPlatform::V1::Dataset
Updates a Dataset.
def update_dataset(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::Dataset
update_dataset
via a request object, either of type
UpdateDatasetRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::UpdateDatasetRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_dataset(dataset: nil, update_mask: nil) -> ::Google::Cloud::AIPlatform::V1::Dataset
update_dataset
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- dataset (::Google::Cloud::AIPlatform::V1::Dataset, ::Hash) — Required. The Dataset which replaces the resource on the server.
-
update_mask (::Google::Protobuf::FieldMask, ::Hash) —
Required. The update mask applies to the resource. For the
FieldMask
definition, see google.protobuf.FieldMask. Updatable fields:display_name
description
labels
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::AIPlatform::V1::Dataset)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::UpdateDatasetRequest.new # Call the update_dataset method. result = client.update_dataset request # The returned object is of type Google::Cloud::AIPlatform::V1::Dataset. p result
#update_dataset_version
def update_dataset_version(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::DatasetVersion
def update_dataset_version(dataset_version: nil, update_mask: nil) -> ::Google::Cloud::AIPlatform::V1::DatasetVersion
Updates a DatasetVersion.
def update_dataset_version(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::DatasetVersion
update_dataset_version
via a request object, either of type
UpdateDatasetVersionRequest or an equivalent Hash.
- request (::Google::Cloud::AIPlatform::V1::UpdateDatasetVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_dataset_version(dataset_version: nil, update_mask: nil) -> ::Google::Cloud::AIPlatform::V1::DatasetVersion
update_dataset_version
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- dataset_version (::Google::Cloud::AIPlatform::V1::DatasetVersion, ::Hash) — Required. The DatasetVersion which replaces the resource on the server.
-
update_mask (::Google::Protobuf::FieldMask, ::Hash) —
Required. The update mask applies to the resource. For the
FieldMask
definition, see google.protobuf.FieldMask. Updatable fields:display_name
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::AIPlatform::V1::DatasetVersion)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/ai_platform/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::AIPlatform::V1::DatasetService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::AIPlatform::V1::UpdateDatasetVersionRequest.new # Call the update_dataset_version method. result = client.update_dataset_version request # The returned object is of type Google::Cloud::AIPlatform::V1::DatasetVersion. p result