Class: Google::Apis::AiplatformV1::AiplatformService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/aiplatform_v1/service.rb

Overview

Vertex AI API

Train high-quality custom machine learning models with minimal machine learning expertise and effort.

Examples:

require 'google/apis/aiplatform_v1'

Aiplatform = Google::Apis::AiplatformV1 # Alias the module
service = Aiplatform::AiplatformService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE =
"https://aiplatform.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeAiplatformService

Returns a new instance of AiplatformService.



48
49
50
51
52
53
# File 'lib/google/apis/aiplatform_v1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-aiplatform_v1',
        client_version: Google::Apis::AiplatformV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns 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.

Returns:

  • (String)

    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.



41
42
43
# File 'lib/google/apis/aiplatform_v1/service.rb', line 41

def key
  @key
end

#quota_userString

Returns 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.

Returns:

  • (String)

    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.



46
47
48
# File 'lib/google/apis/aiplatform_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#add_project_location_metadata_store_context_context_artifacts_and_executions(context, google_cloud_aiplatform_v1_add_context_artifacts_and_executions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse

Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.

Parameters:

  • context (String)

    Required. The resource name of the Context that the Artifacts and Executions belong to. Format: projects/project/locations/location/metadataStores/ metadatastore/contexts/context``

  • google_cloud_aiplatform_v1_add_context_artifacts_and_executions_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10570

def (context, google_cloud_aiplatform_v1_add_context_artifacts_and_executions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+context}:addContextArtifactsAndExecutions', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_add_context_artifacts_and_executions_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse
  command.params['context'] = context unless context.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#add_project_location_metadata_store_context_context_children(context, google_cloud_aiplatform_v1_add_context_children_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AddContextChildrenResponse

Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.

Parameters:

  • context (String)

    Required. The resource name of the parent Context. Format: projects/project/ locations/location/metadataStores/metadatastore/contexts/context``

  • google_cloud_aiplatform_v1_add_context_children_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AddContextChildrenRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10607

def (context, google_cloud_aiplatform_v1_add_context_children_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+context}:addContextChildren', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AddContextChildrenRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_add_context_children_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AddContextChildrenResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AddContextChildrenResponse
  command.params['context'] = context unless context.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#add_project_location_metadata_store_execution_execution_events(execution, google_cloud_aiplatform_v1_add_execution_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AddExecutionEventsResponse

Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.

Parameters:

  • execution (String)

    Required. The resource name of the Execution that the Events connect Artifacts with. Format: projects/project/locations/location/metadataStores/ metadatastore/executions/execution``

  • google_cloud_aiplatform_v1_add_execution_events_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AddExecutionEventsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11156

def (execution, google_cloud_aiplatform_v1_add_execution_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+execution}:addExecutionEvents', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AddExecutionEventsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_add_execution_events_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AddExecutionEventsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AddExecutionEventsResponse
  command.params['execution'] = execution unless execution.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#add_project_location_study_trial_trial_measurement(trial_name, google_cloud_aiplatform_v1_add_trial_measurement_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial

Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.

Parameters:

  • trial_name (String)

    Required. The name of the trial to add measurement. Format: projects/project /locations/location/studies/study/trials/trial``

  • google_cloud_aiplatform_v1_add_trial_measurement_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AddTrialMeasurementRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17996
17997
17998
17999
18000
18001
18002
18003
18004
18005
18006
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17996

def add_project_location_study_trial_trial_measurement(trial_name, google_cloud_aiplatform_v1_add_trial_measurement_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+trialName}:addTrialMeasurement', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AddTrialMeasurementRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_add_trial_measurement_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial
  command.params['trialName'] = trial_name unless trial_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#assign_project_location_notebook_runtime(parent, google_cloud_aiplatform_v1_assign_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.

Parameters:

  • parent (String)

    Required. The resource name of the Location to get the NotebookRuntime assignment. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_assign_notebook_runtime_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AssignNotebookRuntimeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14957
14958
14959
14960
14961
14962
14963
14964
14965
14966
14967
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14957

def assign_project_location_notebook_runtime(parent, google_cloud_aiplatform_v1_assign_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/notebookRuntimes:assign', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AssignNotebookRuntimeRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_assign_notebook_runtime_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_location_feature_group_feature_create(parent, google_cloud_aiplatform_v1_batch_create_features_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a batch of Features in a given FeatureGroup.

Parameters:

  • parent (String)

    Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: projects/project/locations/location/ featurestores/featurestore/entityTypes/entity_type`projects/`project`/ locations/`location`/featureGroups/`feature_group

  • google_cloud_aiplatform_v1_batch_create_features_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchCreateFeaturesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5011

def batch_project_location_feature_group_feature_create(parent, google_cloud_aiplatform_v1_batch_create_features_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/features:batchCreate', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchCreateFeaturesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_batch_create_features_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_location_featurestore_entity_type_feature_create(parent, google_cloud_aiplatform_v1_batch_create_features_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a batch of Features in a given EntityType.

Parameters:

  • parent (String)

    Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: projects/project/locations/location/ featurestores/featurestore/entityTypes/entity_type`projects/`project`/ locations/`location`/featureGroups/`feature_group

  • google_cloud_aiplatform_v1_batch_create_features_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchCreateFeaturesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7755

def batch_project_location_featurestore_entity_type_feature_create(parent, google_cloud_aiplatform_v1_batch_create_features_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/features:batchCreate', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchCreateFeaturesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_batch_create_features_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_location_featurestore_read_feature_values(featurestore, google_cloud_aiplatform_v1_batch_read_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.

Parameters:

  • featurestore (String)

    Required. The resource name of the Featurestore from which to query Feature values. Format: projects/project/locations/location/featurestores/ featurestore``

  • google_cloud_aiplatform_v1_batch_read_feature_values_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchReadFeatureValuesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6728

def batch_project_location_featurestore_read_feature_values(featurestore, google_cloud_aiplatform_v1_batch_read_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+featurestore}:batchReadFeatureValues', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchReadFeatureValuesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_batch_read_feature_values_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['featurestore'] = featurestore unless featurestore.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_location_migratable_resource_migrate(parent, google_cloud_aiplatform_v1_batch_migrate_resources_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.

Parameters:

  • parent (String)

    Required. The location of the migrated resource will live in. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_batch_migrate_resources_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchMigrateResourcesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11964

def batch_project_location_migratable_resource_migrate(parent, google_cloud_aiplatform_v1_batch_migrate_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/migratableResources:batchMigrate', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchMigrateResourcesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_batch_migrate_resources_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_location_model_evaluation_slice_import(parent, google_cloud_aiplatform_v1_batch_import_evaluated_annotations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse

Imports a list of externally generated EvaluatedAnnotations.

Parameters:

  • parent (String)

    Required. The name of the parent ModelEvaluationSlice resource. Format: projects/project/locations/location/models/model/evaluations/evaluation /slices/slice``

  • google_cloud_aiplatform_v1_batch_import_evaluated_annotations_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13557

def batch_project_location_model_evaluation_slice_import(parent, google_cloud_aiplatform_v1_batch_import_evaluated_annotations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}:batchImport', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_batch_import_evaluated_annotations_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_location_pipeline_job_cancel(parent, google_cloud_aiplatform_v1_batch_cancel_pipeline_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.

Parameters:

  • parent (String)

    Required. The name of the PipelineJobs' parent resource. Format: projects/ project/locations/location``

  • google_cloud_aiplatform_v1_batch_cancel_pipeline_jobs_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16001
16002
16003
16004
16005
16006
16007
16008
16009
16010
16011
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16001

def batch_project_location_pipeline_job_cancel(parent, google_cloud_aiplatform_v1_batch_cancel_pipeline_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/pipelineJobs:batchCancel', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_batch_cancel_pipeline_jobs_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_location_pipeline_job_delete(parent, google_cloud_aiplatform_v1_batch_delete_pipeline_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.

Parameters:

  • parent (String)

    Required. The name of the PipelineJobs' parent resource. Format: projects/ project/locations/location``

  • google_cloud_aiplatform_v1_batch_delete_pipeline_jobs_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16036
16037
16038
16039
16040
16041
16042
16043
16044
16045
16046
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16036

def batch_project_location_pipeline_job_delete(parent, google_cloud_aiplatform_v1_batch_delete_pipeline_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/pipelineJobs:batchDelete', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_batch_delete_pipeline_jobs_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_location_tensorboard_experiment_create(parent, google_cloud_aiplatform_v1_batch_create_tensorboard_time_series_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

Parameters:

  • parent (String)

    Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: projects/project/locations/location/ tensorboards/tensorboard/experiments/experiment`` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.

  • google_cloud_aiplatform_v1_batch_create_tensorboard_time_series_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18819
18820
18821
18822
18823
18824
18825
18826
18827
18828
18829
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18819

def batch_project_location_tensorboard_experiment_create(parent, google_cloud_aiplatform_v1_batch_create_tensorboard_time_series_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}:batchCreate', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_batch_create_tensorboard_time_series_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_location_tensorboard_experiment_run_create(parent, google_cloud_aiplatform_v1_batch_create_tensorboard_runs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse

Batch create TensorboardRuns.

Parameters:

  • parent (String)

    Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: projects/project/locations/location/ tensorboards/tensorboard/experiments/experiment`` The parent field in the CreateTensorboardRunRequest messages must match this field.

  • google_cloud_aiplatform_v1_batch_create_tensorboard_runs_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19270
19271
19272
19273
19274
19275
19276
19277
19278
19279
19280
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19270

def batch_project_location_tensorboard_experiment_run_create(parent, google_cloud_aiplatform_v1_batch_create_tensorboard_runs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/runs:batchCreate', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_batch_create_tensorboard_runs_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#batch_project_location_tensorboard_read(tensorboard, time_series: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse

Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.

Parameters:

  • tensorboard (String)

    Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: projects/project/locations/ location/tensorboards/tensorboard``. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.

  • time_series (Array<String>, String) (defaults to: nil)

    Required. The resource names of the TensorboardTimeSeries to read data from. Format: projects/project/locations/location/tensorboards/tensorboard/ experiments/experiment/runs/run/timeSeries/time_series``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18533
18534
18535
18536
18537
18538
18539
18540
18541
18542
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18533

def batch_project_location_tensorboard_read(tensorboard, time_series: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+tensorboard}:batchRead', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse
  command.params['tensorboard'] = tensorboard unless tensorboard.nil?
  command.query['timeSeries'] = time_series unless time_series.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_batch_prediction_job(name, google_cloud_aiplatform_v1_cancel_batch_prediction_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to CANCELLED. Any files already outputted by the job are not deleted.

Parameters:

  • name (String)

    Required. The name of the BatchPredictionJob to cancel. Format: projects/ project/locations/location/batchPredictionJobs/batch_prediction_job``

  • google_cloud_aiplatform_v1_cancel_batch_prediction_job_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelBatchPredictionJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



800
801
802
803
804
805
806
807
808
809
810
# File 'lib/google/apis/aiplatform_v1/service.rb', line 800

def cancel_project_location_batch_prediction_job(name, google_cloud_aiplatform_v1_cancel_batch_prediction_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelBatchPredictionJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_cancel_batch_prediction_job_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_custom_job(name, google_cloud_aiplatform_v1_cancel_custom_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and CustomJob.state is set to CANCELLED.

Parameters:

  • name (String)

    Required. The name of the CustomJob to cancel. Format: projects/project/ locations/location/customJobs/custom_job``

  • google_cloud_aiplatform_v1_cancel_custom_job_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelCustomJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



992
993
994
995
996
997
998
999
1000
1001
1002
# File 'lib/google/apis/aiplatform_v1/service.rb', line 992

def cancel_project_location_custom_job(name, google_cloud_aiplatform_v1_cancel_custom_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelCustomJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_cancel_custom_job_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_custom_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1180
1181
1182
1183
1184
1185
1186
1187
1188
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1180

def cancel_project_location_custom_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_data_labeling_job(name, google_cloud_aiplatform_v1_cancel_data_labeling_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Cancels a DataLabelingJob. Success of cancellation is not guaranteed.

Parameters:

  • name (String)

    Required. The name of the DataLabelingJob. Format: projects/project/ locations/location/dataLabelingJobs/data_labeling_job``

  • google_cloud_aiplatform_v1_cancel_data_labeling_job_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelDataLabelingJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1358

def cancel_project_location_data_labeling_job(name, google_cloud_aiplatform_v1_cancel_data_labeling_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelDataLabelingJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_cancel_data_labeling_job_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_data_labeling_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1551
1552
1553
1554
1555
1556
1557
1558
1559
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1551

def cancel_project_location_data_labeling_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_dataset_annotation_spec_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2118
2119
2120
2121
2122
2123
2124
2125
2126
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2118

def cancel_project_location_dataset_annotation_spec_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_dataset_data_item_annotation_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2398
2399
2400
2401
2402
2403
2404
2405
2406
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2398

def cancel_project_location_dataset_data_item_annotation_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_dataset_data_item_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2581
2582
2583
2584
2585
2586
2587
2588
2589
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2581

def cancel_project_location_dataset_data_item_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_dataset_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2980
2981
2982
2983
2984
2985
2986
2987
2988
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2980

def cancel_project_location_dataset_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_dataset_saved_query_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3241
3242
3243
3244
3245
3246
3247
3248
3249
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3241

def cancel_project_location_dataset_saved_query_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_deployment_resource_pool_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3643
3644
3645
3646
3647
3648
3649
3650
3651
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3643

def cancel_project_location_deployment_resource_pool_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_endpoint_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4626
4627
4628
4629
4630
4631
4632
4633
4634
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4626

def cancel_project_location_endpoint_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_featurestore_entity_type_feature_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8025
8026
8027
8028
8029
8030
8031
8032
8033
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8025

def cancel_project_location_featurestore_entity_type_feature_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_featurestore_entity_type_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8208
8209
8210
8211
8212
8213
8214
8215
8216
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8208

def cancel_project_location_featurestore_entity_type_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_featurestore_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8391
8392
8393
8394
8395
8396
8397
8398
8399
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8391

def cancel_project_location_featurestore_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_hyperparameter_tuning_job(name, google_cloud_aiplatform_v1_cancel_hyperparameter_tuning_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService. GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and HyperparameterTuningJob.state is set to CANCELLED.

Parameters:

  • name (String)

    Required. The name of the HyperparameterTuningJob to cancel. Format: projects/ project/locations/location/hyperparameterTuningJobs/ hyperparameter_tuning_job``

  • google_cloud_aiplatform_v1_cancel_hyperparameter_tuning_job_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8578

def cancel_project_location_hyperparameter_tuning_job(name, google_cloud_aiplatform_v1_cancel_hyperparameter_tuning_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_cancel_hyperparameter_tuning_job_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_hyperparameter_tuning_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8769
8770
8771
8772
8773
8774
8775
8776
8777
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8769

def cancel_project_location_hyperparameter_tuning_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_index_endpoint_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9315
9316
9317
9318
9319
9320
9321
9322
9323
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9315

def cancel_project_location_index_endpoint_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_index_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9744
9745
9746
9747
9748
9749
9750
9751
9752
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9744

def cancel_project_location_index_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_metadata_store_artifact_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10390
10391
10392
10393
10394
10395
10396
10397
10398
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10390

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_metadata_store_context_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10975
10976
10977
10978
10979
10980
10981
10982
10983
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10975

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_metadata_store_execution_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11482
11483
11484
11485
11486
11487
11488
11489
11490
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11482

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_metadata_store_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11785
11786
11787
11788
11789
11790
11791
11792
11793
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11785

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_migratable_resource_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12040
12041
12042
12043
12044
12045
12046
12047
12048
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12040

def cancel_project_location_migratable_resource_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_model_deployment_monitoring_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12535
12536
12537
12538
12539
12540
12541
12542
12543
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12535

def cancel_project_location_model_deployment_monitoring_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_model_evaluation_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13378
13379
13380
13381
13382
13383
13384
13385
13386
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13378

def cancel_project_location_model_evaluation_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_model_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13674
13675
13676
13677
13678
13679
13680
13681
13682
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13674

def cancel_project_location_model_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_nas_job(name, google_cloud_aiplatform_v1_cancel_nas_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and NasJob.state is set to CANCELLED.

Parameters:

  • name (String)

    Required. The name of the NasJob to cancel. Format: projects/project/ locations/location/nasJobs/nas_job``

  • google_cloud_aiplatform_v1_cancel_nas_job_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelNasJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13858
13859
13860
13861
13862
13863
13864
13865
13866
13867
13868
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13858

def cancel_project_location_nas_job(name, google_cloud_aiplatform_v1_cancel_nas_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelNasJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_cancel_nas_job_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_notebook_execution_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14272
14273
14274
14275
14276
14277
14278
14279
14280
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14272

def cancel_project_location_notebook_execution_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_notebook_runtime_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15240
15241
15242
15243
15244
15245
15246
15247
15248
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15240

def cancel_project_location_notebook_runtime_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_notebook_runtime_template_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14778
14779
14780
14781
14782
14783
14784
14785
14786
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14778

def cancel_project_location_notebook_runtime_template_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15423
15424
15425
15426
15427
15428
15429
15430
15431
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15423

def cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_persistent_resource_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15819
15820
15821
15822
15823
15824
15825
15826
15827
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15819

def cancel_project_location_persistent_resource_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_pipeline_job(name, google_cloud_aiplatform_v1_cancel_pipeline_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and PipelineJob.state is set to CANCELLED.

Parameters:

  • name (String)

    Required. The name of the PipelineJob to cancel. Format: projects/project/ locations/location/pipelineJobs/pipeline_job``

  • google_cloud_aiplatform_v1_cancel_pipeline_job_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelPipelineJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16077
16078
16079
16080
16081
16082
16083
16084
16085
16086
16087
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16077

def cancel_project_location_pipeline_job(name, google_cloud_aiplatform_v1_cancel_pipeline_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelPipelineJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_cancel_pipeline_job_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_pipeline_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16291
16292
16293
16294
16295
16296
16297
16298
16299
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16291

def cancel_project_location_pipeline_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_schedule_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17102
17103
17104
17105
17106
17107
17108
17109
17110
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17102

def cancel_project_location_schedule_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_specialist_pool_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17464
17465
17466
17467
17468
17469
17470
17471
17472
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17464

def cancel_project_location_specialist_pool_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_study_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17817
17818
17819
17820
17821
17822
17823
17824
17825
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17817

def cancel_project_location_study_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_study_trial_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18346
18347
18348
18349
18350
18351
18352
18353
18354
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18346

def cancel_project_location_study_trial_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_tensorboard_experiment_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19090
19091
19092
19093
19094
19095
19096
19097
19098
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19090

def cancel_project_location_tensorboard_experiment_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_tensorboard_experiment_run_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19542
19543
19544
19545
19546
19547
19548
19549
19550
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19542

def cancel_project_location_tensorboard_experiment_run_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_tensorboard_experiment_run_time_series_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20035
20036
20037
20038
20039
20040
20041
20042
20043
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20035

def cancel_project_location_tensorboard_experiment_run_time_series_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_tensorboard_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20218
20219
20220
20221
20222
20223
20224
20225
20226
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20218

def cancel_project_location_tensorboard_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_training_pipeline(name, google_cloud_aiplatform_v1_cancel_training_pipeline_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and TrainingPipeline.state is set to CANCELLED.

Parameters:

  • name (String)

    Required. The name of the TrainingPipeline to cancel. Format: projects/ project/locations/location/trainingPipelines/training_pipeline``

  • google_cloud_aiplatform_v1_cancel_training_pipeline_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelTrainingPipelineRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20403
20404
20405
20406
20407
20408
20409
20410
20411
20412
20413
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20403

def cancel_project_location_training_pipeline(name, google_cloud_aiplatform_v1_cancel_training_pipeline_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelTrainingPipelineRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_cancel_training_pipeline_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_training_pipeline_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20594
20595
20596
20597
20598
20599
20600
20601
20602
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20594

def cancel_project_location_training_pipeline_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_tuning_job(name, google_cloud_aiplatform_v1_cancel_tuning_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status. code of 1, corresponding to Code.CANCELLED, and TuningJob.state is set to CANCELLED.

Parameters:

  • name (String)

    Required. The name of the TuningJob to cancel. Format: projects/project/ locations/location/tuningJobs/tuning_job``

  • google_cloud_aiplatform_v1_cancel_tuning_job_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelTuningJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20779
20780
20781
20782
20783
20784
20785
20786
20787
20788
20789
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20779

def cancel_project_location_tuning_job(name, google_cloud_aiplatform_v1_cancel_tuning_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelTuningJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_cancel_tuning_job_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_project_location_tuning_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20959
20960
20961
20962
20963
20964
20965
20966
20967
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20959

def cancel_project_location_tuning_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#check_project_location_study_trial_trial_early_stopping_state(trial_name, google_cloud_aiplatform_v1_check_trial_early_stopping_state_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.

Parameters:

  • trial_name (String)

    Required. The Trial's name. Format: projects/project/locations/location/ studies/study/trials/trial``

  • google_cloud_aiplatform_v1_check_trial_early_stopping_state_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18032
18033
18034
18035
18036
18037
18038
18039
18040
18041
18042
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18032

def check_project_location_study_trial_trial_early_stopping_state(trial_name, google_cloud_aiplatform_v1_check_trial_early_stopping_state_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+trialName}:checkTrialEarlyStoppingState', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_check_trial_early_stopping_state_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['trialName'] = trial_name unless trial_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#complete_project_location_study_trial(name, google_cloud_aiplatform_v1_complete_trial_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial

Marks a Trial as complete.

Parameters:

  • name (String)

    Required. The Trial's name. Format: projects/project/locations/location/ studies/study/trials/trial``

  • google_cloud_aiplatform_v1_complete_trial_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CompleteTrialRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18066
18067
18068
18069
18070
18071
18072
18073
18074
18075
18076
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18066

def complete_project_location_study_trial(name, google_cloud_aiplatform_v1_complete_trial_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:complete', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CompleteTrialRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_complete_trial_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#completions_project_location_endpoint_chat(endpoint, google_api_http_body_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleApiHttpBody

Exposes an OpenAI-compatible endpoint for chat completions.

Parameters:

  • endpoint (String)

    Required. The name of the endpoint requested to serve the prediction. Format: projects/project/locations/location/endpoints/endpoint``

  • google_api_http_body_object (Google::Apis::AiplatformV1::GoogleApiHttpBody) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4587

def completions_project_location_endpoint_chat(endpoint, google_api_http_body_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}/chat/completions', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleApiHttpBody::Representation
  command.request_object = google_api_http_body_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleApiHttpBody
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#compute_endpoint_tokens(endpoint, google_cloud_aiplatform_v1_compute_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensResponse

Return a list of tokens based on the input text.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to get lists of tokens and token ids.

  • google_cloud_aiplatform_v1_compute_tokens_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



483
484
485
486
487
488
489
490
491
492
493
# File 'lib/google/apis/aiplatform_v1/service.rb', line 483

def compute_endpoint_tokens(endpoint, google_cloud_aiplatform_v1_compute_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:computeTokens', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_compute_tokens_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensResponse
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#compute_project_location_endpoint_tokens(endpoint, google_cloud_aiplatform_v1_compute_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensResponse

Return a list of tokens based on the input text.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to get lists of tokens and token ids.

  • google_cloud_aiplatform_v1_compute_tokens_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3821

def compute_project_location_endpoint_tokens(endpoint, google_cloud_aiplatform_v1_compute_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:computeTokens', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_compute_tokens_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensResponse
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#compute_project_location_publisher_model_tokens(endpoint, google_cloud_aiplatform_v1_compute_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensResponse

Return a list of tokens based on the input text.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to get lists of tokens and token ids.

  • google_cloud_aiplatform_v1_compute_tokens_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16469
16470
16471
16472
16473
16474
16475
16476
16477
16478
16479
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16469

def compute_project_location_publisher_model_tokens(endpoint, google_cloud_aiplatform_v1_compute_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:computeTokens', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_compute_tokens_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensResponse
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#compute_publisher_model_tokens(endpoint, google_cloud_aiplatform_v1_compute_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensResponse

Return a list of tokens based on the input text.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to get lists of tokens and token ids.

  • google_cloud_aiplatform_v1_compute_tokens_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



21095
21096
21097
21098
21099
21100
21101
21102
21103
21104
21105
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21095

def compute_publisher_model_tokens(endpoint, google_cloud_aiplatform_v1_compute_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:computeTokens', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_compute_tokens_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ComputeTokensResponse
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#copy_project_location_model(parent, google_cloud_aiplatform_v1_copy_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region- agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.

Parameters:

  • parent (String)

    Required. The resource name of the Location into which to copy the Model. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_copy_model_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CopyModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12717

def copy_project_location_model(parent, google_cloud_aiplatform_v1_copy_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/models:copy', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CopyModelRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_copy_model_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#count_endpoint_tokens(endpoint, google_cloud_aiplatform_v1_count_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensResponse

Perform a token counting.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to perform token counting. Format: projects/project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_count_tokens_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



517
518
519
520
521
522
523
524
525
526
527
# File 'lib/google/apis/aiplatform_v1/service.rb', line 517

def count_endpoint_tokens(endpoint, google_cloud_aiplatform_v1_count_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:countTokens', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_count_tokens_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensResponse
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#count_project_location_endpoint_tokens(endpoint, google_cloud_aiplatform_v1_count_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensResponse

Perform a token counting.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to perform token counting. Format: projects/project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_count_tokens_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3855

def count_project_location_endpoint_tokens(endpoint, google_cloud_aiplatform_v1_count_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:countTokens', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_count_tokens_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensResponse
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#count_project_location_publisher_model_tokens(endpoint, google_cloud_aiplatform_v1_count_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensResponse

Perform a token counting.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to perform token counting. Format: projects/project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_count_tokens_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16503
16504
16505
16506
16507
16508
16509
16510
16511
16512
16513
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16503

def count_project_location_publisher_model_tokens(endpoint, google_cloud_aiplatform_v1_count_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:countTokens', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_count_tokens_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensResponse
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#count_publisher_model_tokens(endpoint, google_cloud_aiplatform_v1_count_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensResponse

Perform a token counting.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to perform token counting. Format: projects/project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_count_tokens_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



21129
21130
21131
21132
21133
21134
21135
21136
21137
21138
21139
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21129

def count_publisher_model_tokens(endpoint, google_cloud_aiplatform_v1_count_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:countTokens', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_count_tokens_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CountTokensResponse
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_dataset(google_cloud_aiplatform_v1_dataset_object = nil, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a Dataset.

Parameters:

  • google_cloud_aiplatform_v1_dataset_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset) (defaults to: nil)
  • parent (String) (defaults to: nil)

    Required. The resource name of the Location to create the Dataset in. Format: projects/project/locations/location``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



77
78
79
80
81
82
83
84
85
86
87
# File 'lib/google/apis/aiplatform_v1/service.rb', line 77

def create_dataset(google_cloud_aiplatform_v1_dataset_object = nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/datasets', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset::Representation
  command.request_object = google_cloud_aiplatform_v1_dataset_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.query['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_dataset_dataset_version(parent, google_cloud_aiplatform_v1_dataset_version_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Create a version from a Dataset.

Parameters:

  • parent (String)

    Required. The name of the Dataset resource. Format: projects/project/ locations/location/datasets/dataset``

  • google_cloud_aiplatform_v1_dataset_version_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



267
268
269
270
271
272
273
274
275
276
277
# File 'lib/google/apis/aiplatform_v1/service.rb', line 267

def create_dataset_dataset_version(parent, google_cloud_aiplatform_v1_dataset_version_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/datasetVersions', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion::Representation
  command.request_object = google_cloud_aiplatform_v1_dataset_version_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_batch_prediction_job(parent, google_cloud_aiplatform_v1_batch_prediction_job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchPredictionJob

Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create the BatchPredictionJob in. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_batch_prediction_job_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchPredictionJob) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



835
836
837
838
839
840
841
842
843
844
845
# File 'lib/google/apis/aiplatform_v1/service.rb', line 835

def create_project_location_batch_prediction_job(parent, google_cloud_aiplatform_v1_batch_prediction_job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/batchPredictionJobs', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchPredictionJob::Representation
  command.request_object = google_cloud_aiplatform_v1_batch_prediction_job_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchPredictionJob::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchPredictionJob
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_custom_job(parent, google_cloud_aiplatform_v1_custom_job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CustomJob

Creates a CustomJob. A created CustomJob right away will be attempted to be run.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create the CustomJob in. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_custom_job_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CustomJob) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1027

def create_project_location_custom_job(parent, google_cloud_aiplatform_v1_custom_job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/customJobs', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CustomJob::Representation
  command.request_object = google_cloud_aiplatform_v1_custom_job_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CustomJob::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CustomJob
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_data_labeling_job(parent, google_cloud_aiplatform_v1_data_labeling_job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DataLabelingJob

Creates a DataLabelingJob.

Parameters:

  • parent (String)

    Required. The parent of the DataLabelingJob. Format: projects/project/ locations/location``

  • google_cloud_aiplatform_v1_data_labeling_job_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DataLabelingJob) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1392

def create_project_location_data_labeling_job(parent, google_cloud_aiplatform_v1_data_labeling_job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/dataLabelingJobs', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DataLabelingJob::Representation
  command.request_object = google_cloud_aiplatform_v1_data_labeling_job_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DataLabelingJob::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DataLabelingJob
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_dataset(parent, google_cloud_aiplatform_v1_dataset_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a Dataset.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create the Dataset in. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_dataset_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1729

def create_project_location_dataset(parent, google_cloud_aiplatform_v1_dataset_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/datasets', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset::Representation
  command.request_object = google_cloud_aiplatform_v1_dataset_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_dataset_dataset_version(parent, google_cloud_aiplatform_v1_dataset_version_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Create a version from a Dataset.

Parameters:

  • parent (String)

    Required. The name of the Dataset resource. Format: projects/project/ locations/location/datasets/dataset``

  • google_cloud_aiplatform_v1_dataset_version_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2759

def create_project_location_dataset_dataset_version(parent, google_cloud_aiplatform_v1_dataset_version_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/datasetVersions', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion::Representation
  command.request_object = google_cloud_aiplatform_v1_dataset_version_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_deployment_resource_pool(parent, google_cloud_aiplatform_v1_create_deployment_resource_pool_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Create a DeploymentResourcePool.

Parameters:

  • parent (String)

    Required. The parent location resource where this DeploymentResourcePool will be created. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_create_deployment_resource_pool_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3419

def create_project_location_deployment_resource_pool(parent, google_cloud_aiplatform_v1_create_deployment_resource_pool_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/deploymentResourcePools', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_create_deployment_resource_pool_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_endpoint(parent, google_cloud_aiplatform_v1_endpoint_object = nil, endpoint_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates an Endpoint.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create the Endpoint in. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_endpoint_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Endpoint) (defaults to: nil)
  • endpoint_id (String) (defaults to: nil)

    Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are [a-z0-9-]. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are [0-9] with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as ?endpoint_id=12345. This is the fallback for fields that are not included in either the URI or the body.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3899

def create_project_location_endpoint(parent, google_cloud_aiplatform_v1_endpoint_object = nil, endpoint_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/endpoints', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Endpoint::Representation
  command.request_object = google_cloud_aiplatform_v1_endpoint_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['endpointId'] = endpoint_id unless endpoint_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_feature_group(parent, google_cloud_aiplatform_v1_feature_group_object = nil, feature_group_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a new FeatureGroup in a given project and location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create FeatureGroups. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_feature_group_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureGroup) (defaults to: nil)
  • feature_group_id (String) (defaults to: nil)

    Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are [a-z0-9_]. The first character cannot be a number. The value must be unique within the project and location.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4809

def create_project_location_feature_group(parent, google_cloud_aiplatform_v1_feature_group_object = nil, feature_group_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/featureGroups', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureGroup::Representation
  command.request_object = google_cloud_aiplatform_v1_feature_group_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['featureGroupId'] = feature_group_id unless feature_group_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_feature_group_feature(parent, google_cloud_aiplatform_v1_feature_object = nil, feature_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a new Feature in a given FeatureGroup.

Parameters:

  • parent (String)

    Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: projects/project/locations/ location/featurestores/featurestore/entityTypes/entity_typeFormat for feature_group as parent: `projects/`project`/locations/`location`/ featureGroups/`feature_group

  • google_cloud_aiplatform_v1_feature_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature) (defaults to: nil)
  • feature_id (String) (defaults to: nil)

    Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are [a-z0-9_]. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5053

def create_project_location_feature_group_feature(parent, google_cloud_aiplatform_v1_feature_object = nil, feature_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/features', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature::Representation
  command.request_object = google_cloud_aiplatform_v1_feature_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['featureId'] = feature_id unless feature_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_feature_online_store(parent, google_cloud_aiplatform_v1_feature_online_store_object = nil, feature_online_store_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a new FeatureOnlineStore in a given project and location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create FeatureOnlineStores. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_feature_online_store_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureOnlineStore) (defaults to: nil)
  • feature_online_store_id (String) (defaults to: nil)

    Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are [a-z0-9_]. The first character cannot be a number. The value must be unique within the project and location.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5573

def create_project_location_feature_online_store(parent, google_cloud_aiplatform_v1_feature_online_store_object = nil, feature_online_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/featureOnlineStores', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureOnlineStore::Representation
  command.request_object = google_cloud_aiplatform_v1_feature_online_store_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['featureOnlineStoreId'] = feature_online_store_id unless feature_online_store_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_feature_online_store_feature_view(parent, google_cloud_aiplatform_v1_feature_view_object = nil, feature_view_id: nil, run_sync_immediately: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a new FeatureView in a given FeatureOnlineStore.

Parameters:

  • parent (String)

    Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: projects/project/locations/location/featureOnlineStores/ feature_online_store``

  • google_cloud_aiplatform_v1_feature_view_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureView) (defaults to: nil)
  • feature_view_id (String) (defaults to: nil)

    Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are [a-z0-9_]. The first character cannot be a number. The value must be unique within a FeatureOnlineStore.

  • run_sync_immediately (Boolean) (defaults to: nil)

    Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5910

def create_project_location_feature_online_store_feature_view(parent, google_cloud_aiplatform_v1_feature_view_object = nil, feature_view_id: nil, run_sync_immediately: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/featureViews', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureView::Representation
  command.request_object = google_cloud_aiplatform_v1_feature_view_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['featureViewId'] = feature_view_id unless feature_view_id.nil?
  command.query['runSyncImmediately'] = run_sync_immediately unless run_sync_immediately.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_featurestore(parent, google_cloud_aiplatform_v1_featurestore_object = nil, featurestore_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a new Featurestore in a given project and location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create Featurestores. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_featurestore_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Featurestore) (defaults to: nil)
  • featurestore_id (String) (defaults to: nil)

    Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are [a-z0-9_]. The first character cannot be a number. The value must be unique within the project and location.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6767

def create_project_location_featurestore(parent, google_cloud_aiplatform_v1_featurestore_object = nil, featurestore_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/featurestores', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Featurestore::Representation
  command.request_object = google_cloud_aiplatform_v1_featurestore_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['featurestoreId'] = featurestore_id unless featurestore_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_featurestore_entity_type(parent, google_cloud_aiplatform_v1_entity_type_object = nil, entity_type_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a new EntityType in a given Featurestore.

Parameters:

  • parent (String)

    Required. The resource name of the Featurestore to create EntityTypes. Format: projects/project/locations/location/featurestores/featurestore``

  • google_cloud_aiplatform_v1_entity_type_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EntityType) (defaults to: nil)
  • entity_type_id (String) (defaults to: nil)

    Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are [a-z0-9_]. The first character cannot be a number. The value must be unique within a featurestore.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7177

def create_project_location_featurestore_entity_type(parent, google_cloud_aiplatform_v1_entity_type_object = nil, entity_type_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/entityTypes', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EntityType::Representation
  command.request_object = google_cloud_aiplatform_v1_entity_type_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['entityTypeId'] = entity_type_id unless entity_type_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_featurestore_entity_type_feature(parent, google_cloud_aiplatform_v1_feature_object = nil, feature_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a new Feature in a given EntityType.

Parameters:

  • parent (String)

    Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: projects/project/locations/ location/featurestores/featurestore/entityTypes/entity_typeFormat for feature_group as parent: `projects/`project`/locations/`location`/ featureGroups/`feature_group

  • google_cloud_aiplatform_v1_feature_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature) (defaults to: nil)
  • feature_id (String) (defaults to: nil)

    Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are [a-z0-9_]. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7797

def create_project_location_featurestore_entity_type_feature(parent, google_cloud_aiplatform_v1_feature_object = nil, feature_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/features', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature::Representation
  command.request_object = google_cloud_aiplatform_v1_feature_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['featureId'] = feature_id unless feature_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_hyperparameter_tuning_job(parent, google_cloud_aiplatform_v1_hyperparameter_tuning_job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1HyperparameterTuningJob

Creates a HyperparameterTuningJob

Parameters:

  • parent (String)

    Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_hyperparameter_tuning_job_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1HyperparameterTuningJob) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8612

def create_project_location_hyperparameter_tuning_job(parent, google_cloud_aiplatform_v1_hyperparameter_tuning_job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/hyperparameterTuningJobs', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1HyperparameterTuningJob::Representation
  command.request_object = google_cloud_aiplatform_v1_hyperparameter_tuning_job_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1HyperparameterTuningJob::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1HyperparameterTuningJob
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_index(parent, google_cloud_aiplatform_v1_index_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates an Index.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create the Index in. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_index_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Index) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9493

def create_project_location_index(parent, google_cloud_aiplatform_v1_index_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/indexes', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Index::Representation
  command.request_object = google_cloud_aiplatform_v1_index_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_index_endpoint(parent, google_cloud_aiplatform_v1_index_endpoint_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates an IndexEndpoint.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create the IndexEndpoint in. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_index_endpoint_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1IndexEndpoint) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8947

def create_project_location_index_endpoint(parent, google_cloud_aiplatform_v1_index_endpoint_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/indexEndpoints', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1IndexEndpoint::Representation
  command.request_object = google_cloud_aiplatform_v1_index_endpoint_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_metadata_store(parent, google_cloud_aiplatform_v1_metadata_store_object = nil, metadata_store_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Initializes a MetadataStore, including allocation of resources.

Parameters:

  • parent (String)

    Required. The resource name of the Location where the MetadataStore should be created. Format: projects/project/locations/location/

  • google_cloud_aiplatform_v1_metadata_store_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MetadataStore) (defaults to: nil)
  • metadata_store_id (String) (defaults to: nil)

    The metadatastore portion of the resource name with the format: projects/ project/locations/location/metadataStores/metadatastore`If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9930

def (parent,  = nil, metadata_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/metadataStores', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MetadataStore::Representation
  command.request_object = 
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['metadataStoreId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_metadata_store_artifact(parent, google_cloud_aiplatform_v1_artifact_object = nil, artifact_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Artifact

Creates an Artifact associated with a MetadataStore.

Parameters:

  • parent (String)

    Required. The resource name of the MetadataStore where the Artifact should be created. Format: projects/project/locations/location/metadataStores/ metadatastore``

  • google_cloud_aiplatform_v1_artifact_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Artifact) (defaults to: nil)
  • artifact_id (String) (defaults to: nil)

    The artifact portion of the resource name with the format: projects/ project/locations/location/metadataStores/metadatastore/artifacts/ artifact`If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10081

def (parent, google_cloud_aiplatform_v1_artifact_object = nil, artifact_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/artifacts', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Artifact::Representation
  command.request_object = google_cloud_aiplatform_v1_artifact_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Artifact::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Artifact
  command.params['parent'] = parent unless parent.nil?
  command.query['artifactId'] = artifact_id unless artifact_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_metadata_store_context(parent, google_cloud_aiplatform_v1_context_object = nil, context_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Context

Creates a Context associated with a MetadataStore.

Parameters:

  • parent (String)

    Required. The resource name of the MetadataStore where the Context should be created. Format: projects/project/locations/location/metadataStores/ metadatastore``

  • google_cloud_aiplatform_v1_context_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Context) (defaults to: nil)
  • context_id (String) (defaults to: nil)

    The context portion of the resource name with the format: projects/project /locations/location/metadataStores/metadatastore/contexts/context`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10650

def (parent, google_cloud_aiplatform_v1_context_object = nil, context_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/contexts', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Context::Representation
  command.request_object = google_cloud_aiplatform_v1_context_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Context::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Context
  command.params['parent'] = parent unless parent.nil?
  command.query['contextId'] = context_id unless context_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_metadata_store_execution(parent, google_cloud_aiplatform_v1_execution_object = nil, execution_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Execution

Creates an Execution associated with a MetadataStore.

Parameters:

  • parent (String)

    Required. The resource name of the MetadataStore where the Execution should be created. Format: projects/project/locations/location/metadataStores/ metadatastore``

  • google_cloud_aiplatform_v1_execution_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Execution) (defaults to: nil)
  • execution_id (String) (defaults to: nil)

    The execution portion of the resource name with the format: projects/ project/locations/location/metadataStores/metadatastore/executions/ execution`If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11199

def (parent, google_cloud_aiplatform_v1_execution_object = nil, execution_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/executions', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Execution::Representation
  command.request_object = google_cloud_aiplatform_v1_execution_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Execution::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Execution
  command.params['parent'] = parent unless parent.nil?
  command.query['executionId'] = execution_id unless execution_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_metadata_store_metadata_schema(parent, google_cloud_aiplatform_v1_metadata_schema_object = nil, metadata_schema_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MetadataSchema

Creates a MetadataSchema.

Parameters:

  • parent (String)

    Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: projects/project/locations/location/ metadataStores/metadatastore``

  • google_cloud_aiplatform_v1_metadata_schema_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MetadataSchema) (defaults to: nil)
  • metadata_schema_id (String) (defaults to: nil)

    The metadata_schema portion of the resource name with the format: projects/ project/locations/location/metadataStores/metadatastore/metadataSchemas/ metadataschema`If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11669

def (parent,  = nil, metadata_schema_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/metadataSchemas', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MetadataSchema::Representation
  command.request_object = 
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MetadataSchema::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MetadataSchema
  command.params['parent'] = parent unless parent.nil?
  command.query['metadataSchemaId'] =  unless .nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_model_deployment_monitoring_job(parent, google_cloud_aiplatform_v1_model_deployment_monitoring_job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelDeploymentMonitoringJob

Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.

Parameters:

  • parent (String)

    Required. The parent of the ModelDeploymentMonitoringJob. Format: projects/ project/locations/location``

  • google_cloud_aiplatform_v1_model_deployment_monitoring_job_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelDeploymentMonitoringJob) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12219

def create_project_location_model_deployment_monitoring_job(parent, google_cloud_aiplatform_v1_model_deployment_monitoring_job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/modelDeploymentMonitoringJobs', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelDeploymentMonitoringJob::Representation
  command.request_object = google_cloud_aiplatform_v1_model_deployment_monitoring_job_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelDeploymentMonitoringJob::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelDeploymentMonitoringJob
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_nas_job(parent, google_cloud_aiplatform_v1_nas_job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NasJob

Creates a NasJob

Parameters:

  • parent (String)

    Required. The resource name of the Location to create the NasJob in. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_nas_job_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NasJob) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13892

def create_project_location_nas_job(parent, google_cloud_aiplatform_v1_nas_job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/nasJobs', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NasJob::Representation
  command.request_object = google_cloud_aiplatform_v1_nas_job_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NasJob::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NasJob
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_notebook_execution_job(parent, google_cloud_aiplatform_v1_notebook_execution_job_object = nil, notebook_execution_job_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a NotebookExecutionJob.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create the NotebookExecutionJob. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_notebook_execution_job_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookExecutionJob) (defaults to: nil)
  • notebook_execution_job_id (String) (defaults to: nil)

    Optional. User specified ID for the NotebookExecutionJob.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14112

def create_project_location_notebook_execution_job(parent, google_cloud_aiplatform_v1_notebook_execution_job_object = nil, notebook_execution_job_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/notebookExecutionJobs', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookExecutionJob::Representation
  command.request_object = google_cloud_aiplatform_v1_notebook_execution_job_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['notebookExecutionJobId'] = notebook_execution_job_id unless notebook_execution_job_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_notebook_runtime_template(parent, google_cloud_aiplatform_v1_notebook_runtime_template_object = nil, notebook_runtime_template_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a NotebookRuntimeTemplate.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_notebook_runtime_template_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntimeTemplate) (defaults to: nil)
  • notebook_runtime_template_id (String) (defaults to: nil)

    Optional. User specified ID for the notebook runtime template.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14452

def create_project_location_notebook_runtime_template(parent, google_cloud_aiplatform_v1_notebook_runtime_template_object = nil, notebook_runtime_template_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/notebookRuntimeTemplates', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntimeTemplate::Representation
  command.request_object = google_cloud_aiplatform_v1_notebook_runtime_template_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['notebookRuntimeTemplateId'] = notebook_runtime_template_id unless notebook_runtime_template_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_persistent_resource(parent, google_cloud_aiplatform_v1_persistent_resource_object = nil, persistent_resource_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a PersistentResource.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create the PersistentResource in. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_persistent_resource_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PersistentResource) (defaults to: nil)
  • persistent_resource_id (String) (defaults to: nil)

    Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are /^[a-z]([a-z0-9-]0,61[a-z0-9])?$/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15605

def create_project_location_persistent_resource(parent, google_cloud_aiplatform_v1_persistent_resource_object = nil, persistent_resource_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/persistentResources', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PersistentResource::Representation
  command.request_object = google_cloud_aiplatform_v1_persistent_resource_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['persistentResourceId'] = persistent_resource_id unless persistent_resource_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_pipeline_job(parent, google_cloud_aiplatform_v1_pipeline_job_object = nil, pipeline_job_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PipelineJob

Creates a PipelineJob. A PipelineJob will run immediately when created.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create the PipelineJob in. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_pipeline_job_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PipelineJob) (defaults to: nil)
  • pipeline_job_id (String) (defaults to: nil)

    The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are /a-z-/ .

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16116
16117
16118
16119
16120
16121
16122
16123
16124
16125
16126
16127
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16116

def create_project_location_pipeline_job(parent, google_cloud_aiplatform_v1_pipeline_job_object = nil, pipeline_job_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/pipelineJobs', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PipelineJob::Representation
  command.request_object = google_cloud_aiplatform_v1_pipeline_job_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PipelineJob::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PipelineJob
  command.params['parent'] = parent unless parent.nil?
  command.query['pipelineJobId'] = pipeline_job_id unless pipeline_job_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_schedule(parent, google_cloud_aiplatform_v1_schedule_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schedule

Creates a Schedule.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create the Schedule in. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_schedule_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schedule) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16819
16820
16821
16822
16823
16824
16825
16826
16827
16828
16829
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16819

def create_project_location_schedule(parent, google_cloud_aiplatform_v1_schedule_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/schedules', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schedule::Representation
  command.request_object = google_cloud_aiplatform_v1_schedule_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schedule::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schedule
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_specialist_pool(parent, google_cloud_aiplatform_v1_specialist_pool_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a SpecialistPool.

Parameters:

  • parent (String)

    Required. The parent Project name for the new SpecialistPool. The form is projects/project/locations/location``.

  • google_cloud_aiplatform_v1_specialist_pool_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SpecialistPool) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17280
17281
17282
17283
17284
17285
17286
17287
17288
17289
17290
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17280

def create_project_location_specialist_pool(parent, google_cloud_aiplatform_v1_specialist_pool_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/specialistPools', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SpecialistPool::Representation
  command.request_object = google_cloud_aiplatform_v1_specialist_pool_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_study(parent, google_cloud_aiplatform_v1_study_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Study

Creates a Study. A resource name will be generated after creation of the Study.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create the CustomJob in. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_study_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Study) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17642
17643
17644
17645
17646
17647
17648
17649
17650
17651
17652
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17642

def create_project_location_study(parent, google_cloud_aiplatform_v1_study_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/studies', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Study::Representation
  command.request_object = google_cloud_aiplatform_v1_study_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Study::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Study
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_study_trial(parent, google_cloud_aiplatform_v1_trial_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial

Adds a user provided Trial to a Study.

Parameters:

  • parent (String)

    Required. The resource name of the Study to create the Trial in. Format: projects/project/locations/location/studies/study``

  • google_cloud_aiplatform_v1_trial_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18100
18101
18102
18103
18104
18105
18106
18107
18108
18109
18110
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18100

def create_project_location_study_trial(parent, google_cloud_aiplatform_v1_trial_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/trials', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial::Representation
  command.request_object = google_cloud_aiplatform_v1_trial_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_tensorboard(parent, google_cloud_aiplatform_v1_tensorboard_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a Tensorboard.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create the Tensorboard in. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_tensorboard_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Tensorboard) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18566
18567
18568
18569
18570
18571
18572
18573
18574
18575
18576
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18566

def create_project_location_tensorboard(parent, google_cloud_aiplatform_v1_tensorboard_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/tensorboards', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Tensorboard::Representation
  command.request_object = google_cloud_aiplatform_v1_tensorboard_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_tensorboard_experiment(parent, google_cloud_aiplatform_v1_tensorboard_experiment_object = nil, tensorboard_experiment_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardExperiment

Creates a TensorboardExperiment.

Parameters:

  • parent (String)

    Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: projects/project/locations/location/ tensorboards/tensorboard``

  • google_cloud_aiplatform_v1_tensorboard_experiment_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardExperiment) (defaults to: nil)
  • tensorboard_experiment_id (String) (defaults to: nil)

    Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18858
18859
18860
18861
18862
18863
18864
18865
18866
18867
18868
18869
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18858

def create_project_location_tensorboard_experiment(parent, google_cloud_aiplatform_v1_tensorboard_experiment_object = nil, tensorboard_experiment_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/experiments', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardExperiment::Representation
  command.request_object = google_cloud_aiplatform_v1_tensorboard_experiment_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardExperiment::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardExperiment
  command.params['parent'] = parent unless parent.nil?
  command.query['tensorboardExperimentId'] = tensorboard_experiment_id unless tensorboard_experiment_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_tensorboard_experiment_run(parent, google_cloud_aiplatform_v1_tensorboard_run_object = nil, tensorboard_run_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardRun

Creates a TensorboardRun.

Parameters:

  • parent (String)

    Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: projects/project/locations/location/ tensorboards/tensorboard/experiments/experiment``

  • google_cloud_aiplatform_v1_tensorboard_run_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardRun) (defaults to: nil)
  • tensorboard_run_id (String) (defaults to: nil)

    Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19309
19310
19311
19312
19313
19314
19315
19316
19317
19318
19319
19320
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19309

def create_project_location_tensorboard_experiment_run(parent, google_cloud_aiplatform_v1_tensorboard_run_object = nil, tensorboard_run_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/runs', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardRun::Representation
  command.request_object = google_cloud_aiplatform_v1_tensorboard_run_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardRun::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardRun
  command.params['parent'] = parent unless parent.nil?
  command.query['tensorboardRunId'] = tensorboard_run_id unless tensorboard_run_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_tensorboard_experiment_run_time_series(parent, google_cloud_aiplatform_v1_tensorboard_time_series_object = nil, tensorboard_time_series_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardTimeSeries

Creates a TensorboardTimeSeries.

Parameters:

  • parent (String)

    Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: projects/project/locations/location/ tensorboards/tensorboard/experiments/experiment/runs/run``

  • google_cloud_aiplatform_v1_tensorboard_time_series_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardTimeSeries) (defaults to: nil)
  • tensorboard_time_series_id (String) (defaults to: nil)

    Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-90, 127"

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19725
19726
19727
19728
19729
19730
19731
19732
19733
19734
19735
19736
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19725

def create_project_location_tensorboard_experiment_run_time_series(parent, google_cloud_aiplatform_v1_tensorboard_time_series_object = nil, tensorboard_time_series_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/timeSeries', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardTimeSeries::Representation
  command.request_object = google_cloud_aiplatform_v1_tensorboard_time_series_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardTimeSeries::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardTimeSeries
  command.params['parent'] = parent unless parent.nil?
  command.query['tensorboardTimeSeriesId'] = tensorboard_time_series_id unless tensorboard_time_series_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_training_pipeline(parent, google_cloud_aiplatform_v1_training_pipeline_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TrainingPipeline

Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create the TrainingPipeline in. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_training_pipeline_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TrainingPipeline) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20438

def create_project_location_training_pipeline(parent, google_cloud_aiplatform_v1_training_pipeline_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/trainingPipelines', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TrainingPipeline::Representation
  command.request_object = google_cloud_aiplatform_v1_training_pipeline_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TrainingPipeline::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TrainingPipeline
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_tuning_job(parent, google_cloud_aiplatform_v1_tuning_job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob

Creates a TuningJob. A created TuningJob right away will be attempted to be run.

Parameters:

  • parent (String)

    Required. The resource name of the Location to create the TuningJob in. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_tuning_job_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20814
20815
20816
20817
20818
20819
20820
20821
20822
20823
20824
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20814

def create_project_location_tuning_job(parent, google_cloud_aiplatform_v1_tuning_job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/tuningJobs', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob::Representation
  command.request_object = google_cloud_aiplatform_v1_tuning_job_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_dataset(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a Dataset.

Parameters:

  • name (String)

    Required. The resource name of the Dataset to delete. Format: projects/ project/locations/location/datasets/dataset``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



110
111
112
113
114
115
116
117
118
# File 'lib/google/apis/aiplatform_v1/service.rb', line 110

def delete_dataset(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_dataset_dataset_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a Dataset version.

Parameters:

  • name (String)

    Required. The resource name of the Dataset version to delete. Format: projects/project/locations/location/datasets/dataset/datasetVersions/ dataset_version``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



301
302
303
304
305
306
307
308
309
# File 'lib/google/apis/aiplatform_v1/service.rb', line 301

def delete_dataset_dataset_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_batch_prediction_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a BatchPredictionJob. Can only be called on jobs that already finished.

Parameters:

  • name (String)

    Required. The name of the BatchPredictionJob resource to be deleted. Format: projects/project/locations/location/batchPredictionJobs/ batch_prediction_job``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



869
870
871
872
873
874
875
876
877
# File 'lib/google/apis/aiplatform_v1/service.rb', line 869

def delete_project_location_batch_prediction_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_custom_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a CustomJob.

Parameters:

  • name (String)

    Required. The name of the CustomJob resource to be deleted. Format: projects/ project/locations/location/customJobs/custom_job``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1060
1061
1062
1063
1064
1065
1066
1067
1068
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1060

def delete_project_location_custom_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_custom_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1213
1214
1215
1216
1217
1218
1219
1220
1221
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1213

def delete_project_location_custom_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_data_labeling_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a DataLabelingJob.

Parameters:

  • name (String)

    Required. The name of the DataLabelingJob to be deleted. Format: projects/ project/locations/location/dataLabelingJobs/data_labeling_job``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1425

def delete_project_location_data_labeling_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_data_labeling_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1584
1585
1586
1587
1588
1589
1590
1591
1592
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1584

def delete_project_location_data_labeling_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a Dataset.

Parameters:

  • name (String)

    Required. The resource name of the Dataset to delete. Format: projects/ project/locations/location/datasets/dataset``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1762

def delete_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset_annotation_spec_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2151
2152
2153
2154
2155
2156
2157
2158
2159
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2151

def delete_project_location_dataset_annotation_spec_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset_data_item_annotation_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2431
2432
2433
2434
2435
2436
2437
2438
2439
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2431

def delete_project_location_dataset_data_item_annotation_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset_data_item_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2614
2615
2616
2617
2618
2619
2620
2621
2622
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2614

def delete_project_location_dataset_data_item_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset_dataset_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a Dataset version.

Parameters:

  • name (String)

    Required. The resource name of the Dataset version to delete. Format: projects/project/locations/location/datasets/dataset/datasetVersions/ dataset_version``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2793
2794
2795
2796
2797
2798
2799
2800
2801
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2793

def delete_project_location_dataset_dataset_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3013
3014
3015
3016
3017
3018
3019
3020
3021
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3013

def delete_project_location_dataset_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset_saved_query(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a SavedQuery.

Parameters:

  • name (String)

    Required. The resource name of the SavedQuery to delete. Format: projects/ project/locations/location/datasets/dataset/savedQueries/saved_query``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3157

def delete_project_location_dataset_saved_query(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_dataset_saved_query_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3274
3275
3276
3277
3278
3279
3280
3281
3282
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3274

def delete_project_location_dataset_saved_query_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_deployment_resource_pool(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Delete a DeploymentResourcePool.

Parameters:

  • name (String)

    Required. The name of the DeploymentResourcePool to delete. Format: projects/ project/locations/location/deploymentResourcePools/ deployment_resource_pool``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3453
3454
3455
3456
3457
3458
3459
3460
3461
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3453

def delete_project_location_deployment_resource_pool(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_deployment_resource_pool_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3676
3677
3678
3679
3680
3681
3682
3683
3684
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3676

def delete_project_location_deployment_resource_pool_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_endpoint(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes an Endpoint.

Parameters:

  • name (String)

    Required. The name of the Endpoint resource to be deleted. Format: projects/ project/locations/location/endpoints/endpoint``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3933
3934
3935
3936
3937
3938
3939
3940
3941
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3933

def delete_project_location_endpoint(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_endpoint_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4659
4660
4661
4662
4663
4664
4665
4666
4667
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4659

def delete_project_location_endpoint_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_feature_group(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a single FeatureGroup.

Parameters:

  • name (String)

    Required. The name of the FeatureGroup to be deleted. Format: projects/ project/locations/location/featureGroups/feature_group``

  • force (Boolean) (defaults to: nil)

    If set to true, any Features under this FeatureGroup will also be deleted. ( Otherwise, the request will only work if the FeatureGroup has no Features.)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4846

def delete_project_location_feature_group(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_feature_group_feature(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a single Feature.

Parameters:

  • name (String)

    Required. The name of the Features to be deleted. Format: projects/project/ locations/location/featurestores/featurestore/entityTypes/entity_type/ features/feature`projects/`project`/locations/`location`/featureGroups/` feature_group`/features/`feature

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5089
5090
5091
5092
5093
5094
5095
5096
5097
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5089

def delete_project_location_feature_group_feature(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_feature_group_feature_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5277
5278
5279
5280
5281
5282
5283
5284
5285
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5277

def delete_project_location_feature_group_feature_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_feature_group_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5423
5424
5425
5426
5427
5428
5429
5430
5431
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5423

def delete_project_location_feature_group_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_feature_online_store(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.

Parameters:

  • name (String)

    Required. The name of the FeatureOnlineStore to be deleted. Format: projects/ project/locations/location/featureOnlineStores/feature_online_store``

  • force (Boolean) (defaults to: nil)

    If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5612

def delete_project_location_feature_online_store(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_feature_online_store_feature_view(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a single FeatureView.

Parameters:

  • name (String)

    Required. The name of the FeatureView to be deleted. Format: projects/ project/locations/location/featureOnlineStores/feature_online_store/ featureViews/feature_view``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5946
5947
5948
5949
5950
5951
5952
5953
5954
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5946

def delete_project_location_feature_online_store_feature_view(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_feature_online_store_feature_view_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6432
6433
6434
6435
6436
6437
6438
6439
6440
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6432

def delete_project_location_feature_online_store_feature_view_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_feature_online_store_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6578
6579
6580
6581
6582
6583
6584
6585
6586
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6578

def delete_project_location_feature_online_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_featurestore(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or force must be set to true for the request to succeed.

Parameters:

  • name (String)

    Required. The name of the Featurestore to be deleted. Format: projects/ project/locations/location/featurestores/featurestore``

  • force (Boolean) (defaults to: nil)

    If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6806

def delete_project_location_featurestore(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_featurestore_entity_type(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a single EntityType. The EntityType must not have any Features or force must be set to true for the request to succeed.

Parameters:

  • name (String)

    Required. The name of the EntityType to be deleted. Format: projects/project /locations/location/featurestores/featurestore/entityTypes/entity_type``

  • force (Boolean) (defaults to: nil)

    If set to true, any Features for this EntityType will also be deleted. ( Otherwise, the request will only work if the EntityType has no Features.)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7215

def delete_project_location_featurestore_entity_type(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_featurestore_entity_type_feature(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a single Feature.

Parameters:

  • name (String)

    Required. The name of the Features to be deleted. Format: projects/project/ locations/location/featurestores/featurestore/entityTypes/entity_type/ features/feature`projects/`project`/locations/`location`/featureGroups/` feature_group`/features/`feature

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7833
7834
7835
7836
7837
7838
7839
7840
7841
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7833

def delete_project_location_featurestore_entity_type_feature(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_featurestore_entity_type_feature_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8058
8059
8060
8061
8062
8063
8064
8065
8066
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8058

def delete_project_location_featurestore_entity_type_feature_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_featurestore_entity_type_feature_values(entity_type, google_cloud_aiplatform_v1_delete_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.

Parameters:

  • entity_type (String)

    Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: projects/project/locations/location /featurestores/featurestore/entityTypes/entityType``

  • google_cloud_aiplatform_v1_delete_feature_values_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeleteFeatureValuesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7255

def delete_project_location_featurestore_entity_type_feature_values(entity_type, google_cloud_aiplatform_v1_delete_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+entityType}:deleteFeatureValues', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeleteFeatureValuesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_delete_feature_values_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['entityType'] = entity_type unless entity_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_featurestore_entity_type_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8241
8242
8243
8244
8245
8246
8247
8248
8249
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8241

def delete_project_location_featurestore_entity_type_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_featurestore_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8424
8425
8426
8427
8428
8429
8430
8431
8432
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8424

def delete_project_location_featurestore_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_hyperparameter_tuning_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a HyperparameterTuningJob.

Parameters:

  • name (String)

    Required. The name of the HyperparameterTuningJob resource to be deleted. Format: projects/project/locations/location/hyperparameterTuningJobs/ hyperparameter_tuning_job``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8646
8647
8648
8649
8650
8651
8652
8653
8654
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8646

def delete_project_location_hyperparameter_tuning_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_hyperparameter_tuning_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8802
8803
8804
8805
8806
8807
8808
8809
8810
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8802

def delete_project_location_hyperparameter_tuning_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_index(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.

Parameters:

  • name (String)

    Required. The name of the Index resource to be deleted. Format: projects/ project/locations/location/indexes/index``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9527
9528
9529
9530
9531
9532
9533
9534
9535
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9527

def delete_project_location_index(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_index_endpoint(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes an IndexEndpoint.

Parameters:

  • name (String)

    Required. The name of the IndexEndpoint resource to be deleted. Format: projects/project/locations/location/indexEndpoints/index_endpoint``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8980
8981
8982
8983
8984
8985
8986
8987
8988
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8980

def delete_project_location_index_endpoint(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_index_endpoint_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9348
9349
9350
9351
9352
9353
9354
9355
9356
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9348

def delete_project_location_index_endpoint_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_index_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9777
9778
9779
9780
9781
9782
9783
9784
9785
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9777

def delete_project_location_index_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_metadata_store(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).

Parameters:

  • name (String)

    Required. The resource name of the MetadataStore to delete. Format: projects/ project/locations/location/metadataStores/metadatastore``

  • force (Boolean) (defaults to: nil)

    Deprecated: Field is no longer supported.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9967

def (name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_metadata_store_artifact(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes an Artifact.

Parameters:

  • name (String)

    Required. The resource name of the Artifact to delete. Format: projects/ project/locations/location/metadataStores/metadatastore/artifacts/ artifact``

  • etag (String) (defaults to: nil)

    Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10120

def (name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_metadata_store_artifact_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10423
10424
10425
10426
10427
10428
10429
10430
10431
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10423

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_metadata_store_context(name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a stored Context.

Parameters:

  • name (String)

    Required. The resource name of the Context to delete. Format: projects/ project/locations/location/metadataStores/metadatastore/contexts/context

  • etag (String) (defaults to: nil)

    Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.

  • force (Boolean) (defaults to: nil)

    The force deletion semantics is still undefined. Users should not use this field.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10692

def (name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_metadata_store_context_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11008
11009
11010
11011
11012
11013
11014
11015
11016
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11008

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_metadata_store_execution(name, etag: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes an Execution.

Parameters:

  • name (String)

    Required. The resource name of the Execution to delete. Format: projects/ project/locations/location/metadataStores/metadatastore/executions/ execution``

  • etag (String) (defaults to: nil)

    Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11238

def (name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_metadata_store_execution_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11515
11516
11517
11518
11519
11520
11521
11522
11523
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11515

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_metadata_store_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11818
11819
11820
11821
11822
11823
11824
11825
11826
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11818

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_migratable_resource_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12073
12074
12075
12076
12077
12078
12079
12080
12081
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12073

def delete_project_location_migratable_resource_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field.

Parameters:

  • name (String)

    Required. The name of the Model resource to be deleted. Format: projects/ project/locations/location/models/model``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12751
12752
12753
12754
12755
12756
12757
12758
12759
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12751

def delete_project_location_model(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_model_deployment_monitoring_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a ModelDeploymentMonitoringJob.

Parameters:

  • name (String)

    Required. The resource name of the model monitoring job to delete. Format: projects/project/locations/location/modelDeploymentMonitoringJobs/ model_deployment_monitoring_job``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12253
12254
12255
12256
12257
12258
12259
12260
12261
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12253

def delete_project_location_model_deployment_monitoring_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_model_deployment_monitoring_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12568
12569
12570
12571
12572
12573
12574
12575
12576
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12568

def delete_project_location_model_deployment_monitoring_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_model_evaluation_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13411
13412
13413
13414
13415
13416
13417
13418
13419
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13411

def delete_project_location_model_evaluation_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_model_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13707
13708
13709
13710
13711
13712
13713
13714
13715
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13707

def delete_project_location_model_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_model_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead.

Parameters:

  • name (String)

    Required. The name of the model version to be deleted, with a version ID explicitly included. Example: projects/project/locations/location/models/ model@1234

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12785
12786
12787
12788
12789
12790
12791
12792
12793
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12785

def delete_project_location_model_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}:deleteVersion', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_nas_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a NasJob.

Parameters:

  • name (String)

    Required. The name of the NasJob resource to be deleted. Format: projects/ project/locations/location/nasJobs/nas_job``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13925
13926
13927
13928
13929
13930
13931
13932
13933
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13925

def delete_project_location_nas_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_notebook_execution_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a NotebookExecutionJob.

Parameters:

  • name (String)

    Required. The name of the NotebookExecutionJob resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14145
14146
14147
14148
14149
14150
14151
14152
14153
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14145

def delete_project_location_notebook_execution_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_notebook_execution_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14305
14306
14307
14308
14309
14310
14311
14312
14313
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14305

def delete_project_location_notebook_execution_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_notebook_runtime(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a NotebookRuntime.

Parameters:

  • name (String)

    Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14992
14993
14994
14995
14996
14997
14998
14999
15000
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14992

def delete_project_location_notebook_runtime(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_notebook_runtime_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15273
15274
15275
15276
15277
15278
15279
15280
15281
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15273

def delete_project_location_notebook_runtime_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_notebook_runtime_template(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a NotebookRuntimeTemplate.

Parameters:

  • name (String)

    Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: projects/project/locations/location/notebookRuntimeTemplates/ notebook_runtime_template``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14487
14488
14489
14490
14491
14492
14493
14494
14495
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14487

def delete_project_location_notebook_runtime_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_notebook_runtime_template_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14811
14812
14813
14814
14815
14816
14817
14818
14819
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14811

def delete_project_location_notebook_runtime_template_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15456
15457
15458
15459
15460
15461
15462
15463
15464
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15456

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_persistent_resource(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a PersistentResource.

Parameters:

  • name (String)

    Required. The name of the PersistentResource to be deleted. Format: projects/ project/locations/location/persistentResources/persistent_resource``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15639
15640
15641
15642
15643
15644
15645
15646
15647
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15639

def delete_project_location_persistent_resource(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_persistent_resource_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15852
15853
15854
15855
15856
15857
15858
15859
15860
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15852

def delete_project_location_persistent_resource_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_pipeline_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a PipelineJob.

Parameters:

  • name (String)

    Required. The name of the PipelineJob resource to be deleted. Format: projects/project/locations/location/pipelineJobs/pipeline_job``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16150
16151
16152
16153
16154
16155
16156
16157
16158
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16150

def delete_project_location_pipeline_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_pipeline_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16324
16325
16326
16327
16328
16329
16330
16331
16332
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16324

def delete_project_location_pipeline_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_schedule(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a Schedule.

Parameters:

  • name (String)

    Required. The name of the Schedule resource to be deleted. Format: projects/ project/locations/location/schedules/schedule``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16852
16853
16854
16855
16856
16857
16858
16859
16860
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16852

def delete_project_location_schedule(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_schedule_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17135
17136
17137
17138
17139
17140
17141
17142
17143
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17135

def delete_project_location_schedule_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_specialist_pool(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a SpecialistPool as well as all Specialists in the pool.

Parameters:

  • name (String)

    Required. The resource name of the SpecialistPool to delete. Format: projects/ project/locations/location/specialistPools/specialist_pool``

  • force (Boolean) (defaults to: nil)

    If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17317
17318
17319
17320
17321
17322
17323
17324
17325
17326
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17317

def delete_project_location_specialist_pool(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['force'] = force unless force.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_specialist_pool_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17497
17498
17499
17500
17501
17502
17503
17504
17505
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17497

def delete_project_location_specialist_pool_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_study(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a Study.

Parameters:

  • name (String)

    Required. The name of the Study resource to be deleted. Format: projects/ project/locations/location/studies/study``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17675
17676
17677
17678
17679
17680
17681
17682
17683
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17675

def delete_project_location_study(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_study_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17850
17851
17852
17853
17854
17855
17856
17857
17858
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17850

def delete_project_location_study_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_study_trial(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a Trial.

Parameters:

  • name (String)

    Required. The Trial's name. Format: projects/project/locations/location/ studies/study/trials/trial``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18133
18134
18135
18136
18137
18138
18139
18140
18141
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18133

def delete_project_location_study_trial(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_study_trial_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18379
18380
18381
18382
18383
18384
18385
18386
18387
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18379

def delete_project_location_study_trial_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_tensorboard(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a Tensorboard.

Parameters:

  • name (String)

    Required. The name of the Tensorboard to be deleted. Format: projects/ project/locations/location/tensorboards/tensorboard``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18599
18600
18601
18602
18603
18604
18605
18606
18607
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18599

def delete_project_location_tensorboard(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_tensorboard_experiment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a TensorboardExperiment.

Parameters:

  • name (String)

    Required. The name of the TensorboardExperiment to be deleted. Format: projects/project/locations/location/tensorboards/tensorboard/experiments/ experiment``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18893
18894
18895
18896
18897
18898
18899
18900
18901
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18893

def delete_project_location_tensorboard_experiment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_tensorboard_experiment_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19123
19124
19125
19126
19127
19128
19129
19130
19131
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19123

def delete_project_location_tensorboard_experiment_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_tensorboard_experiment_run(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a TensorboardRun.

Parameters:

  • name (String)

    Required. The name of the TensorboardRun to be deleted. Format: projects/ project/locations/location/tensorboards/tensorboard/experiments/ experiment/runs/run``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19344
19345
19346
19347
19348
19349
19350
19351
19352
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19344

def delete_project_location_tensorboard_experiment_run(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_tensorboard_experiment_run_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19575
19576
19577
19578
19579
19580
19581
19582
19583
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19575

def delete_project_location_tensorboard_experiment_run_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_tensorboard_experiment_run_time_series(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a TensorboardTimeSeries.

Parameters:

  • name (String)

    Required. The name of the TensorboardTimeSeries to be deleted. Format: projects/project/locations/location/tensorboards/tensorboard/experiments/ experiment/runs/run/timeSeries/time_series``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19760
19761
19762
19763
19764
19765
19766
19767
19768
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19760

def delete_project_location_tensorboard_experiment_run_time_series(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_tensorboard_experiment_run_time_series_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20068
20069
20070
20071
20072
20073
20074
20075
20076
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20068

def delete_project_location_tensorboard_experiment_run_time_series_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_tensorboard_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20251
20252
20253
20254
20255
20256
20257
20258
20259
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20251

def delete_project_location_tensorboard_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_training_pipeline(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a TrainingPipeline.

Parameters:

  • name (String)

    Required. The name of the TrainingPipeline resource to be deleted. Format: projects/project/locations/location/trainingPipelines/training_pipeline``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20471
20472
20473
20474
20475
20476
20477
20478
20479
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20471

def delete_project_location_training_pipeline(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_training_pipeline_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20627
20628
20629
20630
20631
20632
20633
20634
20635
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20627

def delete_project_location_training_pipeline_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_tuning_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20992
20993
20994
20995
20996
20997
20998
20999
21000
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20992

def delete_project_location_tuning_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#deploy_project_location_endpoint_model(endpoint, google_cloud_aiplatform_v1_deploy_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deploys a Model into this Endpoint, creating a DeployedModel within it.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint resource into which to deploy a Model. Format: projects/project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_deploy_model_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeployModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3965

def deploy_project_location_endpoint_model(endpoint, google_cloud_aiplatform_v1_deploy_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:deployModel', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeployModelRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_deploy_model_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#deploy_project_location_index_endpoint_index(index_endpoint, google_cloud_aiplatform_v1_deploy_index_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Parameters:

  • index_endpoint (String)

    Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/project/locations/location/indexEndpoints/ index_endpoint``

  • google_cloud_aiplatform_v1_deploy_index_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeployIndexRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9014

def deploy_project_location_index_endpoint_index(index_endpoint, google_cloud_aiplatform_v1_deploy_index_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+indexEndpoint}:deployIndex', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeployIndexRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_deploy_index_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['indexEndpoint'] = index_endpoint unless index_endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#direct_project_location_endpoint_predict(endpoint, google_cloud_aiplatform_v1_direct_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DirectPredictResponse

Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to serve the prediction. Format: projects/project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_direct_predict_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DirectPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4000

def direct_project_location_endpoint_predict(endpoint, google_cloud_aiplatform_v1_direct_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:directPredict', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DirectPredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_direct_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DirectPredictResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DirectPredictResponse
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#direct_project_location_endpoint_raw_predict(endpoint, google_cloud_aiplatform_v1_direct_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DirectRawPredictResponse

Perform an unary online prediction request to a gRPC model server for custom containers.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to serve the prediction. Format: projects/project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_direct_raw_predict_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DirectRawPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4035

def direct_project_location_endpoint_raw_predict(endpoint, google_cloud_aiplatform_v1_direct_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:directRawPredict', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DirectRawPredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_direct_raw_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DirectRawPredictResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DirectRawPredictResponse
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#evaluate_project_location_instances(location, google_cloud_aiplatform_v1_evaluate_instances_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluateInstancesResponse

Evaluates instances based on a given metric.

Parameters:

  • location (String)

    Required. The resource name of the Location to evaluate the instances. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_evaluate_instances_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluateInstancesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



687
688
689
690
691
692
693
694
695
696
697
# File 'lib/google/apis/aiplatform_v1/service.rb', line 687

def evaluate_project_location_instances(location, google_cloud_aiplatform_v1_evaluate_instances_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+location}:evaluateInstances', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluateInstancesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_evaluate_instances_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluateInstancesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluateInstancesResponse
  command.params['location'] = location unless location.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#explain_project_location_endpoint(endpoint, google_cloud_aiplatform_v1_explain_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExplainResponse

Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to serve the explanation. Format: projects/project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_explain_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExplainRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4072

def explain_project_location_endpoint(endpoint, google_cloud_aiplatform_v1_explain_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:explain', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExplainRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_explain_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExplainResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExplainResponse
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_project_location_dataset(name, google_cloud_aiplatform_v1_export_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Exports data from a Dataset.

Parameters:

  • name (String)

    Required. The name of the Dataset resource. Format: projects/project/ locations/location/datasets/dataset``

  • google_cloud_aiplatform_v1_export_data_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExportDataRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1794

def export_project_location_dataset(name, google_cloud_aiplatform_v1_export_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:export', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExportDataRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_export_data_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_project_location_featurestore_entity_type_feature_values(entity_type, google_cloud_aiplatform_v1_export_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Exports Feature values from all the entities of a target EntityType.

Parameters:

  • entity_type (String)

    Required. The resource name of the EntityType from which to export Feature values. Format: projects/project/locations/location/featurestores/ featurestore/entityTypes/entity_type``

  • google_cloud_aiplatform_v1_export_feature_values_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExportFeatureValuesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7290

def export_project_location_featurestore_entity_type_feature_values(entity_type, google_cloud_aiplatform_v1_export_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+entityType}:exportFeatureValues', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExportFeatureValuesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_export_feature_values_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['entityType'] = entity_type unless entity_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_project_location_model(name, google_cloud_aiplatform_v1_export_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format.

Parameters:

  • name (String)

    Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported.

  • google_cloud_aiplatform_v1_export_model_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExportModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12820

def export_project_location_model(name, google_cloud_aiplatform_v1_export_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:export', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExportModelRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_export_model_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_project_location_tensorboard_experiment_run_time_series_tensorboard_time_series(tensorboard_time_series, google_cloud_aiplatform_v1_export_tensorboard_time_series_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse

Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.

Parameters:

  • tensorboard_time_series (String)

    Required. The resource name of the TensorboardTimeSeries to export data from. Format: projects/project/locations/location/tensorboards/tensorboard/ experiments/experiment/runs/run/timeSeries/time_series``

  • google_cloud_aiplatform_v1_export_tensorboard_time_series_data_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19793
19794
19795
19796
19797
19798
19799
19800
19801
19802
19803
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19793

def export_project_location_tensorboard_experiment_run_time_series_tensorboard_time_series(tensorboard_time_series, google_cloud_aiplatform_v1_export_tensorboard_time_series_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_export_tensorboard_time_series_data_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse
  command.params['tensorboardTimeSeries'] = tensorboard_time_series unless tensorboard_time_series.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#fetch_project_location_endpoint_predict_operation(endpoint, google_cloud_aiplatform_v1_fetch_predict_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Fetch an asynchronous online prediction operation.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to serve the prediction. Format: projects/project/locations/location/endpoints/endpointor `projects/` project`/locations/`location`/publishers/`publisher`/models/`model

  • google_cloud_aiplatform_v1_fetch_predict_operation_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FetchPredictOperationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4107

def fetch_project_location_endpoint_predict_operation(endpoint, google_cloud_aiplatform_v1_fetch_predict_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:fetchPredictOperation', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FetchPredictOperationRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_fetch_predict_operation_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#fetch_project_location_feature_online_store_feature_view_feature_values(feature_view, google_cloud_aiplatform_v1_fetch_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FetchFeatureValuesResponse

Fetch feature values under a FeatureView.

Parameters:

  • feature_view (String)

    Required. FeatureView resource format projects/project/locations/location/ featureOnlineStores/featureOnlineStore/featureViews/featureView``

  • google_cloud_aiplatform_v1_fetch_feature_values_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FetchFeatureValuesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5978

def fetch_project_location_feature_online_store_feature_view_feature_values(feature_view, google_cloud_aiplatform_v1_fetch_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+featureView}:fetchFeatureValues', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FetchFeatureValuesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_fetch_feature_values_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FetchFeatureValuesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FetchFeatureValuesResponse
  command.params['featureView'] = feature_view unless feature_view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#fetch_project_location_publisher_model_predict_operation(endpoint, google_cloud_aiplatform_v1_fetch_predict_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Fetch an asynchronous online prediction operation.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to serve the prediction. Format: projects/project/locations/location/endpoints/endpointor `projects/` project`/locations/`location`/publishers/`publisher`/models/`model

  • google_cloud_aiplatform_v1_fetch_predict_operation_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FetchPredictOperationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16538
16539
16540
16541
16542
16543
16544
16545
16546
16547
16548
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16538

def fetch_project_location_publisher_model_predict_operation(endpoint, google_cloud_aiplatform_v1_fetch_predict_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:fetchPredictOperation', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FetchPredictOperationRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_fetch_predict_operation_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#find_project_location_index_endpoint_neighbors(index_endpoint, google_cloud_aiplatform_v1_find_neighbors_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FindNeighborsResponse

Finds the nearest neighbors of each vector within the request.

Parameters:

  • index_endpoint (String)

    Required. The name of the index endpoint. Format: projects/project/ locations/location/indexEndpoints/index_endpoint``

  • google_cloud_aiplatform_v1_find_neighbors_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FindNeighborsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9048

def find_project_location_index_endpoint_neighbors(index_endpoint, google_cloud_aiplatform_v1_find_neighbors_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+indexEndpoint}:findNeighbors', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FindNeighborsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_find_neighbors_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FindNeighborsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FindNeighborsResponse
  command.params['indexEndpoint'] = index_endpoint unless index_endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_endpoint_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse

Generate content with multimodal inputs.

Parameters:

  • model (String)

    Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: projects/project/locations/ location/publishers/*/models/* Tuned model endpoint format: projects/ project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_generate_content_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



553
554
555
556
557
558
559
560
561
562
563
# File 'lib/google/apis/aiplatform_v1/service.rb', line 553

def generate_endpoint_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+model}:generateContent', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_generate_content_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse
  command.params['model'] = model unless model.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_project_location_endpoint_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse

Generate content with multimodal inputs.

Parameters:

  • model (String)

    Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: projects/project/locations/ location/publishers/*/models/* Tuned model endpoint format: projects/ project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_generate_content_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4143

def generate_project_location_endpoint_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+model}:generateContent', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_generate_content_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse
  command.params['model'] = model unless model.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_project_location_publisher_model_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse

Generate content with multimodal inputs.

Parameters:

  • model (String)

    Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: projects/project/locations/ location/publishers/*/models/* Tuned model endpoint format: projects/ project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_generate_content_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16574
16575
16576
16577
16578
16579
16580
16581
16582
16583
16584
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16574

def generate_project_location_publisher_model_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+model}:generateContent', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_generate_content_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse
  command.params['model'] = model unless model.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_publisher_model_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse

Generate content with multimodal inputs.

Parameters:

  • model (String)

    Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: projects/project/locations/ location/publishers/*/models/* Tuned model endpoint format: projects/ project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_generate_content_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



21165
21166
21167
21168
21169
21170
21171
21172
21173
21174
21175
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21165

def generate_publisher_model_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+model}:generateContent', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_generate_content_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse
  command.params['model'] = model unless model.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_dataset(name, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset

Gets a Dataset.

Parameters:

  • name (String)

    Required. The name of the Dataset resource.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



142
143
144
145
146
147
148
149
150
151
# File 'lib/google/apis/aiplatform_v1/service.rb', line 142

def get_dataset(name, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset
  command.params['name'] = name unless name.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_dataset_dataset_version(name, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion

Gets a Dataset version.

Parameters:

  • name (String)

    Required. The resource name of the Dataset version to delete. Format: projects/project/locations/location/datasets/dataset/datasetVersions/ dataset_version``

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



335
336
337
338
339
340
341
342
343
344
# File 'lib/google/apis/aiplatform_v1/service.rb', line 335

def get_dataset_dataset_version(name, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion
  command.params['name'] = name unless name.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_cache_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CacheConfig

Gets a GenAI cache config.

Parameters:

  • name (String)

    Required. Name of the cache config. Format: - projects/project/cacheConfig.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



621
622
623
624
625
626
627
628
629
# File 'lib/google/apis/aiplatform_v1/service.rb', line 621

def get_project_cache_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CacheConfig::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CacheConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudLocationLocation

Gets information about a location.

Parameters:

  • name (String)

    Resource name for the location.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



719
720
721
722
723
724
725
726
727
# File 'lib/google/apis/aiplatform_v1/service.rb', line 719

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudLocationLocation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudLocationLocation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_batch_prediction_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchPredictionJob

Gets a BatchPredictionJob

Parameters:

  • name (String)

    Required. The name of the BatchPredictionJob resource. Format: projects/ project/locations/location/batchPredictionJobs/batch_prediction_job``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



900
901
902
903
904
905
906
907
908
# File 'lib/google/apis/aiplatform_v1/service.rb', line 900

def get_project_location_batch_prediction_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchPredictionJob::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1BatchPredictionJob
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_custom_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CustomJob

Gets a CustomJob.

Parameters:

  • name (String)

    Required. The name of the CustomJob resource. Format: projects/project/ locations/location/customJobs/custom_job``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1091

def get_project_location_custom_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CustomJob::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CustomJob
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_custom_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1244
1245
1246
1247
1248
1249
1250
1251
1252
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1244

def get_project_location_custom_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_data_labeling_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DataLabelingJob

Gets a DataLabelingJob.

Parameters:

  • name (String)

    Required. The name of the DataLabelingJob. Format: projects/project/ locations/location/dataLabelingJobs/data_labeling_job``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1456
1457
1458
1459
1460
1461
1462
1463
1464
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1456

def get_project_location_data_labeling_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DataLabelingJob::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DataLabelingJob
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_data_labeling_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1615
1616
1617
1618
1619
1620
1621
1622
1623
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1615

def get_project_location_data_labeling_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset(name, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset

Gets a Dataset.

Parameters:

  • name (String)

    Required. The name of the Dataset resource.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1828

def get_project_location_dataset(name, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset
  command.params['name'] = name unless name.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_annotation_spec(name, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AnnotationSpec

Gets an AnnotationSpec.

Parameters:

  • name (String)

    Required. The name of the AnnotationSpec resource. Format: projects/project/ locations/location/datasets/dataset/annotationSpecs/annotation_spec``

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2080

def get_project_location_dataset_annotation_spec(name, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AnnotationSpec::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AnnotationSpec
  command.params['name'] = name unless name.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_annotation_spec_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2182
2183
2184
2185
2186
2187
2188
2189
2190
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2182

def get_project_location_dataset_annotation_spec_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_data_item_annotation_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2462
2463
2464
2465
2466
2467
2468
2469
2470
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2462

def get_project_location_dataset_data_item_annotation_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_data_item_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2645
2646
2647
2648
2649
2650
2651
2652
2653
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2645

def get_project_location_dataset_data_item_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_dataset_version(name, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion

Gets a Dataset version.

Parameters:

  • name (String)

    Required. The resource name of the Dataset version to delete. Format: projects/project/locations/location/datasets/dataset/datasetVersions/ dataset_version``

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2827

def get_project_location_dataset_dataset_version(name, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion
  command.params['name'] = name unless name.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3044
3045
3046
3047
3048
3049
3050
3051
3052
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3044

def get_project_location_dataset_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_dataset_saved_query_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3305
3306
3307
3308
3309
3310
3311
3312
3313
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3305

def get_project_location_dataset_saved_query_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_deployment_resource_pool(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeploymentResourcePool

Get a DeploymentResourcePool.

Parameters:

  • name (String)

    Required. The name of the DeploymentResourcePool to retrieve. Format: projects/project/locations/location/deploymentResourcePools/ deployment_resource_pool``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3485
3486
3487
3488
3489
3490
3491
3492
3493
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3485

def get_project_location_deployment_resource_pool(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeploymentResourcePool::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeploymentResourcePool
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_deployment_resource_pool_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3707
3708
3709
3710
3711
3712
3713
3714
3715
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3707

def get_project_location_deployment_resource_pool_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_endpoint(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Endpoint

Gets an Endpoint.

Parameters:

  • name (String)

    Required. The name of the Endpoint resource. Format: projects/project/ locations/location/endpoints/endpoint``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4176
4177
4178
4179
4180
4181
4182
4183
4184
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4176

def get_project_location_endpoint(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Endpoint::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Endpoint
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_endpoint_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4690
4691
4692
4693
4694
4695
4696
4697
4698
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4690

def get_project_location_endpoint_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_feature_group(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureGroup

Gets details of a single FeatureGroup.

Parameters:

  • name (String)

    Required. The name of the FeatureGroup resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4877
4878
4879
4880
4881
4882
4883
4884
4885
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4877

def get_project_location_feature_group(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureGroup::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureGroup
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_feature_group_feature(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature

Gets details of a single Feature.

Parameters:

  • name (String)

    Required. The name of the Feature resource. Format for entity_type as parent: projects/project/locations/location/featurestores/featurestore/ entityTypes/entity_typeFormat for feature_group as parent: `projects/` project`/locations/`location`/featureGroups/`feature_group

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5122
5123
5124
5125
5126
5127
5128
5129
5130
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5122

def get_project_location_feature_group_feature(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_feature_group_feature_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5308
5309
5310
5311
5312
5313
5314
5315
5316
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5308

def get_project_location_feature_group_feature_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_feature_group_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5454
5455
5456
5457
5458
5459
5460
5461
5462
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5454

def get_project_location_feature_group_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_feature_online_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureOnlineStore

Gets details of a single FeatureOnlineStore.

Parameters:

  • name (String)

    Required. The name of the FeatureOnlineStore resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5643
5644
5645
5646
5647
5648
5649
5650
5651
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5643

def get_project_location_feature_online_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureOnlineStore::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureOnlineStore
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_feature_online_store_feature_view(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureView

Gets details of a single FeatureView.

Parameters:

  • name (String)

    Required. The name of the FeatureView resource. Format: projects/project/ locations/location/featureOnlineStores/feature_online_store/featureViews/ feature_view``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6012
6013
6014
6015
6016
6017
6018
6019
6020
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6012

def get_project_location_feature_online_store_feature_view(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureView::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureView
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_feature_online_store_feature_view_feature_view_sync(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureViewSync

Gets details of a single FeatureViewSync.

Parameters:

  • name (String)

    Required. The name of the FeatureViewSync resource. Format: projects/project /locations/location/featureOnlineStores/feature_online_store/featureViews/ feature_view/featureViewSyncs/feature_view_sync``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6344
6345
6346
6347
6348
6349
6350
6351
6352
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6344

def get_project_location_feature_online_store_feature_view_feature_view_sync(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureViewSync::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureViewSync
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_feature_online_store_feature_view_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil)

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6056

def get_project_location_feature_online_store_feature_view_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_feature_online_store_feature_view_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6463
6464
6465
6466
6467
6468
6469
6470
6471
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6463

def get_project_location_feature_online_store_feature_view_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_feature_online_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil)

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5687

def get_project_location_feature_online_store_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_feature_online_store_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6609
6610
6611
6612
6613
6614
6615
6616
6617
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6609

def get_project_location_feature_online_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_featurestore(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Featurestore

Gets details of a single Featurestore.

Parameters:

  • name (String)

    Required. The name of the Featurestore resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6837
6838
6839
6840
6841
6842
6843
6844
6845
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6837

def get_project_location_featurestore(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Featurestore::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Featurestore
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_featurestore_entity_type(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EntityType

Gets details of a single EntityType.

Parameters:

  • name (String)

    Required. The name of the EntityType resource. Format: projects/project/ locations/location/featurestores/featurestore/entityTypes/entity_type``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7323
7324
7325
7326
7327
7328
7329
7330
7331
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7323

def get_project_location_featurestore_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EntityType::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EntityType
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_featurestore_entity_type_feature(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature

Gets details of a single Feature.

Parameters:

  • name (String)

    Required. The name of the Feature resource. Format for entity_type as parent: projects/project/locations/location/featurestores/featurestore/ entityTypes/entity_typeFormat for feature_group as parent: `projects/` project`/locations/`location`/featureGroups/`feature_group

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7866
7867
7868
7869
7870
7871
7872
7873
7874
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7866

def get_project_location_featurestore_entity_type_feature(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_featurestore_entity_type_feature_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8089
8090
8091
8092
8093
8094
8095
8096
8097
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8089

def get_project_location_featurestore_entity_type_feature_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_featurestore_entity_type_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil)

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7367

def get_project_location_featurestore_entity_type_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_featurestore_entity_type_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8272
8273
8274
8275
8276
8277
8278
8279
8280
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8272

def get_project_location_featurestore_entity_type_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_featurestore_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil)

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6881

def get_project_location_featurestore_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_featurestore_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8455
8456
8457
8458
8459
8460
8461
8462
8463
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8455

def get_project_location_featurestore_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_hyperparameter_tuning_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1HyperparameterTuningJob

Gets a HyperparameterTuningJob

Parameters:

  • name (String)

    Required. The name of the HyperparameterTuningJob resource. Format: projects/ project/locations/location/hyperparameterTuningJobs/ hyperparameter_tuning_job``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8678
8679
8680
8681
8682
8683
8684
8685
8686
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8678

def get_project_location_hyperparameter_tuning_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1HyperparameterTuningJob::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1HyperparameterTuningJob
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_hyperparameter_tuning_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8833
8834
8835
8836
8837
8838
8839
8840
8841
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8833

def get_project_location_hyperparameter_tuning_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_index(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Index

Gets an Index.

Parameters:

  • name (String)

    Required. The name of the Index resource. Format: projects/project/ locations/location/indexes/index``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9558
9559
9560
9561
9562
9563
9564
9565
9566
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9558

def get_project_location_index(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Index::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Index
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_index_endpoint(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1IndexEndpoint

Gets an IndexEndpoint.

Parameters:

  • name (String)

    Required. The name of the IndexEndpoint resource. Format: projects/project/ locations/location/indexEndpoints/index_endpoint``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9081
9082
9083
9084
9085
9086
9087
9088
9089
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9081

def get_project_location_index_endpoint(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1IndexEndpoint::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1IndexEndpoint
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_index_endpoint_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9379
9380
9381
9382
9383
9384
9385
9386
9387
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9379

def get_project_location_index_endpoint_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_index_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9808
9809
9810
9811
9812
9813
9814
9815
9816
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9808

def get_project_location_index_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_metadata_store(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MetadataStore

Retrieves a specific MetadataStore.

Parameters:

  • name (String)

    Required. The resource name of the MetadataStore to retrieve. Format: projects/project/locations/location/metadataStores/metadatastore``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9999
10000
10001
10002
10003
10004
10005
10006
10007
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9999

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MetadataStore::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MetadataStore
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_metadata_store_artifact(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Artifact

Retrieves a specific Artifact.

Parameters:

  • name (String)

    Required. The resource name of the Artifact to retrieve. Format: projects/ project/locations/location/metadataStores/metadatastore/artifacts/ artifact``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10153
10154
10155
10156
10157
10158
10159
10160
10161
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10153

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Artifact::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Artifact
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_metadata_store_artifact_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10454
10455
10456
10457
10458
10459
10460
10461
10462
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10454

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_metadata_store_context(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Context

Retrieves a specific Context.

Parameters:

  • name (String)

    Required. The resource name of the Context to retrieve. Format: projects/ project/locations/location/metadataStores/metadatastore/contexts/context

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10726
10727
10728
10729
10730
10731
10732
10733
10734
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10726

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Context::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Context
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_metadata_store_context_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11039
11040
11041
11042
11043
11044
11045
11046
11047
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11039

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_metadata_store_execution(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Execution

Retrieves a specific Execution.

Parameters:

  • name (String)

    Required. The resource name of the Execution to retrieve. Format: projects/ project/locations/location/metadataStores/metadatastore/executions/ execution``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11271
11272
11273
11274
11275
11276
11277
11278
11279
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11271

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Execution::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Execution
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_metadata_store_execution_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11546
11547
11548
11549
11550
11551
11552
11553
11554
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11546

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_metadata_store_metadata_schema(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MetadataSchema

Retrieves a specific MetadataSchema.

Parameters:

  • name (String)

    Required. The resource name of the MetadataSchema to retrieve. Format: projects/project/locations/location/metadataStores/metadatastore/ metadataSchemas/metadataschema``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11704
11705
11706
11707
11708
11709
11710
11711
11712
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11704

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MetadataSchema::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MetadataSchema
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_metadata_store_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11849
11850
11851
11852
11853
11854
11855
11856
11857
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11849

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_migratable_resource_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12104
12105
12106
12107
12108
12109
12110
12111
12112
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12104

def get_project_location_migratable_resource_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Model

Gets a Model.

Parameters:

  • name (String)

    Required. The name of the Model resource. Format: projects/project/ locations/location/models/model`In order to retrieve a specific version of the model, also provide the version ID or version alias. Example:projects/ project/locations/location/models/model@2orprojects/project/ locations/location/models/model@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12859
12860
12861
12862
12863
12864
12865
12866
12867
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12859

def get_project_location_model(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Model::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Model
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_model_deployment_monitoring_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelDeploymentMonitoringJob

Gets a ModelDeploymentMonitoringJob.

Parameters:

  • name (String)

    Required. The resource name of the ModelDeploymentMonitoringJob. Format: projects/project/locations/location/modelDeploymentMonitoringJobs/ model_deployment_monitoring_job``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12285
12286
12287
12288
12289
12290
12291
12292
12293
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12285

def get_project_location_model_deployment_monitoring_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelDeploymentMonitoringJob::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelDeploymentMonitoringJob
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_model_deployment_monitoring_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12599
12600
12601
12602
12603
12604
12605
12606
12607
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12599

def get_project_location_model_deployment_monitoring_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_model_evaluation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelEvaluation

Gets a ModelEvaluation.

Parameters:

  • name (String)

    Required. The name of the ModelEvaluation resource. Format: projects/project /locations/location/models/model/evaluations/evaluation``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13262
13263
13264
13265
13266
13267
13268
13269
13270
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13262

def get_project_location_model_evaluation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelEvaluation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelEvaluation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_model_evaluation_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13442
13443
13444
13445
13446
13447
13448
13449
13450
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13442

def get_project_location_model_evaluation_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_model_evaluation_slice(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelEvaluationSlice

Gets a ModelEvaluationSlice.

Parameters:

  • name (String)

    Required. The name of the ModelEvaluationSlice resource. Format: projects/ project/locations/location/models/model/evaluations/evaluation/slices/ slice``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13591
13592
13593
13594
13595
13596
13597
13598
13599
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13591

def get_project_location_model_evaluation_slice(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelEvaluationSlice::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelEvaluationSlice
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_model_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil)

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12903

def get_project_location_model_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_model_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13738
13739
13740
13741
13742
13743
13744
13745
13746
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13738

def get_project_location_model_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_nas_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NasJob

Gets a NasJob

Parameters:

  • name (String)

    Required. The name of the NasJob resource. Format: projects/project/ locations/location/nasJobs/nas_job``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13956
13957
13958
13959
13960
13961
13962
13963
13964
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13956

def get_project_location_nas_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NasJob::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NasJob
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_nas_job_nas_trial_detail(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NasTrialDetail

Gets a NasTrialDetail.

Parameters:

  • name (String)

    Required. The name of the NasTrialDetail resource. Format: projects/project/ locations/location/nasJobs/nas_job/nasTrialDetails/nas_trial_detail``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14039
14040
14041
14042
14043
14044
14045
14046
14047
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14039

def get_project_location_nas_job_nas_trial_detail(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NasTrialDetail::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NasTrialDetail
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_notebook_execution_job(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookExecutionJob

Gets a NotebookExecutionJob.

Parameters:

  • name (String)

    Required. The name of the NotebookExecutionJob resource.

  • view (String) (defaults to: nil)

    Optional. The NotebookExecutionJob view. Defaults to BASIC.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14177
14178
14179
14180
14181
14182
14183
14184
14185
14186
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14177

def get_project_location_notebook_execution_job(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookExecutionJob::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookExecutionJob
  command.params['name'] = name unless name.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_notebook_execution_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14336
14337
14338
14339
14340
14341
14342
14343
14344
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14336

def get_project_location_notebook_execution_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_notebook_runtime(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntime

Gets a NotebookRuntime.

Parameters:

  • name (String)

    Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15024
15025
15026
15027
15028
15029
15030
15031
15032
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15024

def get_project_location_notebook_runtime(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntime::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntime
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_notebook_runtime_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15304
15305
15306
15307
15308
15309
15310
15311
15312
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15304

def get_project_location_notebook_runtime_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_notebook_runtime_template(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntimeTemplate

Gets a NotebookRuntimeTemplate.

Parameters:

  • name (String)

    Required. The name of the NotebookRuntimeTemplate resource. Format: projects/ project/locations/location/notebookRuntimeTemplates/ notebook_runtime_template``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14519
14520
14521
14522
14523
14524
14525
14526
14527
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14519

def get_project_location_notebook_runtime_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntimeTemplate::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntimeTemplate
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_notebook_runtime_template_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

  • options_requested_policy_version (Fixnum) (defaults to: nil)

    Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14563

def get_project_location_notebook_runtime_template_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_notebook_runtime_template_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14842
14843
14844
14845
14846
14847
14848
14849
14850
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14842

def get_project_location_notebook_runtime_template_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15487
15488
15489
15490
15491
15492
15493
15494
15495
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15487

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_persistent_resource(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PersistentResource

Gets a PersistentResource.

Parameters:

  • name (String)

    Required. The name of the PersistentResource resource. Format: projects/ project_id_or_number/locations/location_id/persistentResources/ persistent_resource_id``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15671
15672
15673
15674
15675
15676
15677
15678
15679
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15671

def get_project_location_persistent_resource(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PersistentResource::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PersistentResource
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_persistent_resource_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15883
15884
15885
15886
15887
15888
15889
15890
15891
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15883

def get_project_location_persistent_resource_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_pipeline_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PipelineJob

Gets a PipelineJob.

Parameters:

  • name (String)

    Required. The name of the PipelineJob resource. Format: projects/project/ locations/location/pipelineJobs/pipeline_job``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16181
16182
16183
16184
16185
16186
16187
16188
16189
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16181

def get_project_location_pipeline_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PipelineJob::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PipelineJob
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_pipeline_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16355
16356
16357
16358
16359
16360
16361
16362
16363
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16355

def get_project_location_pipeline_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_schedule(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schedule

Gets a Schedule.

Parameters:

  • name (String)

    Required. The name of the Schedule resource. Format: projects/project/ locations/location/schedules/schedule``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16883
16884
16885
16886
16887
16888
16889
16890
16891
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16883

def get_project_location_schedule(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schedule::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schedule
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_schedule_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17166
17167
17168
17169
17170
17171
17172
17173
17174
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17166

def get_project_location_schedule_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_specialist_pool(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SpecialistPool

Gets a SpecialistPool.

Parameters:

  • name (String)

    Required. The name of the SpecialistPool resource. The form is projects/ project/locations/location/specialistPools/specialist_pool``.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17349
17350
17351
17352
17353
17354
17355
17356
17357
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17349

def get_project_location_specialist_pool(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SpecialistPool::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SpecialistPool
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_specialist_pool_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17528
17529
17530
17531
17532
17533
17534
17535
17536
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17528

def get_project_location_specialist_pool_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_study(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Study

Gets a Study by name.

Parameters:

  • name (String)

    Required. The name of the Study resource. Format: projects/project/ locations/location/studies/study``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17706
17707
17708
17709
17710
17711
17712
17713
17714
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17706

def get_project_location_study(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Study::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Study
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_study_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17881
17882
17883
17884
17885
17886
17887
17888
17889
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17881

def get_project_location_study_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_study_trial(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial

Gets a Trial.

Parameters:

  • name (String)

    Required. The name of the Trial resource. Format: projects/project/ locations/location/studies/study/trials/trial``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18164
18165
18166
18167
18168
18169
18170
18171
18172
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18164

def get_project_location_study_trial(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_study_trial_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18410
18411
18412
18413
18414
18415
18416
18417
18418
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18410

def get_project_location_study_trial_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_tensorboard(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Tensorboard

Gets a Tensorboard.

Parameters:

  • name (String)

    Required. The name of the Tensorboard resource. Format: projects/project/ locations/location/tensorboards/tensorboard``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18630
18631
18632
18633
18634
18635
18636
18637
18638
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18630

def get_project_location_tensorboard(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Tensorboard::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Tensorboard
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_tensorboard_experiment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardExperiment

Gets a TensorboardExperiment.

Parameters:

  • name (String)

    Required. The name of the TensorboardExperiment resource. Format: projects/ project/locations/location/tensorboards/tensorboard/experiments/ experiment``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18925
18926
18927
18928
18929
18930
18931
18932
18933
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18925

def get_project_location_tensorboard_experiment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardExperiment::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardExperiment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_tensorboard_experiment_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19154
19155
19156
19157
19158
19159
19160
19161
19162
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19154

def get_project_location_tensorboard_experiment_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_tensorboard_experiment_run(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardRun

Gets a TensorboardRun.

Parameters:

  • name (String)

    Required. The name of the TensorboardRun resource. Format: projects/project/ locations/location/tensorboards/tensorboard/experiments/experiment/runs/ run``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19376
19377
19378
19379
19380
19381
19382
19383
19384
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19376

def get_project_location_tensorboard_experiment_run(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardRun::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardRun
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_tensorboard_experiment_run_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19606
19607
19608
19609
19610
19611
19612
19613
19614
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19606

def get_project_location_tensorboard_experiment_run_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_tensorboard_experiment_run_time_series(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardTimeSeries

Gets a TensorboardTimeSeries.

Parameters:

  • name (String)

    Required. The name of the TensorboardTimeSeries resource. Format: projects/ project/locations/location/tensorboards/tensorboard/experiments/ experiment/runs/run/timeSeries/time_series``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19827
19828
19829
19830
19831
19832
19833
19834
19835
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19827

def get_project_location_tensorboard_experiment_run_time_series(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardTimeSeries::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardTimeSeries
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_tensorboard_experiment_run_time_series_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20099
20100
20101
20102
20103
20104
20105
20106
20107
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20099

def get_project_location_tensorboard_experiment_run_time_series_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_tensorboard_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20282
20283
20284
20285
20286
20287
20288
20289
20290
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20282

def get_project_location_tensorboard_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_training_pipeline(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TrainingPipeline

Gets a TrainingPipeline.

Parameters:

  • name (String)

    Required. The name of the TrainingPipeline resource. Format: projects/ project/locations/location/trainingPipelines/training_pipeline``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20502
20503
20504
20505
20506
20507
20508
20509
20510
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20502

def get_project_location_training_pipeline(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TrainingPipeline::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TrainingPipeline
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_training_pipeline_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20658
20659
20660
20661
20662
20663
20664
20665
20666
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20658

def get_project_location_training_pipeline_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_tuning_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob

Gets a TuningJob.

Parameters:

  • name (String)

    Required. The name of the TuningJob resource. Format: projects/project/ locations/location/tuningJobs/tuning_job``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20847
20848
20849
20850
20851
20852
20853
20854
20855
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20847

def get_project_location_tuning_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_tuning_job_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String)

    The name of the operation resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



21023
21024
21025
21026
21027
21028
21029
21030
21031
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21023

def get_project_location_tuning_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_publisher_model(name, hugging_face_token: nil, is_hugging_face_model: nil, language_code: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PublisherModel

Gets a Model Garden publisher model.

Parameters:

  • name (String)

    Required. The name of the PublisherModel resource. Format: publishers/ publisher/models/publisher_model``

  • hugging_face_token (String) (defaults to: nil)

    Optional. Token used to access Hugging Face gated models.

  • is_hugging_face_model (Boolean) (defaults to: nil)

    Optional. Boolean indicates whether the requested model is a Hugging Face model.

  • language_code (String) (defaults to: nil)

    Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.

  • view (String) (defaults to: nil)

    Optional. PublisherModel view specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



21208
21209
21210
21211
21212
21213
21214
21215
21216
21217
21218
21219
21220
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21208

def get_publisher_model(name, hugging_face_token: nil, is_hugging_face_model: nil, language_code: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PublisherModel::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PublisherModel
  command.params['name'] = name unless name.nil?
  command.query['huggingFaceToken'] = hugging_face_token unless hugging_face_token.nil?
  command.query['isHuggingFaceModel'] = is_hugging_face_model unless is_hugging_face_model.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_project_location_dataset(name, google_cloud_aiplatform_v1_import_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Imports data into a Dataset.

Parameters:

  • name (String)

    Required. The name of the Dataset resource. Format: projects/project/ locations/location/datasets/dataset``

  • google_cloud_aiplatform_v1_import_data_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ImportDataRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1861

def import_project_location_dataset(name, google_cloud_aiplatform_v1_import_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:import', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ImportDataRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_import_data_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_project_location_featurestore_entity_type_feature_values(entity_type, google_cloud_aiplatform_v1_import_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.

Parameters:

  • entity_type (String)

    Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: projects/project/locations/location/ featurestores/featurestore/entityTypes/entityType``

  • google_cloud_aiplatform_v1_import_feature_values_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ImportFeatureValuesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7413

def import_project_location_featurestore_entity_type_feature_values(entity_type, google_cloud_aiplatform_v1_import_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+entityType}:importFeatureValues', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ImportFeatureValuesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_import_feature_values_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['entityType'] = entity_type unless entity_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_project_location_model_evaluation(parent, google_cloud_aiplatform_v1_import_model_evaluation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelEvaluation

Imports an externally generated ModelEvaluation.

Parameters:

  • parent (String)

    Required. The name of the parent model resource. Format: projects/project/ locations/location/models/model``

  • google_cloud_aiplatform_v1_import_model_evaluation_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ImportModelEvaluationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13294

def import_project_location_model_evaluation(parent, google_cloud_aiplatform_v1_import_model_evaluation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/evaluations:import', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ImportModelEvaluationRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_import_model_evaluation_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelEvaluation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelEvaluation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_dataset_dataset_versions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDatasetVersionsResponse

Lists DatasetVersions in a Dataset.

Parameters:

  • parent (String)

    Required. The resource name of the Dataset to list DatasetVersions from. Format: projects/project/locations/location/datasets/dataset``

  • filter (String) (defaults to: nil)

    Optional. The standard list filter.

  • order_by (String) (defaults to: nil)

    Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The standard list page size.

  • page_token (String) (defaults to: nil)

    Optional. The standard list page token.

  • read_mask (String) (defaults to: nil)

    Optional. Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



378
379
380
381
382
383
384
385
386
387
388
389
390
391
# File 'lib/google/apis/aiplatform_v1/service.rb', line 378

def list_dataset_dataset_versions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/datasetVersions', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDatasetVersionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDatasetVersionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_datasets(filter: nil, order_by: nil, page_size: nil, page_token: nil, parent: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDatasetsResponse

Lists Datasets in a Location.

Parameters:

  • filter (String) (defaults to: nil)

    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"`

  • order_by (String) (defaults to: nil)

    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

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • parent (String) (defaults to: nil)

    Required. The name of the Dataset's parent resource. Format: projects/ project/locations/location``

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



192
193
194
195
196
197
198
199
200
201
202
203
204
205
# File 'lib/google/apis/aiplatform_v1/service.rb', line 192

def list_datasets(filter: nil, order_by: nil, page_size: nil, page_token: nil, parent: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/datasets', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDatasetsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDatasetsResponse
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['parent'] = parent unless parent.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_batch_prediction_jobs(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListBatchPredictionJobsResponse

Lists BatchPredictionJobs in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list the BatchPredictionJobs from. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    The standard list filter. Supported fields: * display_name supports =, != comparisons, and : wildcard. * model_display_name supports =, != comparisons. * state supports =, != comparisons. * create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format. * labels supports general map functions that is: labels. key=value - key:value equality labels.key:* - key existence Some examples of using the filter are: *state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_* "*state!="JOB_STATE_FAILED" OR display_name="my_job"*NOT display_name=" my_job"*create_time>"2021-05-18T00:00:00Z"*labels.keyA=valueA* labels.keyB:*`

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService. ListBatchPredictionJobs call.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



950
951
952
953
954
955
956
957
958
959
960
961
962
# File 'lib/google/apis/aiplatform_v1/service.rb', line 950

def list_project_location_batch_prediction_jobs(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/batchPredictionJobs', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListBatchPredictionJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListBatchPredictionJobsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_custom_job_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1281

def list_project_location_custom_job_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_custom_jobs(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListCustomJobsResponse

Lists CustomJobs in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list the CustomJobs from. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    The standard list filter. Supported fields: * display_name supports =, != comparisons, and : wildcard. * state supports =, != comparisons. * create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format. * labels supports general map functions that is: labels.key=value - key:value equality labels.key:* - key existence Some examples of using the filter are: *state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"*state!="JOB_STATE_FAILED" OR display_name="my_job"`

    • NOT display_name="my_job" * create_time>"2021-05-18T00:00:00Z" * labels.keyA=valueA * labels.keyB:*
  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token. Typically obtained via ListCustomJobsResponse. next_page_token of the previous JobService.ListCustomJobs call.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1139

def list_project_location_custom_jobs(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/customJobs', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListCustomJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListCustomJobsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_data_labeling_job_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1652

def list_project_location_data_labeling_job_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_data_labeling_jobs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDataLabelingJobsResponse

Lists DataLabelingJobs in a Location.

Parameters:

  • parent (String)

    Required. The parent of the DataLabelingJob. Format: projects/project/ locations/location``

  • filter (String) (defaults to: nil)

    The standard list filter. Supported fields: * display_name supports =, != comparisons, and : wildcard. * state supports =, != comparisons. * create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format. * labels supports general map functions that is: labels.key=value - key:value equality labels.key:* - key existence Some examples of using the filter are: *state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"*state!="JOB_STATE_FAILED" OR display_name="my_job"`

    • NOT display_name="my_job" * create_time>"2021-05-18T00:00:00Z" * labels.keyA=valueA * labels.keyB:*
  • order_by (String) (defaults to: nil)

    A comma-separated list of fields to order by, sorted in ascending order by default. Use desc after a field name for descending.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be paths: "name". The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1509

def list_project_location_data_labeling_jobs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/dataLabelingJobs', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDataLabelingJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDataLabelingJobsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_dataset_annotation_spec_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2219

def list_project_location_dataset_annotation_spec_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_dataset_data_item_annotation_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2499

def list_project_location_dataset_data_item_annotation_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_dataset_data_item_annotations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListAnnotationsResponse

Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.

Parameters:

  • 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) (defaults to: nil)

    The standard list filter.

  • order_by (String) (defaults to: nil)

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2356

def list_project_location_dataset_data_item_annotations(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/annotations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListAnnotationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListAnnotationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_dataset_data_item_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2682

def list_project_location_dataset_data_item_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_dataset_data_items(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDataItemsResponse

Lists DataItems in a Dataset.

Parameters:

  • parent (String)

    Required. The resource name of the Dataset to list DataItems from. Format: projects/project/locations/location/datasets/dataset``

  • filter (String) (defaults to: nil)

    The standard list filter.

  • order_by (String) (defaults to: nil)

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2306

def list_project_location_dataset_data_items(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/dataItems', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDataItemsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDataItemsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_dataset_dataset_versions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDatasetVersionsResponse

Lists DatasetVersions in a Dataset.

Parameters:

  • parent (String)

    Required. The resource name of the Dataset to list DatasetVersions from. Format: projects/project/locations/location/datasets/dataset``

  • filter (String) (defaults to: nil)

    Optional. The standard list filter.

  • order_by (String) (defaults to: nil)

    Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The standard list page size.

  • page_token (String) (defaults to: nil)

    Optional. The standard list page token.

  • read_mask (String) (defaults to: nil)

    Optional. Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2870

def list_project_location_dataset_dataset_versions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/datasetVersions', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDatasetVersionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDatasetVersionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_dataset_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3081

def list_project_location_dataset_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_dataset_saved_queries(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListSavedQueriesResponse

Lists SavedQueries in a Dataset.

Parameters:

  • parent (String)

    Required. The resource name of the Dataset to list SavedQueries from. Format: projects/project/locations/location/datasets/dataset``

  • filter (String) (defaults to: nil)

    The standard list filter.

  • order_by (String) (defaults to: nil)

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3199

def list_project_location_dataset_saved_queries(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/savedQueries', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListSavedQueriesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListSavedQueriesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_dataset_saved_query_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3342

def list_project_location_dataset_saved_query_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_datasets(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDatasetsResponse

Lists Datasets in a Location.

Parameters:

  • parent (String)

    Required. The name of the Dataset's parent resource. Format: projects/ project/locations/location``

  • filter (String) (defaults to: nil)

    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"`

  • order_by (String) (defaults to: nil)

    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

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1912

def list_project_location_datasets(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/datasets', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDatasetsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDatasetsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_deployment_resource_pool_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3744

def list_project_location_deployment_resource_pool_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_deployment_resource_pools(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse

List DeploymentResourcePools in a location.

Parameters:

  • parent (String)

    Required. The parent Location which owns this collection of DeploymentResourcePools. Format: projects/project/locations/location``

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous ListDeploymentResourcePools call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDeploymentResourcePools must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3524

def list_project_location_deployment_resource_pools(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/deploymentResourcePools', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_endpoint_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4727

def list_project_location_endpoint_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_endpoints(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEndpointsResponse

Lists Endpoints in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location from which to list the Endpoints. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * endpoint supports = and !=. endpoint represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * display_name 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". * base_model_name only supports =. Some examples: * endpoint=1 * displayName="myDisplayName" * labels.myKey=" myValue" * baseModelName="text-bison"

  • order_by (String) (defaults to: nil)

    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 Example: display_name, create_time desc.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The standard list page size.

  • page_token (String) (defaults to: nil)

    Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService. ListEndpoints call.

  • read_mask (String) (defaults to: nil)

    Optional. Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4229

def list_project_location_endpoints(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/endpoints', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEndpointsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEndpointsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_feature_group_feature_operation_wait(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5345

def list_project_location_feature_group_feature_operation_wait(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_feature_group_features(parent, filter: nil, latest_stats_count: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeaturesResponse

Lists Features in a given FeatureGroup.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list Features. Format for entity_type as parent: projects/project/locations/location/featurestores/ featurestore/entityTypes/entity_typeFormat for feature_group as parent: ` projects/`project`/locations/`location`/featureGroups/`feature_group

  • filter (String) (defaults to: nil)

    Lists the Features that match the filter expression. The following filters are supported: * value_type: Supports = and != comparisons. * create_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * update_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * labels: Supports key-value equality as well as key presence. Examples: * value_type = DOUBLE --> Features whose type is DOUBLE. * create_time > \"2020-01-31T15:30:00.000000Z\" OR update_time > \" 2020-01-31T15:30:00.000000Z\" --> EntityTypes created or updated after 2020- 01-31T15:30:00.000000Z. * labels.active = yes AND labels.env = prod --> Features having both (active: yes) and (env: prod) labels. * labels.env: * --

    Any Feature which has a label with 'env' as the key.

  • latest_stats_count (Fixnum) (defaults to: nil)

    Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.

  • order_by (String) (defaults to: nil)

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending. Supported fields: * feature_id * value_type (Not supported for FeatureRegistry Feature) * create_time * update_time

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5189

def list_project_location_feature_group_features(parent, filter: nil, latest_stats_count: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/features', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeaturesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeaturesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['latestStatsCount'] = latest_stats_count unless latest_stats_count.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_feature_group_operation_wait(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5491

def list_project_location_feature_group_operation_wait(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_feature_groups(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeatureGroupsResponse

Lists FeatureGroups in a given project and location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list FeatureGroups. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    Lists the FeatureGroups that match the filter expression. The following fields are supported: * create_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format. * update_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format.

    • labels: Supports key-value equality and key presence. Examples: * create_time > "2020-01-01" OR update_time > "2020-01-01" FeatureGroups created or updated after 2020-01-01. * labels.env = "prod" FeatureGroups with label "env" set to "prod".
  • order_by (String) (defaults to: nil)

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending. Supported Fields: * create_time * update_time

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous FeatureGroupAdminService. ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureGroupAdminService. ListFeatureGroups must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4930

def list_project_location_feature_groups(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/featureGroups', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeatureGroupsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeatureGroupsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_feature_online_store_feature_view_feature_view_syncs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeatureViewSyncsResponse

Lists FeatureViewSyncs in a given FeatureView.

Parameters:

  • parent (String)

    Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: projects/project/locations/location/featureOnlineStores/ feature_online_store/featureViews/feature_view``

  • filter (String) (defaults to: nil)

    Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * create_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. Examples: * create_time > \"2020-01-31T15:30:00.000000Z\" --> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z.

  • order_by (String) (defaults to: nil)

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending. Supported fields: * create_time

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous FeatureOnlineStoreAdminService. ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService. ListFeatureViewSyncs must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6395

def list_project_location_feature_online_store_feature_view_feature_view_syncs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/featureViewSyncs', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeatureViewSyncsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeatureViewSyncsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_feature_online_store_feature_view_operation_wait(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6500

def list_project_location_feature_online_store_feature_view_operation_wait(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_feature_online_store_feature_views(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeatureViewsResponse

Lists FeatureViews in a given FeatureOnlineStore.

Parameters:

  • parent (String)

    Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: projects/project/locations/location/featureOnlineStores/ feature_online_store``

  • filter (String) (defaults to: nil)

    Lists the FeatureViews that match the filter expression. The following filters are supported: * create_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * update_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format.

    • labels: Supports key-value equality as well as key presence. Examples: * create_time > \"2020-01-31T15:30:00.000000Z\" OR update_time > \"2020-01-31T15: 30:00.000000Z\" --> FeatureViews created or updated after 2020-01-31T15:30:00. 000000Z. * labels.active = yes AND labels.env = prod --> FeatureViews having both (active: yes) and (env: prod) labels. * labels.env: * --> Any FeatureView which has a label with 'env' as the key.
  • order_by (String) (defaults to: nil)

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending. Supported fields: * feature_view_id

    • create_time * update_time
  • page_size (Fixnum) (defaults to: nil)

    The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous FeatureOnlineStoreAdminService. ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService. ListFeatureViews must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6113

def list_project_location_feature_online_store_feature_views(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/featureViews', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeatureViewsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeatureViewsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_feature_online_store_operation_wait(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6646

def list_project_location_feature_online_store_operation_wait(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_feature_online_stores(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse

Lists FeatureOnlineStores in a given project and location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list FeatureOnlineStores. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * create_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format. * update_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format. * labels: Supports key-value equality and key presence. Examples: * create_time > "2020-01-01" OR update_time > "2020-01-01" FeatureOnlineStores created or updated after 2020-01-01. * labels.env = "prod" FeatureOnlineStores with label "env" set to "prod".

  • order_by (String) (defaults to: nil)

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending. Supported Fields: * create_time * update_time

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous FeatureOnlineStoreAdminService. ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5743

def list_project_location_feature_online_stores(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/featureOnlineStores', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_featurestore_entity_type_feature_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8126

def list_project_location_featurestore_entity_type_feature_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_featurestore_entity_type_features(parent, filter: nil, latest_stats_count: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeaturesResponse

Lists Features in a given EntityType.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list Features. Format for entity_type as parent: projects/project/locations/location/featurestores/ featurestore/entityTypes/entity_typeFormat for feature_group as parent: ` projects/`project`/locations/`location`/featureGroups/`feature_group

  • filter (String) (defaults to: nil)

    Lists the Features that match the filter expression. The following filters are supported: * value_type: Supports = and != comparisons. * create_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * update_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * labels: Supports key-value equality as well as key presence. Examples: * value_type = DOUBLE --> Features whose type is DOUBLE. * create_time > \"2020-01-31T15:30:00.000000Z\" OR update_time > \" 2020-01-31T15:30:00.000000Z\" --> EntityTypes created or updated after 2020- 01-31T15:30:00.000000Z. * labels.active = yes AND labels.env = prod --> Features having both (active: yes) and (env: prod) labels. * labels.env: * --

    Any Feature which has a label with 'env' as the key.

  • latest_stats_count (Fixnum) (defaults to: nil)

    Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.

  • order_by (String) (defaults to: nil)

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending. Supported fields: * feature_id * value_type (Not supported for FeatureRegistry Feature) * create_time * update_time

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7933

def list_project_location_featurestore_entity_type_features(parent, filter: nil, latest_stats_count: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/features', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeaturesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeaturesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['latestStatsCount'] = latest_stats_count unless latest_stats_count.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_featurestore_entity_type_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8309

def list_project_location_featurestore_entity_type_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_featurestore_entity_types(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEntityTypesResponse

Lists EntityTypes in a given Featurestore.

Parameters:

  • parent (String)

    Required. The resource name of the Featurestore to list EntityTypes. Format: projects/project/locations/location/featurestores/featurestore``

  • filter (String) (defaults to: nil)

    Lists the EntityTypes that match the filter expression. The following filters are supported: * create_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * update_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format.

    • labels: Supports key-value equality as well as key presence. Examples: * create_time > \"2020-01-31T15:30:00.000000Z\" OR update_time > \"2020-01-31T15: 30:00.000000Z\" --> EntityTypes created or updated after 2020-01-31T15:30:00. 000000Z. * labels.active = yes AND labels.env = prod --> EntityTypes having both (active: yes) and (env: prod) labels. * labels.env: * --> Any EntityType which has a label with 'env' as the key.
  • order_by (String) (defaults to: nil)

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending. Supported fields: * entity_type_id * create_time * update_time

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7472

def list_project_location_featurestore_entity_types(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/entityTypes', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEntityTypesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEntityTypesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_featurestore_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8492

def list_project_location_featurestore_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_featurestores(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeaturestoresResponse

Lists Featurestores in a given project and location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list Featurestores. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    Lists the featurestores that match the filter expression. The following fields are supported: * create_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format. * update_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format.

    • online_serving_config.fixed_node_count: Supports =, !=, <, >, <=, and >= comparisons. * labels: Supports key-value equality and key presence. Examples: * create_time > "2020-01-01" OR update_time > "2020-01-01" Featurestores created or updated after 2020-01-01. * labels.env = "prod" Featurestores with label "env" set to "prod".
  • order_by (String) (defaults to: nil)

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending. Supported Fields: * create_time * update_time * online_serving_config.fixed_node_count

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6938

def list_project_location_featurestores(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/featurestores', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeaturestoresResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListFeaturestoresResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_hyperparameter_tuning_job_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8870

def list_project_location_hyperparameter_tuning_job_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_hyperparameter_tuning_jobs(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse

Lists HyperparameterTuningJobs in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: projects/project/locations/location

  • filter (String) (defaults to: nil)

    The standard list filter. Supported fields: * display_name supports =, != comparisons, and : wildcard. * state supports =, != comparisons. * create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format. * labels supports general map functions that is: labels.key=value - key:value equality labels.key:* - key existence Some examples of using the filter are: *state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"*state!="JOB_STATE_FAILED" OR display_name="my_job"`

    • NOT display_name="my_job" * create_time>"2021-05-18T00:00:00Z" * labels.keyA=valueA * labels.keyB:*
  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8728

def list_project_location_hyperparameter_tuning_jobs(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/hyperparameterTuningJobs', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_index_endpoint_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9416

def list_project_location_index_endpoint_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_index_endpoints(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListIndexEndpointsResponse

Lists IndexEndpoints in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location from which to list the IndexEndpoints. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * index_endpoint supports = and !=. index_endpoint represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * display_name supports =, != and regex() (uses re2 syntax) * 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: *index_endpoint="1"* display_name="myDisplayName"*regex(display_name, "^A") -> The display name starts with an A. * labels.myKey="myValue"

  • page_size (Fixnum) (defaults to: nil)

    Optional. The standard list page size.

  • page_token (String) (defaults to: nil)

    Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.

  • read_mask (String) (defaults to: nil)

    Optional. Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9131

def list_project_location_index_endpoints(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/indexEndpoints', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListIndexEndpointsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListIndexEndpointsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_index_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9845

def list_project_location_index_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_indexes(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListIndexesResponse

Lists Indexes in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location from which to list the Indexes. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token. Typically obtained via ListIndexesResponse. next_page_token of the previous IndexService.ListIndexes call.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9598

def list_project_location_indexes(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/indexes', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListIndexesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListIndexesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_metadata_store_artifact_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10491

def (name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_metadata_store_artifacts(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListArtifactsResponse

Lists Artifacts in the MetadataStore.

Parameters:

  • parent (String)

    Required. The MetadataStore whose Artifacts should be listed. Format: projects/project/locations/location/metadataStores/metadatastore``

  • filter (String) (defaults to: nil)

    Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following:

    • Attribute filtering: For example: display_name = "test". Supported fields include: name, display_name, uri, state, schema_title, create_time, and update_time. Time fields, such as create_time and update_time, require values specified in RFC-3339 format. For example: create_time = "2020-11-19T11:30:00-04:00" * Metadata field: To filter on metadata fields use traversal operation as follows: metadata... For example: metadata.field_1.number_value = 10.0 In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: metadata."field:1".number_value = 10.0 * Context based filtering: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name in_context(). For example: in_context(" projects//locations//metadataStores//contexts/") Each of the above supported filter types can be combined together using logical operators (AND & OR). Maximum nested expression depth allowed is 5. For example: display_name = " test" AND metadata.field1.bool_value = true.
  • order_by (String) (defaults to: nil)

    How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a . character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. ( Otherwise the request will fail with INVALID_ARGUMENT error.)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10217

def (parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/artifacts', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListArtifactsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListArtifactsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_metadata_store_context_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11076

def (name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_metadata_store_contexts(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListContextsResponse

Lists Contexts on the MetadataStore.

Parameters:

  • parent (String)

    Required. The MetadataStore whose Contexts should be listed. Format: projects/ project/locations/location/metadataStores/metadatastore``

  • filter (String) (defaults to: nil)

    Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * ** Attribute filtering*: For example: display_name = "test". Supported fields include: name, display_name, schema_title, create_time, and update_time. Time fields, such as create_time and update_time, require values specified in RFC-3339 format. For example: create_time = "2020-11- 19T11:30:00-04:00". * **Metadata field: To filter on metadata fields use traversal operation as follows: metadata... For example: metadata.field_1. number_value = 10.0. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: metadata."field: 1".number_value = 10.0 * **Parent Child filtering*: To filter Contexts based on parent-child relationship use the HAS operator as follows: parent_contexts: "projects//locations//metadataStores//contexts/" child_contexts: "projects//locations//metadataStores//contexts/" Each of the above supported filters can be combined together using logical operators ( AND & OR). Maximum nested expression depth allowed is 5. For example: display_name = "test" AND metadata.field1.bool_value = true.

  • order_by (String) (defaults to: nil)

    How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a . character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of Contexts to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. ( Otherwise the request will fail with INVALID_ARGUMENT error.)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10790

def (parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/contexts', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListContextsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListContextsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_metadata_store_execution_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11583

def (name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_metadata_store_executions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListExecutionsResponse

Lists Executions in the MetadataStore.

Parameters:

  • parent (String)

    Required. The MetadataStore whose Executions should be listed. Format: projects/project/locations/location/metadataStores/metadatastore``

  • filter (String) (defaults to: nil)

    Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * ** Attribute filtering*: For example: display_name = "test". Supported fields include: name, display_name, state, schema_title, create_time, and update_time. Time fields, such as create_time and update_time, require values specified in RFC-3339 format. For example: create_time = "2020-11- 19T11:30:00-04:00". * **Metadata field: To filter on metadata fields use traversal operation as follows: metadata.. For example: metadata.field_1. number_value = 10.0 In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: metadata."field: 1".number_value = 10.0 * **Context based filtering*: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: in_context(). For example: in_context("projects// locations//metadataStores//contexts/") Each of the above supported filters can be combined together using logical operators (AND & OR). Maximum nested expression depth allowed is 5. For example: display_name = "test" AND metadata.field1.bool_value = true.

  • order_by (String) (defaults to: nil)

    How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a . character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of Executions to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. ( Otherwise the request will fail with an INVALID_ARGUMENT error.)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11335

def (parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/executions', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListExecutionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListExecutionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_metadata_store_metadata_schemas(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListMetadataSchemasResponse

Lists MetadataSchemas.

Parameters:

  • parent (String)

    Required. The MetadataStore whose MetadataSchemas should be listed. Format: projects/project/locations/location/metadataStores/metadatastore``

  • filter (String) (defaults to: nil)

    A query to filter available MetadataSchemas for matching results.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. ( Otherwise the request will fail with INVALID_ARGUMENT error.)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11745

def (parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/metadataSchemas', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListMetadataSchemasResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListMetadataSchemasResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_metadata_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11886

def (name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_metadata_stores(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListMetadataStoresResponse

Lists MetadataStores for a Location.

Parameters:

  • parent (String)

    Required. The Location whose MetadataStores should be listed. Format: projects/project/locations/location``

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-1000, inclusive. Defaults to 100.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. ( Otherwise the request will fail with INVALID_ARGUMENT error.)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10038

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/metadataStores', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListMetadataStoresResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListMetadataStoresResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_migratable_resource_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12141

def list_project_location_migratable_resource_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_model_deployment_monitoring_job_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12636

def list_project_location_model_deployment_monitoring_job_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_model_deployment_monitoring_jobs(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse

Lists ModelDeploymentMonitoringJobs in a Location.

Parameters:

  • parent (String)

    Required. The parent of the ModelDeploymentMonitoringJob. Format: projects/ project/locations/location``

  • filter (String) (defaults to: nil)

    The standard list filter. Supported fields: * display_name supports =, != comparisons, and : wildcard. * state supports =, != comparisons. * create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format. * labels supports general map functions that is: labels.key=value - key:value equality labels.key:* - key existence Some examples of using the filter are: *state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"*state!="JOB_STATE_FAILED" OR display_name="my_job"`

    • NOT display_name="my_job" * create_time>"2021-05-18T00:00:00Z" * labels.keyA=valueA * labels.keyB:*
  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12332

def list_project_location_model_deployment_monitoring_jobs(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/modelDeploymentMonitoringJobs', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_model_evaluation_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13479

def list_project_location_model_evaluation_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_model_evaluation_slices(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse

Lists ModelEvaluationSlices in a ModelEvaluation.

Parameters:

  • parent (String)

    Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: projects/project/locations/location/ models/model/evaluations/evaluation``

  • filter (String) (defaults to: nil)

    The standard list filter. * slice.dimension - for =.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService. ListModelEvaluationSlices call.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13633

def list_project_location_model_evaluation_slices(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/slices', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_model_evaluations(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelEvaluationsResponse

Lists ModelEvaluations in a Model.

Parameters:

  • parent (String)

    Required. The resource name of the Model to list the ModelEvaluations from. Format: projects/project/locations/location/models/model``

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService. ListModelEvaluations call.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13337

def list_project_location_model_evaluations(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/evaluations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelEvaluationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelEvaluationsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_model_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13775

def list_project_location_model_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_model_versions(name, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelVersionsResponse

Lists versions of the specified model.

Parameters:

  • name (String)

    Required. The name of the model to list versions for.

  • filter (String) (defaults to: nil)

    An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * 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: *labels.myKey="myValue"`

  • order_by (String) (defaults to: nil)

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending. Supported fields: * create_time * update_time Example: update_time asc, create_time desc.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13008

def list_project_location_model_versions(name, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:listVersions', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelVersionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelVersionsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_models(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelsResponse

Lists Models in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list the Models from. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * model supports = and !=. model represents the Model ID, i.e. the last segment of the Model's resource name. * display_name 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"`.

    • base_model_name only supports = Some examples: * model=1234 * displayName="myDisplayName" * labels.myKey="myValue" * baseModelName="text- bison"
  • order_by (String) (defaults to: nil)

    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 Example: display_name, create_time desc.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token. Typically obtained via ListModelsResponse. next_page_token of the previous ModelService.ListModels call.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12956

def list_project_location_models(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/models', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListModelsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_nas_job_nas_trial_details(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListNasTrialDetailsResponse

List top NasTrialDetails of a NasJob.

Parameters:

  • parent (String)

    Required. The name of the NasJob resource. Format: projects/project/ locations/location/nasJobs/nas_job``

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService. ListNasTrialDetails call.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14076
14077
14078
14079
14080
14081
14082
14083
14084
14085
14086
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14076

def list_project_location_nas_job_nas_trial_details(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/nasTrialDetails', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListNasTrialDetailsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListNasTrialDetailsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_nas_jobs(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListNasJobsResponse

Lists NasJobs in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list the NasJobs from. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    The standard list filter. Supported fields: * display_name supports =, != comparisons, and : wildcard. * state supports =, != comparisons. * create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format. * labels supports general map functions that is: labels.key=value - key:value equality labels.key:* - key existence Some examples of using the filter are: *state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"*state!="JOB_STATE_FAILED" OR display_name="my_job"`

    • NOT display_name="my_job" * create_time>"2021-05-18T00:00:00Z" * labels.keyA=valueA * labels.keyB:*
  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token. Typically obtained via ListNasJobsResponse. next_page_token of the previous JobService.ListNasJobs call.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14004

def list_project_location_nas_jobs(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/nasJobs', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListNasJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListNasJobsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_notebook_execution_job_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
14384
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14373

def list_project_location_notebook_execution_job_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_notebook_execution_jobs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse

Lists NotebookExecutionJobs in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * notebookExecutionJob supports = and !=. notebookExecutionJob represents the NotebookExecutionJob ID. * displayName supports = and != and regex. * schedule supports = and != and regex. Some examples: * notebookExecutionJob="123" * notebookExecutionJob="my-execution-job" * displayName="myDisplayName" and displayName=~"myDisplayNameRegex"

  • order_by (String) (defaults to: nil)

    Optional. 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 Example: display_name, create_time desc.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The standard list page size.

  • page_token (String) (defaults to: nil)

    Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobs.next_page_token of the previous NotebookService. ListNotebookExecutionJobs call.

  • view (String) (defaults to: nil)

    Optional. The NotebookExecutionJob view. Defaults to BASIC.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14230
14231
14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14230

def list_project_location_notebook_execution_jobs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/notebookExecutionJobs', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_notebook_runtime_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15341
15342
15343
15344
15345
15346
15347
15348
15349
15350
15351
15352
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15341

def list_project_location_notebook_runtime_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_notebook_runtime_template_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14879
14880
14881
14882
14883
14884
14885
14886
14887
14888
14889
14890
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14879

def list_project_location_notebook_runtime_template_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_notebook_runtime_templates(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse

Lists NotebookRuntimeTemplates in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * notebookRuntimeTemplate supports = and !=. notebookRuntimeTemplate represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * display_name 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". *notebookRuntimeTypesupports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * notebookRuntimeTemplate=notebookRuntimeTemplate123*displayName=" myDisplayName"*labels.myKey="myValue"*notebookRuntimeType=USER_DEFINED`

  • order_by (String) (defaults to: nil)

    Optional. 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 Example: display_name, create_time desc.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The standard list page size.

  • page_token (String) (defaults to: nil)

    Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.

  • read_mask (String) (defaults to: nil)

    Optional. Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14620
14621
14622
14623
14624
14625
14626
14627
14628
14629
14630
14631
14632
14633
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14620

def list_project_location_notebook_runtime_templates(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/notebookRuntimeTemplates', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_notebook_runtimes(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListNotebookRuntimesResponse

Lists NotebookRuntimes in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location from which to list the NotebookRuntimes. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * notebookRuntime supports = and !=. notebookRuntime represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * displayName supports = and != and regex. * notebookRuntimeTemplate supports = and !=. notebookRuntimeTemplate represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * healthState supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * runtimeState supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * runtimeUser supports = and !=. * API version is UI only: uiState supports = and !=. uiState enum: [ UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * notebookRuntimeType supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * notebookRuntime="notebookRuntime123" * displayName="myDisplayName" and displayName=~"myDisplayNameRegex" * notebookRuntimeTemplate=" notebookRuntimeTemplate321" * healthState=HEALTHY * runtimeState=RUNNING * runtimeUser="test@google.com" * uiState=UI_RESOURCE_STATE_BEING_DELETED * notebookRuntimeType=USER_DEFINED

  • order_by (String) (defaults to: nil)

    Optional. 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 Example: display_name, create_time desc.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The standard list page size.

  • page_token (String) (defaults to: nil)

    Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService. ListNotebookRuntimes call.

  • read_mask (String) (defaults to: nil)

    Optional. Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15090
15091
15092
15093
15094
15095
15096
15097
15098
15099
15100
15101
15102
15103
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15090

def list_project_location_notebook_runtimes(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/notebookRuntimes', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListNotebookRuntimesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListNotebookRuntimesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15524
15525
15526
15527
15528
15529
15530
15531
15532
15533
15534
15535
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15524

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_persistent_resource_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15920
15921
15922
15923
15924
15925
15926
15927
15928
15929
15930
15931
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15920

def list_project_location_persistent_resource_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_persistent_resources(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListPersistentResourcesResponse

Lists PersistentResources in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list the PersistentResources from. Format: projects/project/locations/location``

  • page_size (Fixnum) (defaults to: nil)

    Optional. The standard list page size.

  • page_token (String) (defaults to: nil)

    Optional. The standard list page token. Typically obtained via ListPersistentResourceResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15708
15709
15710
15711
15712
15713
15714
15715
15716
15717
15718
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15708

def list_project_location_persistent_resources(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/persistentResources', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListPersistentResourcesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListPersistentResourcesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_pipeline_job_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16392
16393
16394
16395
16396
16397
16398
16399
16400
16401
16402
16403
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16392

def list_project_location_pipeline_job_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_pipeline_jobs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListPipelineJobsResponse

Lists PipelineJobs in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list the PipelineJobs from. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    Lists the PipelineJobs that match the filter expression. The following fields are supported: * pipeline_name: Supports = and != comparisons. * display_name: Supports =, != comparisons, and : wildcard. * pipeline_job_user_id: Supports =, != comparisons, and : wildcard. for example, can check if pipeline's display_name contains step by doing display_name:\"step\" * state: Supports = and != comparisons. * create_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format. * update_time: Supports =, !=, <, >, <= , and >= comparisons. Values must be in RFC 3339 format. * end_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format. * labels: Supports key-value equality and key presence. * template_uri: Supports =, != comparisons, and : wildcard. * template_metadata.version: Supports =, != comparisons, and : wildcard. Filter expressions can be combined together using logical operators (AND & OR). For example: pipeline_name="test" AND create_time>"2020-05-18T13:30:00Z" . The syntax to define filter expression is based on https://google.aip.dev/

    1. Examples: * create_time>"2021-05-18T00:00:00Z" OR update_time>"2020-05- 18T00:00:00Z" PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * labels.env = "prod" PipelineJobs with label "env" set to "prod".
  • order_by (String) (defaults to: nil)

    A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided e.g. "create_time desc, end_time", "end_time, start_time, update_time" For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * create_time * update_time * end_time * start_time

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token. Typically obtained via ListPipelineJobsResponse. next_page_token of the previous PipelineService.ListPipelineJobs call.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16249
16250
16251
16252
16253
16254
16255
16256
16257
16258
16259
16260
16261
16262
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16249

def list_project_location_pipeline_jobs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/pipelineJobs', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListPipelineJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListPipelineJobsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_schedule_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17203
17204
17205
17206
17207
17208
17209
17210
17211
17212
17213
17214
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17203

def list_project_location_schedule_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_schedules(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListSchedulesResponse

Lists Schedules in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list the Schedules from. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    Lists the Schedules that match the filter expression. The following fields are supported: * display_name: Supports =, != comparisons, and : wildcard.

    • state: Supports = and != comparisons. * request: Supports existence of the check. (e.g. create_pipeline_job_request:* --> Schedule has create_pipeline_job_request). * create_time: Supports =, !=, <, >, < =, and >= comparisons. Values must be in RFC 3339 format. * start_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format. * end_time: Supports =, !=, <, >, <=, >= comparisons and :* existence check. Values must be in RFC 3339 format. * next_run_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (NOT, AND & OR). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * state="ACTIVE" AND display_name:"my_schedule_*" * NOT display_name="my_schedule" * create_time>"2021-05-18T00:00:00Z" * end_time>"2021-05-18T00:00:00Z" OR NOT end_time:* * create_pipeline_job_request:*
  • order_by (String) (defaults to: nil)

    A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided. For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * create_time * start_time * end_time * next_run_time

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size. Default to 100 if not specified.

  • page_token (String) (defaults to: nil)

    The standard list page token. Typically obtained via ListSchedulesResponse. next_page_token of the previous ScheduleService.ListSchedules call.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16945
16946
16947
16948
16949
16950
16951
16952
16953
16954
16955
16956
16957
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16945

def list_project_location_schedules(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/schedules', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListSchedulesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListSchedulesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_specialist_pool_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17565
17566
17567
17568
17569
17570
17571
17572
17573
17574
17575
17576
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17565

def list_project_location_specialist_pool_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_specialist_pools(parent, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListSpecialistPoolsResponse

Lists SpecialistPools in a Location.

Parameters:

  • parent (String)

    Required. The name of the SpecialistPool's parent resource. Format: projects/ project/locations/location``

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read. FieldMask represents a set of

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17388
17389
17390
17391
17392
17393
17394
17395
17396
17397
17398
17399
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17388

def list_project_location_specialist_pools(parent, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/specialistPools', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListSpecialistPoolsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListSpecialistPoolsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_studies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListStudiesResponse

Lists all the studies in a region for an associated project.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list the Study from. Format: projects/project/locations/location``

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17743
17744
17745
17746
17747
17748
17749
17750
17751
17752
17753
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17743

def list_project_location_studies(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/studies', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListStudiesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListStudiesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_study_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17918
17919
17920
17921
17922
17923
17924
17925
17926
17927
17928
17929
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17918

def list_project_location_study_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_study_trial_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18447
18448
18449
18450
18451
18452
18453
18454
18455
18456
18457
18458
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18447

def list_project_location_study_trial_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_study_trial_optimal_trials(parent, google_cloud_aiplatform_v1_list_optimal_trials_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListOptimalTrialsResponse

Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

Parameters:

  • parent (String)

    Required. The name of the Study that the optimal Trial belongs to.

  • google_cloud_aiplatform_v1_list_optimal_trials_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListOptimalTrialsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18236
18237
18238
18239
18240
18241
18242
18243
18244
18245
18246
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18236

def list_project_location_study_trial_optimal_trials(parent, google_cloud_aiplatform_v1_list_optimal_trials_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/trials:listOptimalTrials', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListOptimalTrialsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_list_optimal_trials_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListOptimalTrialsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListOptimalTrialsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_study_trials(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTrialsResponse

Lists the Trials associated with a Study.

Parameters:

  • parent (String)

    Required. The resource name of the Study to list the Trial from. Format: projects/project/locations/location/studies/study``

  • page_size (Fixnum) (defaults to: nil)

    Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18201
18202
18203
18204
18205
18206
18207
18208
18209
18210
18211
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18201

def list_project_location_study_trials(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/trials', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTrialsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTrialsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_tensorboard_experiment_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19191

def list_project_location_tensorboard_experiment_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_tensorboard_experiment_run_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19643
19644
19645
19646
19647
19648
19649
19650
19651
19652
19653
19654
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19643

def list_project_location_tensorboard_experiment_run_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_tensorboard_experiment_run_time_series(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse

Lists TensorboardTimeSeries in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: projects/project/locations/location/ tensorboards/tensorboard/experiments/experiment/runs/run``

  • filter (String) (defaults to: nil)

    Lists the TensorboardTimeSeries that match the filter expression.

  • order_by (String) (defaults to: nil)

    Field to use to sort the list.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous TensorboardService. ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService. ListTensorboardTimeSeries must match the call that provided the page token.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19874
19875
19876
19877
19878
19879
19880
19881
19882
19883
19884
19885
19886
19887
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19874

def list_project_location_tensorboard_experiment_run_time_series(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/timeSeries', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_tensorboard_experiment_run_time_series_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20136
20137
20138
20139
20140
20141
20142
20143
20144
20145
20146
20147
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20136

def list_project_location_tensorboard_experiment_run_time_series_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_tensorboard_experiment_runs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTensorboardRunsResponse

Lists TensorboardRuns in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: projects/project/locations/location/tensorboards/ tensorboard/experiments/experiment``

  • filter (String) (defaults to: nil)

    Lists the TensorboardRuns that match the filter expression.

  • order_by (String) (defaults to: nil)

    Field to use to sort the list.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19423
19424
19425
19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19423

def list_project_location_tensorboard_experiment_runs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/runs', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTensorboardRunsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTensorboardRunsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_tensorboard_experiments(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTensorboardExperimentsResponse

Lists TensorboardExperiments in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: projects/project/locations/location/tensorboards/tensorboard``

  • filter (String) (defaults to: nil)

    Lists the TensorboardExperiments that match the filter expression.

  • order_by (String) (defaults to: nil)

    Field to use to sort the list.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous TensorboardService. ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService. ListTensorboardExperiments must match the call that provided the page token.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
18983
18984
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18971

def list_project_location_tensorboard_experiments(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/experiments', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTensorboardExperimentsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTensorboardExperimentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_tensorboard_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20319
20320
20321
20322
20323
20324
20325
20326
20327
20328
20329
20330
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20319

def list_project_location_tensorboard_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_tensorboards(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTensorboardsResponse

Lists Tensorboards in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list Tensorboards. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    Lists the Tensorboards that match the filter expression.

  • order_by (String) (defaults to: nil)

    Field to use to sort the list.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18676
18677
18678
18679
18680
18681
18682
18683
18684
18685
18686
18687
18688
18689
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18676

def list_project_location_tensorboards(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/tensorboards', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTensorboardsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTensorboardsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_training_pipeline_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20695
20696
20697
20698
20699
20700
20701
20702
20703
20704
20705
20706
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20695

def list_project_location_training_pipeline_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_training_pipelines(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTrainingPipelinesResponse

Lists TrainingPipelines in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list the TrainingPipelines from. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    The standard list filter. Supported fields: * display_name supports =, != comparisons, and : wildcard. * state supports =, != comparisons. * training_task_definition =, != comparisons, and : wildcard. * create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format. * labels supports general map functions that is: labels.key=value - key:value equality labels.key:* - key existence Some examples of using the filter are: *state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_"*state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"*NOT display_name="my_pipeline"*create_time>" 2021-05-18T00:00:00Z"*training_task_definition:" automl_text_classification*"`

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService. ListTrainingPipelines call.

  • read_mask (String) (defaults to: nil)

    Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20553
20554
20555
20556
20557
20558
20559
20560
20561
20562
20563
20564
20565
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20553

def list_project_location_training_pipelines(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/trainingPipelines', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTrainingPipelinesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTrainingPipelinesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_tuning_job_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21060

def list_project_location_tuning_job_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_tuning_jobs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTuningJobsResponse

Lists TuningJobs in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list the TuningJobs from. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    Optional. The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The standard list page size.

  • page_token (String) (defaults to: nil)

    Optional. The standard list page token. Typically obtained via ListTuningJob. next_page_token of the previous GenAiTuningService.ListTuningJob][] call.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20885
20886
20887
20888
20889
20890
20891
20892
20893
20894
20895
20896
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20885

def list_project_location_tuning_jobs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/tuningJobs', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTuningJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTuningJobsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudLocationListLocationsResponse

Lists information about the supported locations for this service.

Parameters:

  • name (String)

    The resource that owns the locations collection, if applicable.

  • filter (String) (defaults to: nil)

    A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of results to return. If not set, the service selects a default.

  • page_token (String) (defaults to: nil)

    A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



759
760
761
762
763
764
765
766
767
768
769
770
# File 'lib/google/apis/aiplatform_v1/service.rb', line 759

def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/locations', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudLocationListLocationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudLocationListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#lookup_project_location_study(parent, google_cloud_aiplatform_v1_lookup_study_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Study

Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

Parameters:

  • parent (String)

    Required. The resource name of the Location to get the Study from. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_lookup_study_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LookupStudyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17778
17779
17780
17781
17782
17783
17784
17785
17786
17787
17788
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17778

def lookup_project_location_study(parent, google_cloud_aiplatform_v1_lookup_study_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/studies:lookup', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LookupStudyRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_lookup_study_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Study::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Study
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#merge_project_location_model_version_aliases(name, google_cloud_aiplatform_v1_merge_version_aliases_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Model

Merges a set of aliases for a Model version.

Parameters:

  • name (String)

    Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: projects/project/locations/location/models/ model@1234

  • google_cloud_aiplatform_v1_merge_version_aliases_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MergeVersionAliasesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13046

def merge_project_location_model_version_aliases(name, google_cloud_aiplatform_v1_merge_version_aliases_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:mergeVersionAliases', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MergeVersionAliasesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_merge_version_aliases_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Model::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Model
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#mutate_project_location_endpoint_deployed_model(endpoint, google_cloud_aiplatform_v1_mutate_deployed_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Updates an existing deployed model. Updatable fields include min_replica_count, max_replica_count, autoscaling_metric_specs, disable_container_logging (v1 only), and enable_container_logging (v1beta1 only).

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: projects/project/locations/location/endpoints/ endpoint``

  • google_cloud_aiplatform_v1_mutate_deployed_model_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MutateDeployedModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4270

def mutate_project_location_endpoint_deployed_model(endpoint, google_cloud_aiplatform_v1_mutate_deployed_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:mutateDeployedModel', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1MutateDeployedModelRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_mutate_deployed_model_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#mutate_project_location_index_endpoint_deployed_index(index_endpoint, google_cloud_aiplatform_v1_deployed_index_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Update an existing DeployedIndex under an IndexEndpoint.

Parameters:

  • index_endpoint (String)

    Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/project/locations/location/indexEndpoints/ index_endpoint``

  • google_cloud_aiplatform_v1_deployed_index_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeployedIndex) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9168

def mutate_project_location_index_endpoint_deployed_index(index_endpoint, google_cloud_aiplatform_v1_deployed_index_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+indexEndpoint}:mutateDeployedIndex', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeployedIndex::Representation
  command.request_object = google_cloud_aiplatform_v1_deployed_index_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['indexEndpoint'] = index_endpoint unless index_endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_dataset(name, google_cloud_aiplatform_v1_dataset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset

Updates a Dataset.

Parameters:

  • name (String)

    Output only. Identifier. The resource name of the Dataset.

  • google_cloud_aiplatform_v1_dataset_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask. Updatable fields: * display_name * description * labels

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



232
233
234
235
236
237
238
239
240
241
242
243
# File 'lib/google/apis/aiplatform_v1/service.rb', line 232

def patch_dataset(name, google_cloud_aiplatform_v1_dataset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset::Representation
  command.request_object = google_cloud_aiplatform_v1_dataset_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_dataset_dataset_version(name, google_cloud_aiplatform_v1_dataset_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion

Updates a DatasetVersion.

Parameters:

  • name (String)

    Output only. Identifier. The resource name of the DatasetVersion.

  • google_cloud_aiplatform_v1_dataset_version_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask. Updatable fields: * display_name

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



417
418
419
420
421
422
423
424
425
426
427
428
# File 'lib/google/apis/aiplatform_v1/service.rb', line 417

def patch_dataset_dataset_version(name, google_cloud_aiplatform_v1_dataset_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion::Representation
  command.request_object = google_cloud_aiplatform_v1_dataset_version_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_dataset(name, google_cloud_aiplatform_v1_dataset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset

Updates a Dataset.

Parameters:

  • name (String)

    Output only. Identifier. The resource name of the Dataset.

  • google_cloud_aiplatform_v1_dataset_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask. Updatable fields: * display_name * description * labels

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1952

def patch_project_location_dataset(name, google_cloud_aiplatform_v1_dataset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset::Representation
  command.request_object = google_cloud_aiplatform_v1_dataset_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Dataset
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_dataset_dataset_version(name, google_cloud_aiplatform_v1_dataset_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion

Updates a DatasetVersion.

Parameters:

  • name (String)

    Output only. Identifier. The resource name of the DatasetVersion.

  • google_cloud_aiplatform_v1_dataset_version_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask. Updatable fields: * display_name

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2909

def patch_project_location_dataset_dataset_version(name, google_cloud_aiplatform_v1_dataset_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion::Representation
  command.request_object = google_cloud_aiplatform_v1_dataset_version_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DatasetVersion
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_deployment_resource_pool(name, google_cloud_aiplatform_v1_deployment_resource_pool_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Update a DeploymentResourcePool.

Parameters:

  • name (String)

    Immutable. The resource name of the DeploymentResourcePool. Format: projects/ project/locations/location/deploymentResourcePools/ deployment_resource_pool``

  • google_cloud_aiplatform_v1_deployment_resource_pool_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeploymentResourcePool) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The list of fields to update.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3561

def patch_project_location_deployment_resource_pool(name, google_cloud_aiplatform_v1_deployment_resource_pool_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeploymentResourcePool::Representation
  command.request_object = google_cloud_aiplatform_v1_deployment_resource_pool_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_endpoint(name, google_cloud_aiplatform_v1_endpoint_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Endpoint

Updates an Endpoint.

Parameters:

  • name (String)

    Output only. The resource name of the Endpoint.

  • google_cloud_aiplatform_v1_endpoint_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Endpoint) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The update mask applies to the resource. See google.protobuf. FieldMask.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4306

def patch_project_location_endpoint(name, google_cloud_aiplatform_v1_endpoint_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Endpoint::Representation
  command.request_object = google_cloud_aiplatform_v1_endpoint_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Endpoint::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Endpoint
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_feature_group(name, google_cloud_aiplatform_v1_feature_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Updates the parameters of a single FeatureGroup.

Parameters:

  • name (String)

    Identifier. Name of the FeatureGroup. Format: projects/project/locations/ location/featureGroups/featureGroup``

  • google_cloud_aiplatform_v1_feature_group_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureGroup) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to * to override all fields. Updatable fields: * labels * description * big_query

    • big_query.entity_id_columns
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4974

def patch_project_location_feature_group(name, google_cloud_aiplatform_v1_feature_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureGroup::Representation
  command.request_object = google_cloud_aiplatform_v1_feature_group_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_feature_group_feature(name, google_cloud_aiplatform_v1_feature_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Updates the parameters of a single Feature.

Parameters:

  • name (String)

    Immutable. Name of the Feature. Format: projects/project/locations/ location/featurestores/featurestore/entityTypes/entity_type/features/ feature`projects/`project`/locations/`location`/featureGroups/` feature_group`/features/`feature The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.

  • google_cloud_aiplatform_v1_feature_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to * to override all fields. Updatable fields: * description * labels * disable_monitoring (Not supported for FeatureRegistryService Feature) * point_of_contact (Not supported for FeaturestoreService FeatureStore)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5241

def patch_project_location_feature_group_feature(name, google_cloud_aiplatform_v1_feature_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature::Representation
  command.request_object = google_cloud_aiplatform_v1_feature_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_feature_online_store(name, google_cloud_aiplatform_v1_feature_online_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Updates the parameters of a single FeatureOnlineStore.

Parameters:

  • name (String)

    Identifier. Name of the FeatureOnlineStore. Format: projects/project/ locations/location/featureOnlineStores/featureOnlineStore``

  • google_cloud_aiplatform_v1_feature_online_store_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureOnlineStore) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to * to override all fields. Updatable fields: * labels * description * bigtable * bigtable.auto_scaling * bigtable. enable_multi_region_replica

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5788

def patch_project_location_feature_online_store(name, google_cloud_aiplatform_v1_feature_online_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureOnlineStore::Representation
  command.request_object = google_cloud_aiplatform_v1_feature_online_store_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_feature_online_store_feature_view(name, google_cloud_aiplatform_v1_feature_view_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Updates the parameters of a single FeatureView.

Parameters:

  • name (String)

    Identifier. Name of the FeatureView. Format: projects/project/locations/ location/featureOnlineStores/feature_online_store/featureViews/ feature_view``

  • google_cloud_aiplatform_v1_feature_view_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureView) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to * to override all fields. Updatable fields: * labels * service_agent_type * big_query_source * big_query_source.uri * big_query_source. entity_id_columns * feature_registry_source * feature_registry_source. feature_groups * sync_config * sync_config.cron * optimized_config. automatic_resources

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6161

def patch_project_location_feature_online_store_feature_view(name, google_cloud_aiplatform_v1_feature_view_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureView::Representation
  command.request_object = google_cloud_aiplatform_v1_feature_view_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_featurestore(name, google_cloud_aiplatform_v1_featurestore_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Updates the parameters of a single Featurestore.

Parameters:

  • name (String)

    Output only. Name of the Featurestore. Format: projects/project/locations/ location/featurestores/featurestore``

  • google_cloud_aiplatform_v1_featurestore_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Featurestore) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to * to override all fields. Updatable fields: * labels * online_serving_config. fixed_node_count * online_serving_config.scaling * online_storage_ttl_days

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6983

def patch_project_location_featurestore(name, google_cloud_aiplatform_v1_featurestore_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Featurestore::Representation
  command.request_object = google_cloud_aiplatform_v1_featurestore_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_featurestore_entity_type(name, google_cloud_aiplatform_v1_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EntityType

Updates the parameters of a single EntityType.

Parameters:

  • name (String)

    Immutable. Name of the EntityType. Format: projects/project/locations/ location/featurestores/featurestore/entityTypes/entity_type`` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.

  • google_cloud_aiplatform_v1_entity_type_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EntityType) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to * to override all fields. Updatable fields: * description * labels * monitoring_config.snapshot_analysis.disabled * monitoring_config. snapshot_analysis.monitoring_interval_days * monitoring_config. snapshot_analysis.staleness_days * monitoring_config. import_features_analysis.state * monitoring_config.import_features_analysis. anomaly_detection_baseline * monitoring_config.numerical_threshold_config. value * monitoring_config.categorical_threshold_config.value * offline_storage_ttl_days

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7527

def patch_project_location_featurestore_entity_type(name, google_cloud_aiplatform_v1_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EntityType::Representation
  command.request_object = google_cloud_aiplatform_v1_entity_type_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EntityType::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EntityType
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_featurestore_entity_type_feature(name, google_cloud_aiplatform_v1_feature_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature

Updates the parameters of a single Feature.

Parameters:

  • name (String)

    Immutable. Name of the Feature. Format: projects/project/locations/ location/featurestores/featurestore/entityTypes/entity_type/features/ feature`projects/`project`/locations/`location`/featureGroups/` feature_group`/features/`feature The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.

  • google_cloud_aiplatform_v1_feature_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to * to override all fields. Updatable fields: * description * labels * disable_monitoring (Not supported for FeatureRegistryService Feature) * point_of_contact (Not supported for FeaturestoreService FeatureStore)

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7985

def patch_project_location_featurestore_entity_type_feature(name, google_cloud_aiplatform_v1_feature_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature::Representation
  command.request_object = google_cloud_aiplatform_v1_feature_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_index(name, google_cloud_aiplatform_v1_index_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Updates an Index.

Parameters:

  • name (String)

    Output only. The resource name of the Index.

  • google_cloud_aiplatform_v1_index_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Index) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9636

def patch_project_location_index(name, google_cloud_aiplatform_v1_index_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Index::Representation
  command.request_object = google_cloud_aiplatform_v1_index_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_index_endpoint(name, google_cloud_aiplatform_v1_index_endpoint_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1IndexEndpoint

Updates an IndexEndpoint.

Parameters:

  • name (String)

    Output only. The resource name of the IndexEndpoint.

  • google_cloud_aiplatform_v1_index_endpoint_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1IndexEndpoint) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The update mask applies to the resource. See google.protobuf. FieldMask.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9204

def patch_project_location_index_endpoint(name, google_cloud_aiplatform_v1_index_endpoint_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1IndexEndpoint::Representation
  command.request_object = google_cloud_aiplatform_v1_index_endpoint_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1IndexEndpoint::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1IndexEndpoint
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_metadata_store_artifact(name, google_cloud_aiplatform_v1_artifact_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Artifact

Updates a stored Artifact.

Parameters:

  • name (String)

    Output only. The resource name of the Artifact.

  • google_cloud_aiplatform_v1_artifact_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Artifact) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil)

    If set to true, and the Artifact is not found, a new Artifact is created.

  • update_mask (String) (defaults to: nil)

    Optional. A FieldMask indicating which fields should be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10256

def (name, google_cloud_aiplatform_v1_artifact_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Artifact::Representation
  command.request_object = google_cloud_aiplatform_v1_artifact_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Artifact::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Artifact
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_metadata_store_context(name, google_cloud_aiplatform_v1_context_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Context

Updates a stored Context.

Parameters:

  • name (String)

    Immutable. The resource name of the Context.

  • google_cloud_aiplatform_v1_context_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Context) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil)

    If set to true, and the Context is not found, a new Context is created.

  • update_mask (String) (defaults to: nil)

    Optional. A FieldMask indicating which fields should be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10829

def (name, google_cloud_aiplatform_v1_context_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Context::Representation
  command.request_object = google_cloud_aiplatform_v1_context_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Context::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Context
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_metadata_store_execution(name, google_cloud_aiplatform_v1_execution_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Execution

Updates a stored Execution.

Parameters:

  • name (String)

    Output only. The resource name of the Execution.

  • google_cloud_aiplatform_v1_execution_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Execution) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil)

    If set to true, and the Execution is not found, a new Execution is created.

  • update_mask (String) (defaults to: nil)

    Optional. A FieldMask indicating which fields should be updated.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11374

def (name, google_cloud_aiplatform_v1_execution_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Execution::Representation
  command.request_object = google_cloud_aiplatform_v1_execution_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Execution::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Execution
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_model(name, google_cloud_aiplatform_v1_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Model

Updates a Model.

Parameters:

  • name (String)

    The resource name of the Model.

  • google_cloud_aiplatform_v1_model_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Model) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13082

def patch_project_location_model(name, google_cloud_aiplatform_v1_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Model::Representation
  command.request_object = google_cloud_aiplatform_v1_model_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Model::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Model
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_model_deployment_monitoring_job(name, google_cloud_aiplatform_v1_model_deployment_monitoring_job_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Updates a ModelDeploymentMonitoringJob.

Parameters:

  • name (String)

    Output only. Resource name of a ModelDeploymentMonitoringJob.

  • google_cloud_aiplatform_v1_model_deployment_monitoring_job_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelDeploymentMonitoringJob) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to * to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs. objective_config.training_dataset. Updatable fields: * display_name * model_deployment_monitoring_schedule_config * model_monitoring_alert_config

    • logging_sampling_strategy * labels * log_ttl * enable_monitoring_pipeline_logs . and * model_deployment_monitoring_objective_configs . or * model_deployment_monitoring_objective_configs.objective_config. training_dataset * model_deployment_monitoring_objective_configs. objective_config.training_prediction_skew_detection_config * model_deployment_monitoring_objective_configs.objective_config. prediction_drift_detection_config
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12387

def patch_project_location_model_deployment_monitoring_job(name, google_cloud_aiplatform_v1_model_deployment_monitoring_job_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModelDeploymentMonitoringJob::Representation
  command.request_object = google_cloud_aiplatform_v1_model_deployment_monitoring_job_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_notebook_runtime_template(name, google_cloud_aiplatform_v1_notebook_runtime_template_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntimeTemplate

Updates a NotebookRuntimeTemplate.

Parameters:

  • name (String)

    The resource name of the NotebookRuntimeTemplate.

  • google_cloud_aiplatform_v1_notebook_runtime_template_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntimeTemplate) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask. Input format: paths: "$` updated_filed`" Updatable fields: * encryption_spec.kms_key_name

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14660
14661
14662
14663
14664
14665
14666
14667
14668
14669
14670
14671
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14660

def patch_project_location_notebook_runtime_template(name, google_cloud_aiplatform_v1_notebook_runtime_template_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntimeTemplate::Representation
  command.request_object = google_cloud_aiplatform_v1_notebook_runtime_template_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntimeTemplate::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1NotebookRuntimeTemplate
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_persistent_resource(name, google_cloud_aiplatform_v1_persistent_resource_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Updates a PersistentResource.

Parameters:

  • name (String)

    Immutable. Resource name of a PersistentResource.

  • google_cloud_aiplatform_v1_persistent_resource_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PersistentResource) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. Specify the fields to be overwritten in the PersistentResource by the update method.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15744
15745
15746
15747
15748
15749
15750
15751
15752
15753
15754
15755
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15744

def patch_project_location_persistent_resource(name, google_cloud_aiplatform_v1_persistent_resource_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PersistentResource::Representation
  command.request_object = google_cloud_aiplatform_v1_persistent_resource_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_schedule(name, google_cloud_aiplatform_v1_schedule_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schedule

Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.

Parameters:

  • name (String)

    Immutable. The resource name of the Schedule.

  • google_cloud_aiplatform_v1_schedule_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schedule) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The update mask applies to the resource. See google.protobuf. FieldMask.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16987
16988
16989
16990
16991
16992
16993
16994
16995
16996
16997
16998
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16987

def patch_project_location_schedule(name, google_cloud_aiplatform_v1_schedule_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schedule::Representation
  command.request_object = google_cloud_aiplatform_v1_schedule_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schedule::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schedule
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_specialist_pool(name, google_cloud_aiplatform_v1_specialist_pool_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Updates a SpecialistPool.

Parameters:

  • name (String)

    Required. The resource name of the SpecialistPool.

  • google_cloud_aiplatform_v1_specialist_pool_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SpecialistPool) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. The update mask applies to the resource.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17424
17425
17426
17427
17428
17429
17430
17431
17432
17433
17434
17435
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17424

def patch_project_location_specialist_pool(name, google_cloud_aiplatform_v1_specialist_pool_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SpecialistPool::Representation
  command.request_object = google_cloud_aiplatform_v1_specialist_pool_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_tensorboard(name, google_cloud_aiplatform_v1_tensorboard_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Updates a Tensorboard.

Parameters:

  • name (String)

    Output only. Name of the Tensorboard. Format: projects/project/locations/ location/tensorboards/tensorboard``

  • google_cloud_aiplatform_v1_tensorboard_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Tensorboard) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18719
18720
18721
18722
18723
18724
18725
18726
18727
18728
18729
18730
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18719

def patch_project_location_tensorboard(name, google_cloud_aiplatform_v1_tensorboard_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Tensorboard::Representation
  command.request_object = google_cloud_aiplatform_v1_tensorboard_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_tensorboard_experiment(name, google_cloud_aiplatform_v1_tensorboard_experiment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardExperiment

Updates a TensorboardExperiment.

Parameters:

  • name (String)

    Output only. Name of the TensorboardExperiment. Format: projects/project/ locations/location/tensorboards/tensorboard/experiments/experiment``

  • google_cloud_aiplatform_v1_tensorboard_experiment_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardExperiment) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19014
19015
19016
19017
19018
19019
19020
19021
19022
19023
19024
19025
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19014

def patch_project_location_tensorboard_experiment(name, google_cloud_aiplatform_v1_tensorboard_experiment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardExperiment::Representation
  command.request_object = google_cloud_aiplatform_v1_tensorboard_experiment_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardExperiment::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardExperiment
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_tensorboard_experiment_run(name, google_cloud_aiplatform_v1_tensorboard_run_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardRun

Updates a TensorboardRun.

Parameters:

  • name (String)

    Output only. Name of the TensorboardRun. Format: projects/project/locations/ location/tensorboards/tensorboard/experiments/experiment/runs/run``

  • google_cloud_aiplatform_v1_tensorboard_run_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardRun) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19466
19467
19468
19469
19470
19471
19472
19473
19474
19475
19476
19477
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19466

def patch_project_location_tensorboard_experiment_run(name, google_cloud_aiplatform_v1_tensorboard_run_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardRun::Representation
  command.request_object = google_cloud_aiplatform_v1_tensorboard_run_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardRun::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardRun
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_tensorboard_experiment_run_time_series(name, google_cloud_aiplatform_v1_tensorboard_time_series_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardTimeSeries

Updates a TensorboardTimeSeries.

Parameters:

  • name (String)

    Output only. Name of the TensorboardTimeSeries.

  • google_cloud_aiplatform_v1_tensorboard_time_series_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardTimeSeries) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19916
19917
19918
19919
19920
19921
19922
19923
19924
19925
19926
19927
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19916

def patch_project_location_tensorboard_experiment_run_time_series(name, google_cloud_aiplatform_v1_tensorboard_time_series_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardTimeSeries::Representation
  command.request_object = google_cloud_aiplatform_v1_tensorboard_time_series_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardTimeSeries::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TensorboardTimeSeries
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#pause_project_location_model_deployment_monitoring_job(name, google_cloud_aiplatform_v1_pause_model_deployment_monitoring_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.

Parameters:

  • name (String)

    Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: projects/project/locations/location/modelDeploymentMonitoringJobs/ model_deployment_monitoring_job``

  • google_cloud_aiplatform_v1_pause_model_deployment_monitoring_job_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12425

def pause_project_location_model_deployment_monitoring_job(name, google_cloud_aiplatform_v1_pause_model_deployment_monitoring_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:pause', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_pause_model_deployment_monitoring_job_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#pause_project_location_schedule(name, google_cloud_aiplatform_v1_pause_schedule_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.

Parameters:

  • name (String)

    Required. The name of the Schedule resource to be paused. Format: projects/ project/locations/location/schedules/schedule``

  • google_cloud_aiplatform_v1_pause_schedule_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PauseScheduleRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17024
17025
17026
17027
17028
17029
17030
17031
17032
17033
17034
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17024

def pause_project_location_schedule(name, google_cloud_aiplatform_v1_pause_schedule_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:pause', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PauseScheduleRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_pause_schedule_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#predict_project_location_endpoint(endpoint, google_cloud_aiplatform_v1_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictResponse

Perform an online prediction.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to serve the prediction. Format: projects/project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_predict_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4341

def predict_project_location_endpoint(endpoint, google_cloud_aiplatform_v1_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:predict', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictResponse
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#predict_project_location_endpoint_long_running(endpoint, google_cloud_aiplatform_v1_predict_long_running_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to serve the prediction. Format: projects/project/locations/location/endpoints/endpointor `projects/` project`/locations/`location`/publishers/`publisher`/models/`model

  • google_cloud_aiplatform_v1_predict_long_running_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictLongRunningRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4376

def predict_project_location_endpoint_long_running(endpoint, google_cloud_aiplatform_v1_predict_long_running_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:predictLongRunning', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictLongRunningRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_predict_long_running_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#predict_project_location_publisher_model(endpoint, google_cloud_aiplatform_v1_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictResponse

Perform an online prediction.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to serve the prediction. Format: projects/project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_predict_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16608

def predict_project_location_publisher_model(endpoint, google_cloud_aiplatform_v1_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:predict', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictResponse
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#predict_project_location_publisher_model_long_running(endpoint, google_cloud_aiplatform_v1_predict_long_running_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to serve the prediction. Format: projects/project/locations/location/endpoints/endpointor `projects/` project`/locations/`location`/publishers/`publisher`/models/`model

  • google_cloud_aiplatform_v1_predict_long_running_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictLongRunningRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16643
16644
16645
16646
16647
16648
16649
16650
16651
16652
16653
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16643

def predict_project_location_publisher_model_long_running(endpoint, google_cloud_aiplatform_v1_predict_long_running_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:predictLongRunning', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictLongRunningRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_predict_long_running_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#purge_project_location_metadata_store_artifact(parent, google_cloud_aiplatform_v1_purge_artifacts_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Purges Artifacts.

Parameters:

  • parent (String)

    Required. The metadata store to purge Artifacts from. Format: projects/ project/locations/location/metadataStores/metadatastore``

  • google_cloud_aiplatform_v1_purge_artifacts_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PurgeArtifactsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10292

def (parent, google_cloud_aiplatform_v1_purge_artifacts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/artifacts:purge', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PurgeArtifactsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_purge_artifacts_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#purge_project_location_metadata_store_context(parent, google_cloud_aiplatform_v1_purge_contexts_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Purges Contexts.

Parameters:

  • parent (String)

    Required. The metadata store to purge Contexts from. Format: projects/ project/locations/location/metadataStores/metadatastore``

  • google_cloud_aiplatform_v1_purge_contexts_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PurgeContextsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10865

def (parent, google_cloud_aiplatform_v1_purge_contexts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/contexts:purge', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PurgeContextsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_purge_contexts_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#purge_project_location_metadata_store_execution(parent, google_cloud_aiplatform_v1_purge_executions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Purges Executions.

Parameters:

  • parent (String)

    Required. The metadata store to purge Executions from. Format: projects/ project/locations/location/metadataStores/metadatastore``

  • google_cloud_aiplatform_v1_purge_executions_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PurgeExecutionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11410

def (parent, google_cloud_aiplatform_v1_purge_executions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/executions:purge', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PurgeExecutionsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_purge_executions_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_project_location_deployment_resource_pool_deployed_models(deployment_resource_pool, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1QueryDeployedModelsResponse

List DeployedModels that have been deployed on this DeploymentResourcePool.

Parameters:

  • deployment_resource_pool (String)

    Required. The name of the target DeploymentResourcePool to query. Format: projects/project/locations/location/deploymentResourcePools/ deployment_resource_pool``

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of DeployedModels to return. The service may return fewer than this value.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous QueryDeployedModels call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryDeployedModels must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3604

def query_project_location_deployment_resource_pool_deployed_models(deployment_resource_pool, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+deploymentResourcePool}:queryDeployedModels', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1QueryDeployedModelsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1QueryDeployedModelsResponse
  command.params['deploymentResourcePool'] = deployment_resource_pool unless deployment_resource_pool.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_project_location_metadata_store_artifact_artifact_lineage_subgraph(artifact, filter: nil, max_hops: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LineageSubgraph

Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.

Parameters:

  • artifact (String)

    Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: projects/project/locations/ location/metadataStores/metadatastore/artifacts/artifact`` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.

  • filter (String) (defaults to: nil)

    Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * Attribute filtering: For example: display_name = "test" Supported fields include: name, display_name, uri, state, schema_title, create_time, and update_time. Time fields, such as create_time and update_time, require values specified in RFC-3339 format. For example: create_time = "2020-11-19T11:30:00-04:00" * Metadata field: To filter on metadata fields use traversal operation as follows: metadata... For example: metadata.field_1.number_value = 10.0 In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: metadata."field:1".number_value = 10.0 Each of the above supported filter types can be combined together using logical operators (AND & OR). Maximum nested expression depth allowed is 5. For example: display_name = "test" AND metadata.field1.bool_value = true.

  • max_hops (Fixnum) (defaults to: nil)

    Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10351

def (artifact, filter: nil, max_hops: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+artifact}:queryArtifactLineageSubgraph', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LineageSubgraph::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LineageSubgraph
  command.params['artifact'] = artifact unless artifact.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['maxHops'] = max_hops unless max_hops.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_project_location_metadata_store_context_context_lineage_subgraph(context, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LineageSubgraph

Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.

Parameters:

  • context (String)

    Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: projects/project/ locations/location/metadataStores/metadatastore/contexts/context`` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10903
10904
10905
10906
10907
10908
10909
10910
10911
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10903

def (context, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+context}:queryContextLineageSubgraph', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LineageSubgraph::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LineageSubgraph
  command.params['context'] = context unless context.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_project_location_metadata_store_execution_execution_inputs_and_outputs(execution, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LineageSubgraph

Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.

Parameters:

  • execution (String)

    Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: projects/project/ locations/location/metadataStores/metadatastore/executions/execution``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11445
11446
11447
11448
11449
11450
11451
11452
11453
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11445

def (execution, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+execution}:queryExecutionInputsAndOutputs', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LineageSubgraph::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LineageSubgraph
  command.params['execution'] = execution unless execution.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#raw_project_location_endpoint_predict(endpoint, google_cloud_aiplatform_v1_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleApiHttpBody

Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * X-Vertex-AI-Endpoint-Id: ID of the Endpoint that served this prediction. * X-Vertex-AI-Deployed-Model-Id: ID of the Endpoint's DeployedModel that served this prediction.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to serve the prediction. Format: projects/project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_raw_predict_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RawPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4413

def raw_project_location_endpoint_predict(endpoint, google_cloud_aiplatform_v1_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:rawPredict', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RawPredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_raw_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleApiHttpBody
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#raw_project_location_publisher_model_predict(endpoint, google_cloud_aiplatform_v1_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleApiHttpBody

Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * X-Vertex-AI-Endpoint-Id: ID of the Endpoint that served this prediction. * X-Vertex-AI-Deployed-Model-Id: ID of the Endpoint's DeployedModel that served this prediction.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to serve the prediction. Format: projects/project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_raw_predict_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RawPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16680
16681
16682
16683
16684
16685
16686
16687
16688
16689
16690
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16680

def raw_project_location_publisher_model_predict(endpoint, google_cloud_aiplatform_v1_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:rawPredict', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RawPredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_raw_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleApiHttpBody
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#read_project_location_featurestore_entity_type_feature_values(entity_type, google_cloud_aiplatform_v1_read_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadFeatureValuesResponse

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

Parameters:

  • entity_type (String)

    Required. The resource name of the EntityType for the entity being read. Value format: projects/project/locations/location/featurestores/featurestore/ entityTypes/entityType`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could beuser`.

  • google_cloud_aiplatform_v1_read_feature_values_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadFeatureValuesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7566

def read_project_location_featurestore_entity_type_feature_values(entity_type, google_cloud_aiplatform_v1_read_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+entityType}:readFeatureValues', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadFeatureValuesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_read_feature_values_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadFeatureValuesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadFeatureValuesResponse
  command.params['entityType'] = entity_type unless entity_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#read_project_location_index_endpoint_index_datapoints(index_endpoint, google_cloud_aiplatform_v1_read_index_datapoints_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadIndexDatapointsResponse

Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.

Parameters:

  • index_endpoint (String)

    Required. The name of the index endpoint. Format: projects/project/ locations/location/indexEndpoints/index_endpoint``

  • google_cloud_aiplatform_v1_read_index_datapoints_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadIndexDatapointsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9240

def read_project_location_index_endpoint_index_datapoints(index_endpoint, google_cloud_aiplatform_v1_read_index_datapoints_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+indexEndpoint}:readIndexDatapoints', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadIndexDatapointsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_read_index_datapoints_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadIndexDatapointsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadIndexDatapointsResponse
  command.params['indexEndpoint'] = index_endpoint unless index_endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#read_project_location_tensorboard_experiment_run_time_series(tensorboard_time_series, filter: nil, max_data_points: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse

Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.

Parameters:

  • tensorboard_time_series (String)

    Required. The resource name of the TensorboardTimeSeries to read data from. Format: projects/project/locations/location/tensorboards/tensorboard/ experiments/experiment/runs/run/timeSeries/time_series``

  • filter (String) (defaults to: nil)

    Reads the TensorboardTimeSeries' data that match the filter expression.

  • max_data_points (Fixnum) (defaults to: nil)

    The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19959
19960
19961
19962
19963
19964
19965
19966
19967
19968
19969
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19959

def read_project_location_tensorboard_experiment_run_time_series(tensorboard_time_series, filter: nil, max_data_points: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+tensorboardTimeSeries}:read', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse
  command.params['tensorboardTimeSeries'] = tensorboard_time_series unless tensorboard_time_series.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['maxDataPoints'] = max_data_points unless max_data_points.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#read_project_location_tensorboard_experiment_run_time_series_blob_data(time_series, blob_ids: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse

Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.

Parameters:

  • time_series (String)

    Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: projects/project/locations/location/tensorboards/tensorboard/ experiments/experiment/runs/run/timeSeries/time_series``

  • blob_ids (Array<String>, String) (defaults to: nil)

    IDs of the blobs to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19997
19998
19999
20000
20001
20002
20003
20004
20005
20006
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19997

def read_project_location_tensorboard_experiment_run_time_series_blob_data(time_series, blob_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+timeSeries}:readBlobData', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse
  command.params['timeSeries'] = time_series unless time_series.nil?
  command.query['blobIds'] = blob_ids unless blob_ids.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#read_project_location_tensorboard_size(tensorboard, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadTensorboardSizeResponse

Returns the storage size for a given TensorBoard instance.

Parameters:

  • tensorboard (String)

    Required. The name of the Tensorboard resource. Format: projects/project/ locations/location/tensorboards/tensorboard``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18753
18754
18755
18756
18757
18758
18759
18760
18761
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18753

def read_project_location_tensorboard_size(tensorboard, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+tensorboard}:readSize', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadTensorboardSizeResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadTensorboardSizeResponse
  command.params['tensorboard'] = tensorboard unless tensorboard.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#read_project_location_tensorboard_usage(tensorboard, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadTensorboardUsageResponse

Returns a list of monthly active users for a given TensorBoard instance.

Parameters:

  • tensorboard (String)

    Required. The name of the Tensorboard resource. Format: projects/project/ locations/location/tensorboards/tensorboard``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18784
18785
18786
18787
18788
18789
18790
18791
18792
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18784

def read_project_location_tensorboard_usage(tensorboard, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+tensorboard}:readUsage', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadTensorboardUsageResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadTensorboardUsageResponse
  command.params['tensorboard'] = tensorboard unless tensorboard.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#rebase_project_location_tuning_job_tuned_model(parent, google_cloud_aiplatform_v1_rebase_tuned_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Rebase a TunedModel.

Parameters:

  • parent (String)

    Required. The resource name of the Location into which to rebase the Model. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_rebase_tuned_model_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RebaseTunedModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20920
20921
20922
20923
20924
20925
20926
20927
20928
20929
20930
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20920

def rebase_project_location_tuning_job_tuned_model(parent, google_cloud_aiplatform_v1_rebase_tuned_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/tuningJobs:rebaseTunedModel', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RebaseTunedModelRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_rebase_tuned_model_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reboot_project_location_persistent_resource(name, google_cloud_aiplatform_v1_reboot_persistent_resource_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Reboots a PersistentResource.

Parameters:

  • name (String)

    Required. The name of the PersistentResource resource. Format: projects/ project_id_or_number/locations/location_id/persistentResources/ persistent_resource_id``

  • google_cloud_aiplatform_v1_reboot_persistent_resource_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RebootPersistentResourceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15780
15781
15782
15783
15784
15785
15786
15787
15788
15789
15790
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15780

def reboot_project_location_persistent_resource(name, google_cloud_aiplatform_v1_reboot_persistent_resource_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:reboot', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RebootPersistentResourceRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_reboot_persistent_resource_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#remove_project_location_index_datapoints(index, google_cloud_aiplatform_v1_remove_datapoints_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RemoveDatapointsResponse

Remove Datapoints from an Index.

Parameters:

  • index (String)

    Required. The name of the Index resource to be updated. Format: projects/ project/locations/location/indexes/index``

  • google_cloud_aiplatform_v1_remove_datapoints_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RemoveDatapointsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9671

def remove_project_location_index_datapoints(index, google_cloud_aiplatform_v1_remove_datapoints_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+index}:removeDatapoints', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RemoveDatapointsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_remove_datapoints_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RemoveDatapointsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RemoveDatapointsResponse
  command.params['index'] = index unless index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#remove_project_location_metadata_store_context_context_children(context, google_cloud_aiplatform_v1_remove_context_children_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RemoveContextChildrenResponse

Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.

Parameters:

  • context (String)

    Required. The resource name of the parent Context. Format: projects/project/ locations/location/metadataStores/metadatastore/contexts/context``

  • google_cloud_aiplatform_v1_remove_context_children_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RemoveContextChildrenRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10936

def (context, google_cloud_aiplatform_v1_remove_context_children_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+context}:removeContextChildren', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RemoveContextChildrenRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_remove_context_children_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RemoveContextChildrenResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RemoveContextChildrenResponse
  command.params['context'] = context unless context.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#restore_dataset_dataset_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Restores a dataset version.

Parameters:

  • name (String)

    Required. The name of the DatasetVersion resource. Format: projects/project/ locations/location/datasets/dataset/datasetVersions/dataset_version``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



451
452
453
454
455
456
457
458
459
# File 'lib/google/apis/aiplatform_v1/service.rb', line 451

def restore_dataset_dataset_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:restore', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#restore_project_location_dataset_dataset_version(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Restores a dataset version.

Parameters:

  • name (String)

    Required. The name of the DatasetVersion resource. Format: projects/project/ locations/location/datasets/dataset/datasetVersions/dataset_version``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2943
2944
2945
2946
2947
2948
2949
2950
2951
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2943

def restore_project_location_dataset_dataset_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:restore', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#resume_project_location_model_deployment_monitoring_job(name, google_cloud_aiplatform_v1_resume_model_deployment_monitoring_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.

Parameters:

  • name (String)

    Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: projects/project/locations/location/modelDeploymentMonitoringJobs/ model_deployment_monitoring_job``

  • google_cloud_aiplatform_v1_resume_model_deployment_monitoring_job_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12461

def resume_project_location_model_deployment_monitoring_job(name, google_cloud_aiplatform_v1_resume_model_deployment_monitoring_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:resume', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_resume_model_deployment_monitoring_job_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#resume_project_location_schedule(name, google_cloud_aiplatform_v1_resume_schedule_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Resumes a paused Schedule to start scheduling new runs. Will mark Schedule. state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catchUp is set up true, all missed runs will be scheduled for backfill first.

Parameters:

  • name (String)

    Required. The name of the Schedule resource to be resumed. Format: projects/ project/locations/location/schedules/schedule``

  • google_cloud_aiplatform_v1_resume_schedule_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ResumeScheduleRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17063
17064
17065
17066
17067
17068
17069
17070
17071
17072
17073
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17063

def resume_project_location_schedule(name, google_cloud_aiplatform_v1_resume_schedule_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:resume', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ResumeScheduleRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_resume_schedule_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_dataset_data_items(dataset, annotation_filters: nil, annotations_filter: nil, annotations_limit: nil, data_item_filter: nil, data_labeling_job: nil, field_mask: nil, order_by: nil, order_by_annotation_order_by: nil, order_by_annotation_saved_query: nil, order_by_data_item: nil, page_size: nil, page_token: nil, saved_query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchDataItemsResponse

Searches DataItems in a Dataset.

Parameters:

  • dataset (String)

    Required. The resource name of the Dataset from which to search DataItems. Format: projects/project/locations/location/datasets/dataset``

  • annotation_filters (Array<String>, String) (defaults to: nil)

    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 specify saved_query_id= - saved query id that annotations should belong to.

  • annotations_filter (String) (defaults to: nil)

    An expression for filtering the Annotations that will be returned per DataItem.

    • annotation_spec_id - for = or !=.
  • annotations_limit (Fixnum) (defaults to: nil)

    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.

  • data_item_filter (String) (defaults to: nil)

    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)

  • data_labeling_job (String) (defaults to: nil)

    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.

  • field_mask (String) (defaults to: nil)

    Mask specifying which fields of DataItemView to read.

  • order_by (String) (defaults to: nil)

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending.

  • order_by_annotation_order_by (String) (defaults to: nil)

    A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query.

  • order_by_annotation_saved_query (String) (defaults to: nil)

    Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.

  • order_by_data_item (String) (defaults to: nil)

    A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

  • page_size (Fixnum) (defaults to: nil)

    Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.

  • page_token (String) (defaults to: nil)

    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.

  • saved_query (String) (defaults to: nil)

    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.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2034

def search_project_location_dataset_data_items(dataset, annotation_filters: nil, annotations_filter: nil, annotations_limit: nil, data_item_filter: nil, data_labeling_job: nil, field_mask: nil, order_by: nil, order_by_annotation_order_by: nil, order_by_annotation_saved_query: nil, order_by_data_item: nil, page_size: nil, page_token: nil, saved_query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+dataset}:searchDataItems', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchDataItemsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchDataItemsResponse
  command.params['dataset'] = dataset unless dataset.nil?
  command.query['annotationFilters'] = annotation_filters unless annotation_filters.nil?
  command.query['annotationsFilter'] = annotations_filter unless annotations_filter.nil?
  command.query['annotationsLimit'] = annotations_limit unless annotations_limit.nil?
  command.query['dataItemFilter'] = data_item_filter unless data_item_filter.nil?
  command.query['dataLabelingJob'] = data_labeling_job unless data_labeling_job.nil?
  command.query['fieldMask'] = field_mask unless field_mask.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['orderByAnnotation.orderBy'] = order_by_annotation_order_by unless order_by_annotation_order_by.nil?
  command.query['orderByAnnotation.savedQuery'] = order_by_annotation_saved_query unless order_by_annotation_saved_query.nil?
  command.query['orderByDataItem'] = order_by_data_item unless order_by_data_item.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['savedQuery'] = saved_query unless saved_query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_feature_online_store_feature_view_nearest_entities(feature_view, google_cloud_aiplatform_v1_search_nearest_entities_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchNearestEntitiesResponse

Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.

Parameters:

  • feature_view (String)

    Required. FeatureView resource format projects/project/locations/location/ featureOnlineStores/featureOnlineStore/featureViews/featureView``

  • google_cloud_aiplatform_v1_search_nearest_entities_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchNearestEntitiesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6198

def search_project_location_feature_online_store_feature_view_nearest_entities(feature_view, google_cloud_aiplatform_v1_search_nearest_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+featureView}:searchNearestEntities', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchNearestEntitiesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_search_nearest_entities_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchNearestEntitiesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchNearestEntitiesResponse
  command.params['featureView'] = feature_view unless feature_view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_featurestore_features(location, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchFeaturesResponse

Searches Features matching a query in a given project.

Parameters:

  • location (String)

    Required. The resource name of the Location to search Features. Format: projects/project/locations/location``

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except page_size, must match the call that provided the page token.

  • query (String) (defaults to: nil)

    Query string that is a conjunction of field-restricted queries and/or field- restricted filters. Field-restricted queries and filters can be combined using AND to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric [a- zA-Z0-9], underscore _, or asterisk * are treated as delimiters for tokens. * is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks (" ). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * feature_id * description * entity_type_id Examples: * feature_id: foo --> Matches a Feature with ID containing the substring foo ( eg. foo, foofeature, barfoo). * feature_id: foo*feature --> Matches a Feature with ID containing the substring foo*feature (eg. foobarfeature). * feature_id: foo AND description: bar --> Matches a Feature with ID containing the substring foo and description containing the substring bar. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * feature_id: Supports = comparisons.

    • description: Supports = comparisons. Multi-token filters should be enclosed in quotes. * entity_type_id: Supports = comparisons. * value_type: Supports = and != comparisons. * labels: Supports key-value equality as well as key presence. * featurestore_id: Supports = comparisons. Examples: * description = "foo bar" --> Any Feature with description exactly equal to foo bar * value_type = DOUBLE --> Features whose type is DOUBLE. * labels. active = yes AND labels.env = prod --> Features having both (active: yes) and (env: prod) labels. * labels.env: * --> Any Feature which has a label with env as the key.
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7059

def search_project_location_featurestore_features(location, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+location}/featurestores:searchFeatures', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchFeaturesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchFeaturesResponse
  command.params['location'] = location unless location.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_migratable_resources(parent, google_cloud_aiplatform_v1_search_migratable_resources_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchMigratableResourcesResponse

Searches all of the resources in automl.googleapis.com, datalabeling. googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.

Parameters:

  • parent (String)

    Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_search_migratable_resources_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchMigratableResourcesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12001

def search_project_location_migratable_resources(parent, google_cloud_aiplatform_v1_search_migratable_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/migratableResources:search', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchMigratableResourcesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_search_migratable_resources_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchMigratableResourcesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchMigratableResourcesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_location_model_deployment_monitoring_job_model_deployment_monitoring_stats_anomalies(model_deployment_monitoring_job, google_cloud_aiplatform_v1_search_model_deployment_monitoring_stats_anomalies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse

Searches Model Monitoring Statistics generated within a given time window.

Parameters:

  • model_deployment_monitoring_job (String)

    Required. ModelDeploymentMonitoring Job resource name. Format: projects/ project/locations/location/modelDeploymentMonitoringJobs/ model_deployment_monitoring_job``

  • google_cloud_aiplatform_v1_search_model_deployment_monitoring_stats_anomalies_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12496

def search_project_location_model_deployment_monitoring_job_model_deployment_monitoring_stats_anomalies(model_deployment_monitoring_job, google_cloud_aiplatform_v1_search_model_deployment_monitoring_stats_anomalies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_search_model_deployment_monitoring_stats_anomalies_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse
  command.params['modelDeploymentMonitoringJob'] = model_deployment_monitoring_job unless model_deployment_monitoring_job.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#server_project_location_endpoint_streaming_predict(endpoint, google_cloud_aiplatform_v1_streaming_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamingPredictResponse

Perform a server-side streaming online prediction request for Vertex LLM streaming.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to serve the prediction. Format: projects/project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_streaming_predict_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamingPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4448

def server_project_location_endpoint_streaming_predict(endpoint, google_cloud_aiplatform_v1_streaming_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:serverStreamingPredict', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamingPredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_streaming_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamingPredictResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamingPredictResponse
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#server_project_location_publisher_model_streaming_predict(endpoint, google_cloud_aiplatform_v1_streaming_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamingPredictResponse

Perform a server-side streaming online prediction request for Vertex LLM streaming.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to serve the prediction. Format: projects/project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_streaming_predict_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamingPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16715
16716
16717
16718
16719
16720
16721
16722
16723
16724
16725
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16715

def server_project_location_publisher_model_streaming_predict(endpoint, google_cloud_aiplatform_v1_streaming_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:serverStreamingPredict', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamingPredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_streaming_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamingPredictResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamingPredictResponse
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_feature_online_store_feature_view_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • google_iam_v1_set_iam_policy_request_object (Google::Apis::AiplatformV1::GoogleIamV1SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6235

def set_project_location_feature_online_store_feature_view_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleIamV1SetIamPolicyRequest::Representation
  command.request_object = google_iam_v1_set_iam_policy_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_feature_online_store_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • google_iam_v1_set_iam_policy_request_object (Google::Apis::AiplatformV1::GoogleIamV1SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5826

def set_project_location_feature_online_store_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleIamV1SetIamPolicyRequest::Representation
  command.request_object = google_iam_v1_set_iam_policy_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_featurestore_entity_type_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • google_iam_v1_set_iam_policy_request_object (Google::Apis::AiplatformV1::GoogleIamV1SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7603

def set_project_location_featurestore_entity_type_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleIamV1SetIamPolicyRequest::Representation
  command.request_object = google_iam_v1_set_iam_policy_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_featurestore_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • google_iam_v1_set_iam_policy_request_object (Google::Apis::AiplatformV1::GoogleIamV1SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7097

def set_project_location_featurestore_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleIamV1SetIamPolicyRequest::Representation
  command.request_object = google_iam_v1_set_iam_policy_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_model_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • google_iam_v1_set_iam_policy_request_object (Google::Apis::AiplatformV1::GoogleIamV1SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13120

def set_project_location_model_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleIamV1SetIamPolicyRequest::Representation
  command.request_object = google_iam_v1_set_iam_policy_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_project_location_notebook_runtime_template_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

  • google_iam_v1_set_iam_policy_request_object (Google::Apis::AiplatformV1::GoogleIamV1SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
14708
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14698

def set_project_location_notebook_runtime_template_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleIamV1SetIamPolicyRequest::Representation
  command.request_object = google_iam_v1_set_iam_policy_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#start_project_location_notebook_runtime(name, google_cloud_aiplatform_v1_start_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Starts a NotebookRuntime.

Parameters:

  • name (String)

    Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

  • google_cloud_aiplatform_v1_start_notebook_runtime_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StartNotebookRuntimeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15129
15130
15131
15132
15133
15134
15135
15136
15137
15138
15139
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15129

def start_project_location_notebook_runtime(name, google_cloud_aiplatform_v1_start_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:start', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StartNotebookRuntimeRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_start_notebook_runtime_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stop_project_location_notebook_runtime(name, google_cloud_aiplatform_v1_stop_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Stops a NotebookRuntime.

Parameters:

  • name (String)

    Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

  • google_cloud_aiplatform_v1_stop_notebook_runtime_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StopNotebookRuntimeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15165
15166
15167
15168
15169
15170
15171
15172
15173
15174
15175
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15165

def stop_project_location_notebook_runtime(name, google_cloud_aiplatform_v1_stop_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:stop', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StopNotebookRuntimeRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_stop_notebook_runtime_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stop_project_location_study_trial(name, google_cloud_aiplatform_v1_stop_trial_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial

Stops a Trial.

Parameters:

  • name (String)

    Required. The Trial's name. Format: projects/project/locations/location/ studies/study/trials/trial``

  • google_cloud_aiplatform_v1_stop_trial_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StopTrialRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18270
18271
18272
18273
18274
18275
18276
18277
18278
18279
18280
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18270

def stop_project_location_study_trial(name, google_cloud_aiplatform_v1_stop_trial_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:stop', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StopTrialRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_stop_trial_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Trial
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stream_endpoint_generate_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse

Generate content with multimodal inputs with streaming support.

Parameters:

  • model (String)

    Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: projects/project/locations/ location/publishers/*/models/* Tuned model endpoint format: projects/ project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_generate_content_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



589
590
591
592
593
594
595
596
597
598
599
# File 'lib/google/apis/aiplatform_v1/service.rb', line 589

def stream_endpoint_generate_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+model}:streamGenerateContent', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_generate_content_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse
  command.params['model'] = model unless model.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stream_project_location_endpoint_generate_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse

Generate content with multimodal inputs with streaming support.

Parameters:

  • model (String)

    Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: projects/project/locations/ location/publishers/*/models/* Tuned model endpoint format: projects/ project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_generate_content_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4484

def stream_project_location_endpoint_generate_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+model}:streamGenerateContent', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_generate_content_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse
  command.params['model'] = model unless model.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stream_project_location_endpoint_raw_predict(endpoint, google_cloud_aiplatform_v1_stream_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleApiHttpBody

Perform a streaming online prediction with an arbitrary HTTP payload.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to serve the prediction. Format: projects/project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_stream_raw_predict_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamRawPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4518

def stream_project_location_endpoint_raw_predict(endpoint, google_cloud_aiplatform_v1_stream_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:streamRawPredict', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamRawPredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_stream_raw_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleApiHttpBody
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stream_project_location_publisher_model_generate_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse

Generate content with multimodal inputs with streaming support.

Parameters:

  • model (String)

    Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: projects/project/locations/ location/publishers/*/models/* Tuned model endpoint format: projects/ project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_generate_content_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16751
16752
16753
16754
16755
16756
16757
16758
16759
16760
16761
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16751

def stream_project_location_publisher_model_generate_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+model}:streamGenerateContent', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_generate_content_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse
  command.params['model'] = model unless model.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stream_project_location_publisher_model_raw_predict(endpoint, google_cloud_aiplatform_v1_stream_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleApiHttpBody

Perform a streaming online prediction with an arbitrary HTTP payload.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint requested to serve the prediction. Format: projects/project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_stream_raw_predict_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamRawPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16785
16786
16787
16788
16789
16790
16791
16792
16793
16794
16795
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16785

def stream_project_location_publisher_model_raw_predict(endpoint, google_cloud_aiplatform_v1_stream_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:streamRawPredict', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamRawPredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_stream_raw_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleApiHttpBody
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stream_publisher_model_generate_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse

Generate content with multimodal inputs with streaming support.

Parameters:

  • model (String)

    Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: projects/project/locations/ location/publishers/*/models/* Tuned model endpoint format: projects/ project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_generate_content_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



21246
21247
21248
21249
21250
21251
21252
21253
21254
21255
21256
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21246

def stream_publisher_model_generate_content(model, google_cloud_aiplatform_v1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+model}:streamGenerateContent', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_generate_content_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponse
  command.params['model'] = model unless model.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#streaming_project_location_featurestore_entity_type_read_feature_values(entity_type, google_cloud_aiplatform_v1_streaming_read_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadFeatureValuesResponse

Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.

Parameters:

  • entity_type (String)

    Required. The resource name of the entities' type. Value format: projects/ project/locations/location/featurestores/featurestore/entityTypes/ entityType`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could beuser`.

  • google_cloud_aiplatform_v1_streaming_read_feature_values_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7640

def streaming_project_location_featurestore_entity_type_read_feature_values(entity_type, google_cloud_aiplatform_v1_streaming_read_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+entityType}:streamingReadFeatureValues', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_streaming_read_feature_values_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadFeatureValuesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReadFeatureValuesResponse
  command.params['entityType'] = entity_type unless entity_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#suggest_project_location_study_trial(parent, google_cloud_aiplatform_v1_suggest_trials_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.

Parameters:

  • parent (String)

    Required. The project and location that the Study belongs to. Format: projects/project/locations/location/studies/study``

  • google_cloud_aiplatform_v1_suggest_trials_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SuggestTrialsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18307
18308
18309
18310
18311
18312
18313
18314
18315
18316
18317
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18307

def suggest_project_location_study_trial(parent, google_cloud_aiplatform_v1_suggest_trials_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/trials:suggest', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SuggestTrialsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_suggest_trials_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#sync_project_location_feature_online_store_feature_view(feature_view, google_cloud_aiplatform_v1_sync_feature_view_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SyncFeatureViewResponse

Triggers on-demand sync for the FeatureView.

Parameters:

  • feature_view (String)

    Required. Format: projects/project/locations/location/featureOnlineStores/ feature_online_store/featureViews/feature_view``

  • google_cloud_aiplatform_v1_sync_feature_view_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SyncFeatureViewRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6269

def sync_project_location_feature_online_store_feature_view(feature_view, google_cloud_aiplatform_v1_sync_feature_view_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+featureView}:sync', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SyncFeatureViewRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_sync_feature_view_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SyncFeatureViewResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SyncFeatureViewResponse
  command.params['featureView'] = feature_view unless feature_view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_project_location_feature_online_store_feature_view_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • permissions (Array<String>, String) (defaults to: nil)

    The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6311

def test_project_location_feature_online_store_feature_view_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['permissions'] = permissions unless permissions.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_project_location_feature_online_store_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • permissions (Array<String>, String) (defaults to: nil)

    The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5868

def test_project_location_feature_online_store_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['permissions'] = permissions unless permissions.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_project_location_featurestore_entity_type_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • permissions (Array<String>, String) (defaults to: nil)

    The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7682

def test_project_location_featurestore_entity_type_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['permissions'] = permissions unless permissions.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_project_location_featurestore_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • permissions (Array<String>, String) (defaults to: nil)

    The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7139

def test_project_location_featurestore_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['permissions'] = permissions unless permissions.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_project_location_model_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • permissions (Array<String>, String) (defaults to: nil)

    The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13162

def test_project_location_model_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['permissions'] = permissions unless permissions.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_project_location_notebook_runtime_template_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

  • permissions (Array<String>, String) (defaults to: nil)

    The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14740
14741
14742
14743
14744
14745
14746
14747
14748
14749
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14740

def test_project_location_notebook_runtime_template_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleIamV1TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['permissions'] = permissions unless permissions.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#undeploy_project_location_endpoint_model(endpoint, google_cloud_aiplatform_v1_undeploy_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.

Parameters:

  • endpoint (String)

    Required. The name of the Endpoint resource from which to undeploy a Model. Format: projects/project/locations/location/endpoints/endpoint``

  • google_cloud_aiplatform_v1_undeploy_model_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UndeployModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4553

def undeploy_project_location_endpoint_model(endpoint, google_cloud_aiplatform_v1_undeploy_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+endpoint}:undeployModel', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UndeployModelRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_undeploy_model_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['endpoint'] = endpoint unless endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#undeploy_project_location_index_endpoint_index(index_endpoint, google_cloud_aiplatform_v1_undeploy_index_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Parameters:

  • index_endpoint (String)

    Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/project/locations/location/indexEndpoints/ index_endpoint``

  • google_cloud_aiplatform_v1_undeploy_index_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UndeployIndexRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9276

def undeploy_project_location_index_endpoint_index(index_endpoint, google_cloud_aiplatform_v1_undeploy_index_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+indexEndpoint}:undeployIndex', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UndeployIndexRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_undeploy_index_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['indexEndpoint'] = index_endpoint unless index_endpoint.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_cache_config(name, google_cloud_aiplatform_v1_cache_config_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Updates a cache config.

Parameters:

  • name (String)

    Identifier. Name of the cache config. Format: - projects/project/ cacheConfig.

  • google_cloud_aiplatform_v1_cache_config_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CacheConfig) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



653
654
655
656
657
658
659
660
661
662
663
# File 'lib/google/apis/aiplatform_v1/service.rb', line 653

def update_project_cache_config(name, google_cloud_aiplatform_v1_cache_config_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CacheConfig::Representation
  command.request_object = google_cloud_aiplatform_v1_cache_config_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_model_explanation_dataset(model, google_cloud_aiplatform_v1_update_explanation_dataset_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Incrementally update the dataset used for an examples model.

Parameters:

  • model (String)

    Required. The resource name of the Model to update. Format: projects/project /locations/location/models/model``

  • google_cloud_aiplatform_v1_update_explanation_dataset_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UpdateExplanationDatasetRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13195

def update_project_location_model_explanation_dataset(model, google_cloud_aiplatform_v1_update_explanation_dataset_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+model}:updateExplanationDataset', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UpdateExplanationDatasetRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_update_explanation_dataset_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['model'] = model unless model.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upgrade_project_location_notebook_runtime(name, google_cloud_aiplatform_v1_upgrade_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Upgrades a NotebookRuntime.

Parameters:

  • name (String)

    Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

  • google_cloud_aiplatform_v1_upgrade_notebook_runtime_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15201
15202
15203
15204
15205
15206
15207
15208
15209
15210
15211
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15201

def upgrade_project_location_notebook_runtime(name, google_cloud_aiplatform_v1_upgrade_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:upgrade', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_upgrade_notebook_runtime_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upload_project_location_model(parent, google_cloud_aiplatform_v1_upload_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Uploads a Model artifact into Vertex AI.

Parameters:

  • parent (String)

    Required. The resource name of the Location into which to upload the Model. Format: projects/project/locations/location``

  • google_cloud_aiplatform_v1_upload_model_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UploadModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13229

def upload_project_location_model(parent, google_cloud_aiplatform_v1_upload_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/models:upload', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UploadModelRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_upload_model_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#upsert_project_location_index_datapoints(index, google_cloud_aiplatform_v1_upsert_datapoints_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UpsertDatapointsResponse

Add/update Datapoints into an Index.

Parameters:

  • index (String)

    Required. The name of the Index resource to be updated. Format: projects/ project/locations/location/indexes/index``

  • google_cloud_aiplatform_v1_upsert_datapoints_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UpsertDatapointsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9705

def upsert_project_location_index_datapoints(index, google_cloud_aiplatform_v1_upsert_datapoints_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+index}:upsertDatapoints', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UpsertDatapointsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_upsert_datapoints_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UpsertDatapointsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UpsertDatapointsResponse
  command.params['index'] = index unless index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_custom_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1325

def wait_project_location_custom_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_data_labeling_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1696

def wait_project_location_data_labeling_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_dataset_annotation_spec_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2263

def wait_project_location_dataset_annotation_spec_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_dataset_data_item_annotation_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2543

def wait_project_location_dataset_data_item_annotation_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_dataset_data_item_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2726

def wait_project_location_dataset_data_item_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_dataset_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3125

def wait_project_location_dataset_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_dataset_saved_query_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3386

def wait_project_location_dataset_saved_query_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_deployment_resource_pool_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3788

def wait_project_location_deployment_resource_pool_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_endpoint_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4771

def wait_project_location_endpoint_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_feature_group_feature_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5389

def wait_project_location_feature_group_feature_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_feature_group_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5535

def wait_project_location_feature_group_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_feature_online_store_feature_view_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6544

def wait_project_location_feature_online_store_feature_view_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_feature_online_store_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6690

def wait_project_location_feature_online_store_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_featurestore_entity_type_feature_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8170

def wait_project_location_featurestore_entity_type_feature_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_featurestore_entity_type_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8353

def wait_project_location_featurestore_entity_type_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_featurestore_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8536

def wait_project_location_featurestore_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_hyperparameter_tuning_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8914

def wait_project_location_hyperparameter_tuning_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_index_endpoint_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9460

def wait_project_location_index_endpoint_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_index_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9889

def wait_project_location_index_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_metadata_store_artifact_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10535

def (name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_metadata_store_context_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11120

def (name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_metadata_store_execution_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11627

def (name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_metadata_store_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11930

def (name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_migratable_resource_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12185

def wait_project_location_migratable_resource_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_model_deployment_monitoring_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12680

def wait_project_location_model_deployment_monitoring_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_model_evaluation_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13523

def wait_project_location_model_evaluation_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_model_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13819
13820
13821
13822
13823
13824
13825
13826
13827
13828
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13819

def wait_project_location_model_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_notebook_execution_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14417
14418
14419
14420
14421
14422
14423
14424
14425
14426
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14417

def wait_project_location_notebook_execution_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_notebook_runtime_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15385
15386
15387
15388
15389
15390
15391
15392
15393
15394
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15385

def wait_project_location_notebook_runtime_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_notebook_runtime_template_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14923
14924
14925
14926
14927
14928
14929
14930
14931
14932
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14923

def wait_project_location_notebook_runtime_template_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15568
15569
15570
15571
15572
15573
15574
15575
15576
15577
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15568

def wait_project_location_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_persistent_resource_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15964
15965
15966
15967
15968
15969
15970
15971
15972
15973
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15964

def wait_project_location_persistent_resource_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_pipeline_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16436
16437
16438
16439
16440
16441
16442
16443
16444
16445
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16436

def wait_project_location_pipeline_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_schedule_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17247
17248
17249
17250
17251
17252
17253
17254
17255
17256
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17247

def wait_project_location_schedule_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_specialist_pool_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17609
17610
17611
17612
17613
17614
17615
17616
17617
17618
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17609

def wait_project_location_specialist_pool_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_study_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17962
17963
17964
17965
17966
17967
17968
17969
17970
17971
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17962

def wait_project_location_study_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_study_trial_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18491
18492
18493
18494
18495
18496
18497
18498
18499
18500
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18491

def wait_project_location_study_trial_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_tensorboard_experiment_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19235
19236
19237
19238
19239
19240
19241
19242
19243
19244
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19235

def wait_project_location_tensorboard_experiment_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_tensorboard_experiment_run_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19687
19688
19689
19690
19691
19692
19693
19694
19695
19696
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19687

def wait_project_location_tensorboard_experiment_run_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_tensorboard_experiment_run_time_series_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20180
20181
20182
20183
20184
20185
20186
20187
20188
20189
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20180

def wait_project_location_tensorboard_experiment_run_time_series_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_tensorboard_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20363
20364
20365
20366
20367
20368
20369
20370
20371
20372
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20363

def wait_project_location_tensorboard_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#wait_project_location_training_pipeline_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code. UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Parameters:

  • name (String)

    The name of the operation resource to wait on.

  • timeout (String) (defaults to: nil)

    The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20739
20740
20741
20742
20743
20744
20745
20746
20747
20748
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20739

def wait_project_location_training_pipeline_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['timeout'] = timeout unless timeout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#write_project_location_featurestore_entity_type_feature_values(entity_type, google_cloud_aiplatform_v1_write_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1WriteFeatureValuesResponse

Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

Parameters:

  • entity_type (String)

    Required. The resource name of the EntityType for the entities being written. Value format: projects/project/locations/location/featurestores/ featurestore/entityTypes/entityType`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could beuser`.

  • google_cloud_aiplatform_v1_write_feature_values_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1WriteFeatureValuesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7719

def write_project_location_featurestore_entity_type_feature_values(entity_type, google_cloud_aiplatform_v1_write_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+entityType}:writeFeatureValues', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1WriteFeatureValuesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_write_feature_values_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1WriteFeatureValuesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1WriteFeatureValuesResponse
  command.params['entityType'] = entity_type unless entity_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#write_project_location_tensorboard_experiment(tensorboard_experiment, google_cloud_aiplatform_v1_write_tensorboard_experiment_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse

Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.

Parameters:

  • tensorboard_experiment (String)

    Required. The resource name of the TensorboardExperiment to write data to. Format: projects/project/locations/location/tensorboards/tensorboard/ experiments/experiment``

  • google_cloud_aiplatform_v1_write_tensorboard_experiment_data_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19051
19052
19053
19054
19055
19056
19057
19058
19059
19060
19061
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19051

def write_project_location_tensorboard_experiment(tensorboard_experiment, google_cloud_aiplatform_v1_write_tensorboard_experiment_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+tensorboardExperiment}:write', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_write_tensorboard_experiment_data_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse
  command.params['tensorboardExperiment'] = tensorboard_experiment unless tensorboard_experiment.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#write_project_location_tensorboard_experiment_run(tensorboard_run, google_cloud_aiplatform_v1_write_tensorboard_run_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1WriteTensorboardRunDataResponse

Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.

Parameters:

  • tensorboard_run (String)

    Required. The resource name of the TensorboardRun to write data to. Format: projects/project/locations/location/tensorboards/tensorboard/experiments/ experiment/runs/run``

  • google_cloud_aiplatform_v1_write_tensorboard_run_data_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1WriteTensorboardRunDataRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19503
19504
19505
19506
19507
19508
19509
19510
19511
19512
19513
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19503

def write_project_location_tensorboard_experiment_run(tensorboard_run, google_cloud_aiplatform_v1_write_tensorboard_run_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+tensorboardRun}:write', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1WriteTensorboardRunDataRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_write_tensorboard_run_data_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1WriteTensorboardRunDataResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1WriteTensorboardRunDataResponse
  command.params['tensorboardRun'] = tensorboard_run unless tensorboard_run.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end