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



10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10931

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



10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10968

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



11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11517

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



19458
19459
19460
19461
19462
19463
19464
19465
19466
19467
19468
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19458

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



15320
15321
15322
15323
15324
15325
15326
15327
15328
15329
15330
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15320

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

#augment_project_location_prompt(parent, google_cloud_aiplatform_v1_augment_prompt_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AugmentPromptResponse

Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.

Parameters:

  • parent (String)

    Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: projects/ project/locations/location``.

  • google_cloud_aiplatform_v1_augment_prompt_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AugmentPromptRequest) (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



734
735
736
737
738
739
740
741
742
743
744
# File 'lib/google/apis/aiplatform_v1/service.rb', line 734

def augment_project_location_prompt(parent, google_cloud_aiplatform_v1_augment_prompt_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}:augmentPrompt', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AugmentPromptRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_augment_prompt_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AugmentPromptResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AugmentPromptResponse
  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



5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5372

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



8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8116

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



7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7089

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



12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12325

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



13918
13919
13920
13921
13922
13923
13924
13925
13926
13927
13928
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13918

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



16366
16367
16368
16369
16370
16371
16372
16373
16374
16375
16376
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16366

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



16401
16402
16403
16404
16405
16406
16407
16408
16409
16410
16411
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16401

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



20281
20282
20283
20284
20285
20286
20287
20288
20289
20290
20291
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20281

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



20732
20733
20734
20735
20736
20737
20738
20739
20740
20741
20742
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20732

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



19995
19996
19997
19998
19999
20000
20001
20002
20003
20004
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19995

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



953
954
955
956
957
958
959
960
961
962
963
# File 'lib/google/apis/aiplatform_v1/service.rb', line 953

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



1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1319

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



1507
1508
1509
1510
1511
1512
1513
1514
1515
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1507

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



1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1685

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



1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1878

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



2446
2447
2448
2449
2450
2451
2452
2453
2454
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2446

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



2726
2727
2728
2729
2730
2731
2732
2733
2734
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2726

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



2909
2910
2911
2912
2913
2914
2915
2916
2917
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2909

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



3308
3309
3310
3311
3312
3313
3314
3315
3316
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3308

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



3569
3570
3571
3572
3573
3574
3575
3576
3577
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3569

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



3971
3972
3973
3974
3975
3976
3977
3978
3979
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3971

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



4987
4988
4989
4990
4991
4992
4993
4994
4995
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4987

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



8386
8387
8388
8389
8390
8391
8392
8393
8394
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8386

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



8569
8570
8571
8572
8573
8574
8575
8576
8577
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8569

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



8752
8753
8754
8755
8756
8757
8758
8759
8760
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8752

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



8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8939

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



9130
9131
9132
9133
9134
9135
9136
9137
9138
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9130

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



9676
9677
9678
9679
9680
9681
9682
9683
9684
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9676

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



10105
10106
10107
10108
10109
10110
10111
10112
10113
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10105

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



10751
10752
10753
10754
10755
10756
10757
10758
10759
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10751

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



11336
11337
11338
11339
11340
11341
11342
11343
11344
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11336

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



11843
11844
11845
11846
11847
11848
11849
11850
11851
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11843

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



12146
12147
12148
12149
12150
12151
12152
12153
12154
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12146

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



12401
12402
12403
12404
12405
12406
12407
12408
12409
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12401

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



12896
12897
12898
12899
12900
12901
12902
12903
12904
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12896

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



13739
13740
13741
13742
13743
13744
13745
13746
13747
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13739

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



14035
14036
14037
14038
14039
14040
14041
14042
14043
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14035

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



14219
14220
14221
14222
14223
14224
14225
14226
14227
14228
14229
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14219

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



14633
14634
14635
14636
14637
14638
14639
14640
14641
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14633

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



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

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



15141
15142
15143
15144
15145
15146
15147
15148
15149
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15141

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



15788
15789
15790
15791
15792
15793
15794
15795
15796
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15788

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



16184
16185
16186
16187
16188
16189
16190
16191
16192
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16184

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



16442
16443
16444
16445
16446
16447
16448
16449
16450
16451
16452
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16442

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



16656
16657
16658
16659
16660
16661
16662
16663
16664
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16656

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_rag_corpora_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



17361
17362
17363
17364
17365
17366
17367
17368
17369
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17361

def cancel_project_location_rag_corpora_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_rag_corpora_rag_file_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



17679
17680
17681
17682
17683
17684
17685
17686
17687
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17679

def cancel_project_location_rag_corpora_rag_file_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_reasoning_engine_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



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

def cancel_project_location_reasoning_engine_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



18564
18565
18566
18567
18568
18569
18570
18571
18572
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18564

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



18926
18927
18928
18929
18930
18931
18932
18933
18934
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18926

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



19279
19280
19281
19282
19283
19284
19285
19286
19287
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19279

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



19808
19809
19810
19811
19812
19813
19814
19815
19816
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19808

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



20552
20553
20554
20555
20556
20557
20558
20559
20560
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20552

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



21004
21005
21006
21007
21008
21009
21010
21011
21012
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21004

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



21497
21498
21499
21500
21501
21502
21503
21504
21505
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21497

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



21680
21681
21682
21683
21684
21685
21686
21687
21688
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21680

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



21865
21866
21867
21868
21869
21870
21871
21872
21873
21874
21875
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21865

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



22056
22057
22058
22059
22060
22061
22062
22063
22064
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22056

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



22241
22242
22243
22244
22245
22246
22247
22248
22249
22250
22251
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22241

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



22422
22423
22424
22425
22426
22427
22428
22429
22430
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22422

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



19494
19495
19496
19497
19498
19499
19500
19501
19502
19503
19504
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19494

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



19528
19529
19530
19531
19532
19533
19534
19535
19536
19537
19538
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19528

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



4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4948

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



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

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



4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4149

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



16834
16835
16836
16837
16838
16839
16840
16841
16842
16843
16844
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16834

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



22558
22559
22560
22561
22562
22563
22564
22565
22566
22567
22568
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22558

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



13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13078

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

#corroborate_project_location_content(parent, google_cloud_aiplatform_v1_corroborate_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CorroborateContentResponse

Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.

Parameters:

  • parent (String)

    Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: projects/project/locations/location``.

  • google_cloud_aiplatform_v1_corroborate_content_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CorroborateContentRequest) (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



771
772
773
774
775
776
777
778
779
780
781
# File 'lib/google/apis/aiplatform_v1/service.rb', line 771

def corroborate_project_location_content(parent, google_cloud_aiplatform_v1_corroborate_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}:corroborateContent', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CorroborateContentRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_corroborate_content_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CorroborateContentResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CorroborateContentResponse
  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



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

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



4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4183

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



16868
16869
16870
16871
16872
16873
16874
16875
16876
16877
16878
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16868

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



22592
22593
22594
22595
22596
22597
22598
22599
22600
22601
22602
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22592

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



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

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



988
989
990
991
992
993
994
995
996
997
998
# File 'lib/google/apis/aiplatform_v1/service.rb', line 988

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_cached_content(parent, google_cloud_aiplatform_v1_cached_content_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CachedContent

Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.

Parameters:

  • parent (String)

    Required. The parent resource where the cached content will be created

  • google_cloud_aiplatform_v1_cached_content_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CachedContent) (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



1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1139

def create_project_location_cached_content(parent, google_cloud_aiplatform_v1_cached_content_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/cachedContents', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CachedContent::Representation
  command.request_object = google_cloud_aiplatform_v1_cached_content_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CachedContent::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CachedContent
  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



1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1354

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



1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1719

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



2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2056

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



3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3087

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



3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3747

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



4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4227

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



5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5170

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



5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5414

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



5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5934

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



6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6271

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



7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7128

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



7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7538

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



8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8158

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



8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8973

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



9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9854

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



9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9308

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



10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10291

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



10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10442

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



11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11011

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



11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11560

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



12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12030

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



12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12580

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



14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14253

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



14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14473

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



14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14813

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



15970
15971
15972
15973
15974
15975
15976
15977
15978
15979
15980
15981
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15970

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



16481
16482
16483
16484
16485
16486
16487
16488
16489
16490
16491
16492
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16481

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_rag_corpora(parent, google_cloud_aiplatform_v1_rag_corpus_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a RagCorpus.

Parameters:

  • parent (String)

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

  • google_cloud_aiplatform_v1_rag_corpus_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RagCorpus) (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



17184
17185
17186
17187
17188
17189
17190
17191
17192
17193
17194
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17184

def create_project_location_rag_corpora(parent, google_cloud_aiplatform_v1_rag_corpus_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/ragCorpora', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RagCorpus::Representation
  command.request_object = google_cloud_aiplatform_v1_rag_corpus_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_reasoning_engine(parent, google_cloud_aiplatform_v1_reasoning_engine_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Creates a reasoning engine.

Parameters:

  • parent (String)

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

  • google_cloud_aiplatform_v1_reasoning_engine_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReasoningEngine) (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



17857
17858
17859
17860
17861
17862
17863
17864
17865
17866
17867
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17857

def create_project_location_reasoning_engine(parent, google_cloud_aiplatform_v1_reasoning_engine_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/reasoningEngines', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReasoningEngine::Representation
  command.request_object = google_cloud_aiplatform_v1_reasoning_engine_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_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



18281
18282
18283
18284
18285
18286
18287
18288
18289
18290
18291
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18281

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



18742
18743
18744
18745
18746
18747
18748
18749
18750
18751
18752
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18742

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



19104
19105
19106
19107
19108
19109
19110
19111
19112
19113
19114
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19104

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



19562
19563
19564
19565
19566
19567
19568
19569
19570
19571
19572
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19562

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



20028
20029
20030
20031
20032
20033
20034
20035
20036
20037
20038
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20028

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



20320
20321
20322
20323
20324
20325
20326
20327
20328
20329
20330
20331
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20320

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



20771
20772
20773
20774
20775
20776
20777
20778
20779
20780
20781
20782
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20771

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



21187
21188
21189
21190
21191
21192
21193
21194
21195
21196
21197
21198
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21187

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



21900
21901
21902
21903
21904
21905
21906
21907
21908
21909
21910
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21900

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



22276
22277
22278
22279
22280
22281
22282
22283
22284
22285
22286
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22276

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



302
303
304
305
306
307
308
309
310
# File 'lib/google/apis/aiplatform_v1/service.rb', line 302

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



1022
1023
1024
1025
1026
1027
1028
1029
1030
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1022

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_cached_content(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleProtobufEmpty

Deletes cached content

Parameters:

  • name (String)

    Required. The resource name referring to the cached content

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1171
1172
1173
1174
1175
1176
1177
1178
1179
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1171

def delete_project_location_cached_content(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_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



1387
1388
1389
1390
1391
1392
1393
1394
1395
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1387

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



1540
1541
1542
1543
1544
1545
1546
1547
1548
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1540

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



1752
1753
1754
1755
1756
1757
1758
1759
1760
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1752

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



1911
1912
1913
1914
1915
1916
1917
1918
1919
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1911

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



2089
2090
2091
2092
2093
2094
2095
2096
2097
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2089

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



2479
2480
2481
2482
2483
2484
2485
2486
2487
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2479

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



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

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



2942
2943
2944
2945
2946
2947
2948
2949
2950
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2942

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



3121
3122
3123
3124
3125
3126
3127
3128
3129
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3121

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



3341
3342
3343
3344
3345
3346
3347
3348
3349
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3341

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



3485
3486
3487
3488
3489
3490
3491
3492
3493
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3485

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



3602
3603
3604
3605
3606
3607
3608
3609
3610
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3602

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



3781
3782
3783
3784
3785
3786
3787
3788
3789
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3781

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



4004
4005
4006
4007
4008
4009
4010
4011
4012
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4004

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



4261
4262
4263
4264
4265
4266
4267
4268
4269
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4261

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



5020
5021
5022
5023
5024
5025
5026
5027
5028
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5020

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



5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5207

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



5450
5451
5452
5453
5454
5455
5456
5457
5458
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5450

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



5638
5639
5640
5641
5642
5643
5644
5645
5646
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5638

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



5784
5785
5786
5787
5788
5789
5790
5791
5792
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5784

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



5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5973

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



6307
6308
6309
6310
6311
6312
6313
6314
6315
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6307

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



6793
6794
6795
6796
6797
6798
6799
6800
6801
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6793

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



6939
6940
6941
6942
6943
6944
6945
6946
6947
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6939

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



7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7167

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



7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7576

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



8194
8195
8196
8197
8198
8199
8200
8201
8202
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8194

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



8419
8420
8421
8422
8423
8424
8425
8426
8427
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8419

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



7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7616

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



8602
8603
8604
8605
8606
8607
8608
8609
8610
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8602

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



8785
8786
8787
8788
8789
8790
8791
8792
8793
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8785

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



9007
9008
9009
9010
9011
9012
9013
9014
9015
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9007

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



9163
9164
9165
9166
9167
9168
9169
9170
9171
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9163

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



9888
9889
9890
9891
9892
9893
9894
9895
9896
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9888

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



9341
9342
9343
9344
9345
9346
9347
9348
9349
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9341

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



9709
9710
9711
9712
9713
9714
9715
9716
9717
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9709

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



10138
10139
10140
10141
10142
10143
10144
10145
10146
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10138

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



10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10328

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



10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10481

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



10784
10785
10786
10787
10788
10789
10790
10791
10792
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10784

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



11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11053

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



11369
11370
11371
11372
11373
11374
11375
11376
11377
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11369

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



11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11599

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



11876
11877
11878
11879
11880
11881
11882
11883
11884
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11876

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



12179
12180
12181
12182
12183
12184
12185
12186
12187
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12179

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



12434
12435
12436
12437
12438
12439
12440
12441
12442
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12434

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



13112
13113
13114
13115
13116
13117
13118
13119
13120
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13112

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



12614
12615
12616
12617
12618
12619
12620
12621
12622
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12614

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



12929
12930
12931
12932
12933
12934
12935
12936
12937
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12929

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



13772
13773
13774
13775
13776
13777
13778
13779
13780
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13772

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



14068
14069
14070
14071
14072
14073
14074
14075
14076
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14068

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



13146
13147
13148
13149
13150
13151
13152
13153
13154
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13146

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



14286
14287
14288
14289
14290
14291
14292
14293
14294
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14286

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



14506
14507
14508
14509
14510
14511
14512
14513
14514
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14506

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



14666
14667
14668
14669
14670
14671
14672
14673
14674
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14666

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



15355
15356
15357
15358
15359
15360
15361
15362
15363
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15355

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



15638
15639
15640
15641
15642
15643
15644
15645
15646
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15638

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



14848
14849
14850
14851
14852
14853
14854
14855
14856
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14848

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



15174
15175
15176
15177
15178
15179
15180
15181
15182
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15174

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



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

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



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

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



16217
16218
16219
16220
16221
16222
16223
16224
16225
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16217

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



16515
16516
16517
16518
16519
16520
16521
16522
16523
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16515

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



16689
16690
16691
16692
16693
16694
16695
16696
16697
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16689

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_rag_corpora(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a RagCorpus.

Parameters:

  • name (String)

    Required. The name of the RagCorpus resource to be deleted. Format: projects/ project/locations/location/ragCorpora/rag_corpus``

  • force (Boolean) (defaults to: nil)

    Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17220
17221
17222
17223
17224
17225
17226
17227
17228
17229
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17220

def delete_project_location_rag_corpora(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_rag_corpora_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



17394
17395
17396
17397
17398
17399
17400
17401
17402
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17394

def delete_project_location_rag_corpora_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_rag_corpora_rag_file(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a RagFile.

Parameters:

  • name (String)

    Required. The name of the RagFile resource to be deleted. Format: projects/ project/locations/location/ragCorpora/rag_corpus/ragFiles/rag_file``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17538
17539
17540
17541
17542
17543
17544
17545
17546
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17538

def delete_project_location_rag_corpora_rag_file(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_rag_corpora_rag_file_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



17712
17713
17714
17715
17716
17717
17718
17719
17720
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17712

def delete_project_location_rag_corpora_rag_file_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_reasoning_engine(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Deletes a reasoning engine.

Parameters:

  • name (String)

    Required. The name of the ReasoningEngine resource to be deleted. Format: projects/project/locations/location/reasoningEngines/reasoning_engine``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17890
17891
17892
17893
17894
17895
17896
17897
17898
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17890

def delete_project_location_reasoning_engine(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_reasoning_engine_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



18136
18137
18138
18139
18140
18141
18142
18143
18144
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18136

def delete_project_location_reasoning_engine_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



18314
18315
18316
18317
18318
18319
18320
18321
18322
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18314

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



18597
18598
18599
18600
18601
18602
18603
18604
18605
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18597

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



18779
18780
18781
18782
18783
18784
18785
18786
18787
18788
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18779

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



18959
18960
18961
18962
18963
18964
18965
18966
18967
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18959

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



19137
19138
19139
19140
19141
19142
19143
19144
19145
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19137

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



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

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



19595
19596
19597
19598
19599
19600
19601
19602
19603
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19595

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



19841
19842
19843
19844
19845
19846
19847
19848
19849
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19841

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



20061
20062
20063
20064
20065
20066
20067
20068
20069
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20061

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



20355
20356
20357
20358
20359
20360
20361
20362
20363
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20355

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



20585
20586
20587
20588
20589
20590
20591
20592
20593
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20585

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



20806
20807
20808
20809
20810
20811
20812
20813
20814
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20806

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



21037
21038
21039
21040
21041
21042
21043
21044
21045
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21037

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



21222
21223
21224
21225
21226
21227
21228
21229
21230
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21222

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



21530
21531
21532
21533
21534
21535
21536
21537
21538
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21530

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



21713
21714
21715
21716
21717
21718
21719
21720
21721
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21713

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



21933
21934
21935
21936
21937
21938
21939
21940
21941
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21933

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



22089
22090
22091
22092
22093
22094
22095
22096
22097
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22089

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



22455
22456
22457
22458
22459
22460
22461
22462
22463
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22455

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



4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4293

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



9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9375

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



4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4328

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



4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4363

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



805
806
807
808
809
810
811
812
813
814
815
# File 'lib/google/apis/aiplatform_v1/service.rb', line 805

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



4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4400

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



2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2121

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



7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7651

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



13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13181

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



21255
21256
21257
21258
21259
21260
21261
21262
21263
21264
21265
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21255

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



4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4435

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



6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6339

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



16903
16904
16905
16906
16907
16908
16909
16910
16911
16912
16913
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16903

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



9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9409

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



554
555
556
557
558
559
560
561
562
563
564
# File 'lib/google/apis/aiplatform_v1/service.rb', line 554

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



4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4471

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



16939
16940
16941
16942
16943
16944
16945
16946
16947
16948
16949
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16939

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



22628
22629
22630
22631
22632
22633
22634
22635
22636
22637
22638
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22628

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



336
337
338
339
340
341
342
343
344
345
# File 'lib/google/apis/aiplatform_v1/service.rb', line 336

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



666
667
668
669
670
671
672
673
674
# File 'lib/google/apis/aiplatform_v1/service.rb', line 666

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



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

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



1053
1054
1055
1056
1057
1058
1059
1060
1061
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1053

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_cached_content(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CachedContent

Gets cached content configurations

Parameters:

  • name (String)

    Required. The resource name referring to the cached content

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1201
1202
1203
1204
1205
1206
1207
1208
1209
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1201

def get_project_location_cached_content(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CachedContent::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CachedContent
  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



1418
1419
1420
1421
1422
1423
1424
1425
1426
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1418

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



1571
1572
1573
1574
1575
1576
1577
1578
1579
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1571

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



1783
1784
1785
1786
1787
1788
1789
1790
1791
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1783

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



1942
1943
1944
1945
1946
1947
1948
1949
1950
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1942

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



2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2155

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



2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2408

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



2510
2511
2512
2513
2514
2515
2516
2517
2518
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2510

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



2790
2791
2792
2793
2794
2795
2796
2797
2798
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2790

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



2973
2974
2975
2976
2977
2978
2979
2980
2981
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2973

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



3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3155

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



3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3372

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



3633
3634
3635
3636
3637
3638
3639
3640
3641
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3633

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



3813
3814
3815
3816
3817
3818
3819
3820
3821
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3813

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



4035
4036
4037
4038
4039
4040
4041
4042
4043
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4035

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



4504
4505
4506
4507
4508
4509
4510
4511
4512
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4504

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



5051
5052
5053
5054
5055
5056
5057
5058
5059
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5051

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



5238
5239
5240
5241
5242
5243
5244
5245
5246
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5238

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



5483
5484
5485
5486
5487
5488
5489
5490
5491
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5483

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



5669
5670
5671
5672
5673
5674
5675
5676
5677
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5669

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



5815
5816
5817
5818
5819
5820
5821
5822
5823
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5815

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



6004
6005
6006
6007
6008
6009
6010
6011
6012
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6004

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



6373
6374
6375
6376
6377
6378
6379
6380
6381
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6373

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



6705
6706
6707
6708
6709
6710
6711
6712
6713
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6705

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



6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6417

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



6824
6825
6826
6827
6828
6829
6830
6831
6832
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6824

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



6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6048

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



6970
6971
6972
6973
6974
6975
6976
6977
6978
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6970

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



7198
7199
7200
7201
7202
7203
7204
7205
7206
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7198

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



7684
7685
7686
7687
7688
7689
7690
7691
7692
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7684

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



8227
8228
8229
8230
8231
8232
8233
8234
8235
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8227

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



8450
8451
8452
8453
8454
8455
8456
8457
8458
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8450

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



7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7728

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



8633
8634
8635
8636
8637
8638
8639
8640
8641
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8633

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



7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7242

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



8816
8817
8818
8819
8820
8821
8822
8823
8824
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8816

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



9039
9040
9041
9042
9043
9044
9045
9046
9047
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9039

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



9194
9195
9196
9197
9198
9199
9200
9201
9202
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9194

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



9919
9920
9921
9922
9923
9924
9925
9926
9927
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9919

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



9442
9443
9444
9445
9446
9447
9448
9449
9450
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9442

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



9740
9741
9742
9743
9744
9745
9746
9747
9748
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9740

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



10169
10170
10171
10172
10173
10174
10175
10176
10177
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10169

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



10360
10361
10362
10363
10364
10365
10366
10367
10368
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10360

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



10514
10515
10516
10517
10518
10519
10520
10521
10522
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10514

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



10815
10816
10817
10818
10819
10820
10821
10822
10823
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10815

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



11087
11088
11089
11090
11091
11092
11093
11094
11095
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11087

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



11400
11401
11402
11403
11404
11405
11406
11407
11408
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11400

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



11632
11633
11634
11635
11636
11637
11638
11639
11640
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11632

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



11907
11908
11909
11910
11911
11912
11913
11914
11915
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11907

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



12065
12066
12067
12068
12069
12070
12071
12072
12073
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12065

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



12210
12211
12212
12213
12214
12215
12216
12217
12218
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12210

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



12465
12466
12467
12468
12469
12470
12471
12472
12473
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12465

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



13220
13221
13222
13223
13224
13225
13226
13227
13228
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13220

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



12646
12647
12648
12649
12650
12651
12652
12653
12654
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12646

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



12960
12961
12962
12963
12964
12965
12966
12967
12968
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12960

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



13623
13624
13625
13626
13627
13628
13629
13630
13631
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13623

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



13803
13804
13805
13806
13807
13808
13809
13810
13811
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13803

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



13952
13953
13954
13955
13956
13957
13958
13959
13960
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13952

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



13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13264

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



14099
14100
14101
14102
14103
14104
14105
14106
14107
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14099

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



14317
14318
14319
14320
14321
14322
14323
14324
14325
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14317

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



14400
14401
14402
14403
14404
14405
14406
14407
14408
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14400

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



14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14538

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



14697
14698
14699
14700
14701
14702
14703
14704
14705
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14697

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



15387
15388
15389
15390
15391
15392
15393
15394
15395
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15387

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



15669
15670
15671
15672
15673
15674
15675
15676
15677
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15669

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



14880
14881
14882
14883
14884
14885
14886
14887
14888
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14880

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



14924
14925
14926
14927
14928
14929
14930
14931
14932
14933
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14924

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



15205
15206
15207
15208
15209
15210
15211
15212
15213
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15205

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



15852
15853
15854
15855
15856
15857
15858
15859
15860
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15852

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



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

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



16248
16249
16250
16251
16252
16253
16254
16255
16256
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16248

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



16546
16547
16548
16549
16550
16551
16552
16553
16554
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16546

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



16720
16721
16722
16723
16724
16725
16726
16727
16728
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16720

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_rag_corpora(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RagCorpus

Gets a RagCorpus.

Parameters:

  • name (String)

    Required. The name of the RagCorpus resource. Format: projects/project/ locations/location/ragCorpora/rag_corpus``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17252
17253
17254
17255
17256
17257
17258
17259
17260
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17252

def get_project_location_rag_corpora(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RagCorpus::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RagCorpus
  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_rag_corpora_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



17425
17426
17427
17428
17429
17430
17431
17432
17433
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17425

def get_project_location_rag_corpora_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_rag_corpora_rag_file(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RagFile

Gets a RagFile.

Parameters:

  • name (String)

    Required. The name of the RagFile resource. Format: projects/project/ locations/location/ragCorpora/rag_corpus/ragFiles/rag_file``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17569
17570
17571
17572
17573
17574
17575
17576
17577
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17569

def get_project_location_rag_corpora_rag_file(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RagFile::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RagFile
  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_rag_corpora_rag_file_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



17743
17744
17745
17746
17747
17748
17749
17750
17751
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17743

def get_project_location_rag_corpora_rag_file_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_reasoning_engine(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReasoningEngine

Gets a reasoning engine.

Parameters:

  • name (String)

    Required. The name of the ReasoningEngine resource. Format: projects/project /locations/location/reasoningEngines/reasoning_engine``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17921
17922
17923
17924
17925
17926
17927
17928
17929
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17921

def get_project_location_reasoning_engine(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReasoningEngine::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReasoningEngine
  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_reasoning_engine_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



18167
18168
18169
18170
18171
18172
18173
18174
18175
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18167

def get_project_location_reasoning_engine_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



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

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



18628
18629
18630
18631
18632
18633
18634
18635
18636
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18628

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



18811
18812
18813
18814
18815
18816
18817
18818
18819
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18811

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



18990
18991
18992
18993
18994
18995
18996
18997
18998
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18990

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



19168
19169
19170
19171
19172
19173
19174
19175
19176
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19168

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



19343
19344
19345
19346
19347
19348
19349
19350
19351
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19343

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



19626
19627
19628
19629
19630
19631
19632
19633
19634
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19626

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



19872
19873
19874
19875
19876
19877
19878
19879
19880
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19872

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



20092
20093
20094
20095
20096
20097
20098
20099
20100
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20092

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



20387
20388
20389
20390
20391
20392
20393
20394
20395
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20387

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



20616
20617
20618
20619
20620
20621
20622
20623
20624
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20616

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



20838
20839
20840
20841
20842
20843
20844
20845
20846
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20838

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



21068
21069
21070
21071
21072
21073
21074
21075
21076
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21068

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



21289
21290
21291
21292
21293
21294
21295
21296
21297
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21289

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



21561
21562
21563
21564
21565
21566
21567
21568
21569
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21561

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



21744
21745
21746
21747
21748
21749
21750
21751
21752
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21744

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



21964
21965
21966
21967
21968
21969
21970
21971
21972
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21964

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



22120
22121
22122
22123
22124
22125
22126
22127
22128
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22120

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



22309
22310
22311
22312
22313
22314
22315
22316
22317
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22309

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



22486
22487
22488
22489
22490
22491
22492
22493
22494
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22486

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



22671
22672
22673
22674
22675
22676
22677
22678
22679
22680
22681
22682
22683
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22671

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



2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2188

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



7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7774

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



13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13655

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

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

Import files from Google Cloud Storage or Google Drive into a RagCorpus.

Parameters:

  • parent (String)

    Required. The name of the RagCorpus resource into which to import files. Format: projects/project/locations/location/ragCorpora/rag_corpus``

  • google_cloud_aiplatform_v1_import_rag_files_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ImportRagFilesRequest) (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



17601
17602
17603
17604
17605
17606
17607
17608
17609
17610
17611
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17601

def import_project_location_rag_corpora_rag_file(parent, google_cloud_aiplatform_v1_import_rag_files_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/ragFiles:import', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ImportRagFilesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_import_rag_files_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

#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



379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'lib/google/apis/aiplatform_v1/service.rb', line 379

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



1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1103

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_cached_contents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListCachedContentsResponse

Lists cached contents in a project

Parameters:

  • parent (String)

    Required. The parent, which owns this collection of cached contents.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

  • page_token (String) (defaults to: nil)

    Optional. A page token, received from a previous ListCachedContents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListCachedContents 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



1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1241

def list_project_location_cached_contents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/cachedContents', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListCachedContentsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListCachedContentsResponse
  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_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



1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1608

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



1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1466

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



1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1979

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



1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1836

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



2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2547

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



2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2827

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



2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2684

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



3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3010

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



2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2634

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



3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3198

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



3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3409

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



3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3527

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



3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3670

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



2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2239

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



4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4072

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



3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3852

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



5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5088

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



4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4557

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



5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5706

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



5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5550

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



5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5852

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 FeatureRegistryService. ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService. 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



5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5291

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



6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6756

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



6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6861

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



6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6474

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



7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7007

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



6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6104

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



8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8487

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



8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8294

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



8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8670

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



7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7833

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



8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8853

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



7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7299

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



9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9231

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



9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9089

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



9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9777

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



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

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



10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10206

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



9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9959

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



10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10852

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



10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10578

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



11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11437

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



11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11151

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



11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11944

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



11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11696

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



12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12106

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



12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12247

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



10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10399

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



12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12502

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



12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12997

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



12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12693

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



13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13840

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



13994
13995
13996
13997
13998
13999
14000
14001
14002
14003
14004
14005
14006
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13994

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



13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13698

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



14136
14137
14138
14139
14140
14141
14142
14143
14144
14145
14146
14147
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14136

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



13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13369

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



13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13317

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



14437
14438
14439
14440
14441
14442
14443
14444
14445
14446
14447
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14437

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



14365
14366
14367
14368
14369
14370
14371
14372
14373
14374
14375
14376
14377
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14365

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



14734
14735
14736
14737
14738
14739
14740
14741
14742
14743
14744
14745
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14734

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



14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
14604
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14591

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



15706
15707
15708
15709
15710
15711
15712
15713
15714
15715
15716
15717
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15706

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



15242
15243
15244
15245
15246
15247
15248
15249
15250
15251
15252
15253
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15242

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]. *machineType supports = and !=. *acceleratorTypesupports = and !=. Some examples: * notebookRuntimeTemplate=notebookRuntimeTemplate123*displayName=" myDisplayName"*labels.myKey="myValue"*notebookRuntimeType=USER_DEFINED`

    • machineType=e2-standard-4 * acceleratorType=NVIDIA_TESLA_T4
  • 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



14983
14984
14985
14986
14987
14988
14989
14990
14991
14992
14993
14994
14995
14996
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14983

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]. * machineType supports = and !=. * acceleratorType supports = and !=. 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 * machineType=e2-standard-4 * acceleratorType=NVIDIA_TESLA_T4

  • 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



15455
15456
15457
15458
15459
15460
15461
15462
15463
15464
15465
15466
15467
15468
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15455

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



15889
15890
15891
15892
15893
15894
15895
15896
15897
15898
15899
15900
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15889

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



16285
16286
16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16285

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



16073
16074
16075
16076
16077
16078
16079
16080
16081
16082
16083
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16073

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



16757
16758
16759
16760
16761
16762
16763
16764
16765
16766
16767
16768
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16757

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



16614
16615
16616
16617
16618
16619
16620
16621
16622
16623
16624
16625
16626
16627
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16614

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_rag_corpora_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



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

def list_project_location_rag_corpora_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_rag_corpora_rag_file_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



17780
17781
17782
17783
17784
17785
17786
17787
17788
17789
17790
17791
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17780

def list_project_location_rag_corpora_rag_file_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_rag_corpora_rag_files(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListRagFilesResponse

Lists RagFiles in a RagCorpus.

Parameters:

  • parent (String)

    Required. The resource name of the RagCorpus from which to list the RagFiles. Format: projects/project/locations/location/ragCorpora/rag_corpus``

  • 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 ListRagFilesResponse.next_page_token of the previous VertexRagDataService. ListRagFiles 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



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

def list_project_location_rag_corpora_rag_files(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/ragFiles', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListRagFilesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListRagFilesResponse
  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_rag_corporas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListRagCorporaResponse

Lists RagCorpora in a Location.

Parameters:

  • parent (String)

    Required. The resource name of the Location from which to list the RagCorpora. 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 ListRagCorporaResponse.next_page_token of the previous VertexRagDataService. ListRagCorpora 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



17289
17290
17291
17292
17293
17294
17295
17296
17297
17298
17299
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17289

def list_project_location_rag_corporas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/ragCorpora', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListRagCorporaResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListRagCorporaResponse
  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_reasoning_engine_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



18204
18205
18206
18207
18208
18209
18210
18211
18212
18213
18214
18215
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18204

def list_project_location_reasoning_engine_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_reasoning_engines(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListReasoningEnginesResponse

Lists reasoning engines in a location.

Parameters:

  • parent (String)

    Required. The resource name of the Location to list the ReasoningEngines from. Format: projects/project/locations/location``

  • filter (String) (defaults to: nil)

    Optional. The standard list filter. More detail in AIP-160.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The standard list page size.

  • page_token (String) (defaults to: nil)

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



17959
17960
17961
17962
17963
17964
17965
17966
17967
17968
17969
17970
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17959

def list_project_location_reasoning_engines(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/reasoningEngines', options)
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListReasoningEnginesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListReasoningEnginesResponse
  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_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



18665
18666
18667
18668
18669
18670
18671
18672
18673
18674
18675
18676
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18665

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



18407
18408
18409
18410
18411
18412
18413
18414
18415
18416
18417
18418
18419
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18407

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



19027
19028
19029
19030
19031
19032
19033
19034
19035
19036
19037
19038
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19027

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



18850
18851
18852
18853
18854
18855
18856
18857
18858
18859
18860
18861
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18850

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



19205
19206
19207
19208
19209
19210
19211
19212
19213
19214
19215
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19205

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



19380
19381
19382
19383
19384
19385
19386
19387
19388
19389
19390
19391
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19380

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



19909
19910
19911
19912
19913
19914
19915
19916
19917
19918
19919
19920
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19909

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



19698
19699
19700
19701
19702
19703
19704
19705
19706
19707
19708
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19698

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



19663
19664
19665
19666
19667
19668
19669
19670
19671
19672
19673
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19663

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



20653
20654
20655
20656
20657
20658
20659
20660
20661
20662
20663
20664
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20653

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



21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
21115
21116
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21105

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



21336
21337
21338
21339
21340
21341
21342
21343
21344
21345
21346
21347
21348
21349
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21336

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



21598
21599
21600
21601
21602
21603
21604
21605
21606
21607
21608
21609
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21598

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



20885
20886
20887
20888
20889
20890
20891
20892
20893
20894
20895
20896
20897
20898
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20885

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



20433
20434
20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20433

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



21781
21782
21783
21784
21785
21786
21787
21788
21789
21790
21791
21792
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21781

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



20138
20139
20140
20141
20142
20143
20144
20145
20146
20147
20148
20149
20150
20151
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20138

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



22157
22158
22159
22160
22161
22162
22163
22164
22165
22166
22167
22168
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22157

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



22015
22016
22017
22018
22019
22020
22021
22022
22023
22024
22025
22026
22027
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22015

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



22523
22524
22525
22526
22527
22528
22529
22530
22531
22532
22533
22534
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22523

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



22348
22349
22350
22351
22352
22353
22354
22355
22356
22357
22358
22359
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22348

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



877
878
879
880
881
882
883
884
885
886
887
888
# File 'lib/google/apis/aiplatform_v1/service.rb', line 877

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



19240
19241
19242
19243
19244
19245
19246
19247
19248
19249
19250
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19240

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



13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13407

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



4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4598

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



9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9529

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. Format: projects/ project/locations/location/datasets/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



233
234
235
236
237
238
239
240
241
242
243
244
# File 'lib/google/apis/aiplatform_v1/service.rb', line 233

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



418
419
420
421
422
423
424
425
426
427
428
429
# File 'lib/google/apis/aiplatform_v1/service.rb', line 418

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_cached_content(name, google_cloud_aiplatform_v1_cached_content_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CachedContent

Updates cached content configurations

Parameters:

  • name (String)

    Immutable. Identifier. The server-generated resource name of the cached content Format: projects/project/locations/location/cachedContents/ cached_content

  • google_cloud_aiplatform_v1_cached_content_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CachedContent) (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



1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1278

def patch_project_location_cached_content(name, google_cloud_aiplatform_v1_cached_content_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::GoogleCloudAiplatformV1CachedContent::Representation
  command.request_object = google_cloud_aiplatform_v1_cached_content_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CachedContent::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CachedContent
  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. Format: projects/ project/locations/location/datasets/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



2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2280

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



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

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



3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3889

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



4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4634

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



5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5335

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



5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5602

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



6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6149

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



6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6522

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



7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7344

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



7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7888

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



8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8346

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



9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9997

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



9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9565

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



10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10617

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



11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11190

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



11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11735

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



13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13443

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



12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12748

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



15023
15024
15025
15026
15027
15028
15029
15030
15031
15032
15033
15034
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15023

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



16109
16110
16111
16112
16113
16114
16115
16116
16117
16118
16119
16120
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16109

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_rag_corpora(name, google_cloud_aiplatform_v1_rag_corpus_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Updates a RagCorpus.

Parameters:

  • name (String)

    Output only. The resource name of the RagCorpus.

  • google_cloud_aiplatform_v1_rag_corpus_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RagCorpus) (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



17322
17323
17324
17325
17326
17327
17328
17329
17330
17331
17332
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17322

def patch_project_location_rag_corpora(name, google_cloud_aiplatform_v1_rag_corpus_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RagCorpus::Representation
  command.request_object = google_cloud_aiplatform_v1_rag_corpus_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

#patch_project_location_reasoning_engine(name, google_cloud_aiplatform_v1_reasoning_engine_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Updates a reasoning engine.

Parameters:

  • name (String)

    Identifier. The resource name of the ReasoningEngine.

  • google_cloud_aiplatform_v1_reasoning_engine_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ReasoningEngine) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Optional. Mask specifying which 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



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

def patch_project_location_reasoning_engine(name, google_cloud_aiplatform_v1_reasoning_engine_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::GoogleCloudAiplatformV1ReasoningEngine::Representation
  command.request_object = google_cloud_aiplatform_v1_reasoning_engine_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



18449
18450
18451
18452
18453
18454
18455
18456
18457
18458
18459
18460
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18449

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



18886
18887
18888
18889
18890
18891
18892
18893
18894
18895
18896
18897
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18886

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



20181
20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20181

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



20476
20477
20478
20479
20480
20481
20482
20483
20484
20485
20486
20487
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20476

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



20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20928

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



21378
21379
21380
21381
21382
21383
21384
21385
21386
21387
21388
21389
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21378

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



12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12786

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



18486
18487
18488
18489
18490
18491
18492
18493
18494
18495
18496
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18486

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



4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4669

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



4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4704

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



16973
16974
16975
16976
16977
16978
16979
16980
16981
16982
16983
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16973

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



17008
17009
17010
17011
17012
17013
17014
17015
17016
17017
17018
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17008

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



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

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



11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11226

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



11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11771

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



3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3932

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



10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10712

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



11264
11265
11266
11267
11268
11269
11270
11271
11272
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11264

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



11806
11807
11808
11809
11810
11811
11812
11813
11814
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11806

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

#query_project_location_reasoning_engine(name, google_cloud_aiplatform_v1_query_reasoning_engine_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1QueryReasoningEngineResponse

Queries using a reasoning engine.

Parameters:

  • name (String)

    Required. The name of the ReasoningEngine resource to use. Format: projects/ project/locations/location/reasoningEngines/reasoning_engine``

  • google_cloud_aiplatform_v1_query_reasoning_engine_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1QueryReasoningEngineRequest) (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



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

def query_project_location_reasoning_engine(name, google_cloud_aiplatform_v1_query_reasoning_engine_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:query', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1QueryReasoningEngineRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_query_reasoning_engine_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1QueryReasoningEngineResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1QueryReasoningEngineResponse
  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

#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



4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4741

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



17045
17046
17047
17048
17049
17050
17051
17052
17053
17054
17055
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17045

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



7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7927

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



9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9601

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



21421
21422
21423
21424
21425
21426
21427
21428
21429
21430
21431
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21421

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



21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21459

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



20215
20216
20217
20218
20219
20220
20221
20222
20223
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20215

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



20246
20247
20248
20249
20250
20251
20252
20253
20254
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20246

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



22383
22384
22385
22386
22387
22388
22389
22390
22391
22392
22393
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22383

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



16145
16146
16147
16148
16149
16150
16151
16152
16153
16154
16155
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16145

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



10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10032

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



11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11297

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



452
453
454
455
456
457
458
459
460
# File 'lib/google/apis/aiplatform_v1/service.rb', line 452

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



3271
3272
3273
3274
3275
3276
3277
3278
3279
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3271

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



12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12822

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



18525
18526
18527
18528
18529
18530
18531
18532
18533
18534
18535
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18525

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

#retrieve_project_location_contexts(parent, google_cloud_aiplatform_v1_retrieve_contexts_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RetrieveContextsResponse

Retrieves relevant contexts for a query.

Parameters:

  • parent (String)

    Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: projects/project/locations/location``.

  • google_cloud_aiplatform_v1_retrieve_contexts_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RetrieveContextsRequest) (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



913
914
915
916
917
918
919
920
921
922
923
# File 'lib/google/apis/aiplatform_v1/service.rb', line 913

def retrieve_project_location_contexts(parent, google_cloud_aiplatform_v1_retrieve_contexts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}:retrieveContexts', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RetrieveContextsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_retrieve_contexts_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RetrieveContextsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1RetrieveContextsResponse
  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_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



2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2362

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



6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6559

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



7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7420

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



12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12362

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



12857
12858
12859
12860
12861
12862
12863
12864
12865
12866
12867
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12857

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



4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4776

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



17080
17081
17082
17083
17084
17085
17086
17087
17088
17089
17090
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17080

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



6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6596

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



6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6187

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



7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7964

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



7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7458

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



13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13481

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



15061
15062
15063
15064
15065
15066
15067
15068
15069
15070
15071
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15061

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



15494
15495
15496
15497
15498
15499
15500
15501
15502
15503
15504
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15494

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



15530
15531
15532
15533
15534
15535
15536
15537
15538
15539
15540
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15530

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



19732
19733
19734
19735
19736
19737
19738
19739
19740
19741
19742
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19732

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



590
591
592
593
594
595
596
597
598
599
600
# File 'lib/google/apis/aiplatform_v1/service.rb', line 590

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



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

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



4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4846

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



17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17116

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



17150
17151
17152
17153
17154
17155
17156
17157
17158
17159
17160
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17150

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_project_location_reasoning_engine_query(name, google_cloud_aiplatform_v1_stream_query_reasoning_engine_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleApiHttpBody

Streams queries using a reasoning engine.

Parameters:

  • name (String)

    Required. The name of the ReasoningEngine resource to use. Format: projects/ project/locations/location/reasoningEngines/reasoning_engine``

  • google_cloud_aiplatform_v1_stream_query_reasoning_engine_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest) (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



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

def stream_project_location_reasoning_engine_query(name, google_cloud_aiplatform_v1_stream_query_reasoning_engine_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:streamQuery', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_stream_query_reasoning_engine_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleApiHttpBody
  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_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



22709
22710
22711
22712
22713
22714
22715
22716
22717
22718
22719
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22709

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



8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8001

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



19769
19770
19771
19772
19773
19774
19775
19776
19777
19778
19779
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19769

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



6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6630

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



6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6672

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



6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6229

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



8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8043

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



7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7500

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



13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13523

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



15103
15104
15105
15106
15107
15108
15109
15110
15111
15112
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15103

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



4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4881

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



9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9637

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



698
699
700
701
702
703
704
705
706
707
708
# File 'lib/google/apis/aiplatform_v1/service.rb', line 698

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_endpoint(name, google_cloud_aiplatform_v1_update_endpoint_long_running_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleLongrunningOperation

Updates an Endpoint with a long running operation.

Parameters:

  • name (String)

    Output only. The resource name of the Endpoint.

  • google_cloud_aiplatform_v1_update_endpoint_long_running_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest) (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



4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4914

def update_project_location_endpoint(name, google_cloud_aiplatform_v1_update_endpoint_long_running_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:update', options)
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_update_endpoint_long_running_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

#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



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

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



15566
15567
15568
15569
15570
15571
15572
15573
15574
15575
15576
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15566

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_medium(parent, google_cloud_aiplatform_v1_upload_rag_file_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UploadRagFileResponse

Upload a file into a RagCorpus.

Parameters:

  • parent (String)

    Required. The name of the RagCorpus resource into which to upload the file. Format: projects/project/locations/location/ragCorpora/rag_corpus``

  • google_cloud_aiplatform_v1_upload_rag_file_request_object (Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UploadRagFileRequest) (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.

  • upload_source (IO, String) (defaults to: nil)

    IO stream or filename containing content to upload

  • content_type (String) (defaults to: nil)

    Content type of the uploaded content.

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
# File 'lib/google/apis/aiplatform_v1/service.rb', line 628

def upload_medium(parent, google_cloud_aiplatform_v1_upload_rag_file_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'v1/{+parent}/ragFiles:upload', options)
  else
    command = make_upload_command(:post, 'v1/{+parent}/ragFiles:upload', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UploadRagFileRequest::Representation
  command.request_object = google_cloud_aiplatform_v1_upload_rag_file_request_object
  command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UploadRagFileResponse::Representation
  command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UploadRagFileResponse
  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

#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



13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13590

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



10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10066

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



1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
# File 'lib/google/apis/aiplatform_v1/service.rb', line 1652

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



2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2023

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



2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2591

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



2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
# File 'lib/google/apis/aiplatform_v1/service.rb', line 2871

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



3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3054

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



3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3453

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



3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
# File 'lib/google/apis/aiplatform_v1/service.rb', line 3714

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



4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
# File 'lib/google/apis/aiplatform_v1/service.rb', line 4116

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



5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5132

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



5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5750

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



5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
# File 'lib/google/apis/aiplatform_v1/service.rb', line 5896

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



6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
# File 'lib/google/apis/aiplatform_v1/service.rb', line 6905

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



7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
# File 'lib/google/apis/aiplatform_v1/service.rb', line 7051

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



8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8531

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



8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8714

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



8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8897

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



9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9275

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



9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
# File 'lib/google/apis/aiplatform_v1/service.rb', line 9821

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



10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10250

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



10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
# File 'lib/google/apis/aiplatform_v1/service.rb', line 10896

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



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

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



11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
# File 'lib/google/apis/aiplatform_v1/service.rb', line 11988

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



12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12291

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



12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
# File 'lib/google/apis/aiplatform_v1/service.rb', line 12546

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



13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13041

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



13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
# File 'lib/google/apis/aiplatform_v1/service.rb', line 13884

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



14180
14181
14182
14183
14184
14185
14186
14187
14188
14189
# File 'lib/google/apis/aiplatform_v1/service.rb', line 14180

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



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

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



15750
15751
15752
15753
15754
15755
15756
15757
15758
15759
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15750

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



15286
15287
15288
15289
15290
15291
15292
15293
15294
15295
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15286

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



15933
15934
15935
15936
15937
15938
15939
15940
15941
15942
# File 'lib/google/apis/aiplatform_v1/service.rb', line 15933

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



16329
16330
16331
16332
16333
16334
16335
16336
16337
16338
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16329

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



16801
16802
16803
16804
16805
16806
16807
16808
16809
16810
# File 'lib/google/apis/aiplatform_v1/service.rb', line 16801

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_rag_corpora_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



17506
17507
17508
17509
17510
17511
17512
17513
17514
17515
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17506

def wait_project_location_rag_corpora_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_rag_corpora_rag_file_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



17824
17825
17826
17827
17828
17829
17830
17831
17832
17833
# File 'lib/google/apis/aiplatform_v1/service.rb', line 17824

def wait_project_location_rag_corpora_rag_file_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_reasoning_engine_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



18248
18249
18250
18251
18252
18253
18254
18255
18256
18257
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18248

def wait_project_location_reasoning_engine_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



18709
18710
18711
18712
18713
18714
18715
18716
18717
18718
# File 'lib/google/apis/aiplatform_v1/service.rb', line 18709

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



19071
19072
19073
19074
19075
19076
19077
19078
19079
19080
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19071

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



19424
19425
19426
19427
19428
19429
19430
19431
19432
19433
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19424

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



19953
19954
19955
19956
19957
19958
19959
19960
19961
19962
# File 'lib/google/apis/aiplatform_v1/service.rb', line 19953

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



20697
20698
20699
20700
20701
20702
20703
20704
20705
20706
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20697

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



21149
21150
21151
21152
21153
21154
21155
21156
21157
21158
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21149

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



21642
21643
21644
21645
21646
21647
21648
21649
21650
21651
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21642

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



21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
# File 'lib/google/apis/aiplatform_v1/service.rb', line 21825

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



22201
22202
22203
22204
22205
22206
22207
22208
22209
22210
# File 'lib/google/apis/aiplatform_v1/service.rb', line 22201

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



8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
# File 'lib/google/apis/aiplatform_v1/service.rb', line 8080

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



20513
20514
20515
20516
20517
20518
20519
20520
20521
20522
20523
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20513

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



20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
# File 'lib/google/apis/aiplatform_v1/service.rb', line 20965

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