Class: Google::Apis::AiplatformV1beta1::AiplatformService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/aiplatform_v1beta1/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_v1beta1'

Aiplatform = Google::Apis::AiplatformV1beta1 # 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_v1beta1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-aiplatform_v1beta1',
        client_version: Google::Apis::AiplatformV1beta1::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_v1beta1/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_v1beta1/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_v1beta1_add_context_artifacts_and_executions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsResponse

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_v1beta1_add_context_artifacts_and_executions_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11755

def (context, google_cloud_aiplatform_v1beta1_add_context_artifacts_and_executions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+context}:addContextArtifactsAndExecutions', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_add_context_artifacts_and_executions_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsResponse
  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_v1beta1_add_context_children_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AddContextChildrenResponse

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_v1beta1_add_context_children_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AddContextChildrenRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11792

def (context, google_cloud_aiplatform_v1beta1_add_context_children_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+context}:addContextChildren', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AddContextChildrenRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_add_context_children_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AddContextChildrenResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AddContextChildrenResponse
  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_v1beta1_add_execution_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AddExecutionEventsResponse

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_v1beta1_add_execution_events_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AddExecutionEventsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12341

def (execution, google_cloud_aiplatform_v1beta1_add_execution_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+execution}:addExecutionEvents', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AddExecutionEventsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_add_execution_events_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AddExecutionEventsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AddExecutionEventsResponse
  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_v1beta1_add_trial_measurement_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial

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_v1beta1_add_trial_measurement_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AddTrialMeasurementRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20975

def add_project_location_study_trial_trial_measurement(trial_name, google_cloud_aiplatform_v1beta1_add_trial_measurement_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+trialName}:addTrialMeasurement', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AddTrialMeasurementRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_add_trial_measurement_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial
  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_v1beta1_assign_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_assign_notebook_runtime_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16795
16796
16797
16798
16799
16800
16801
16802
16803
16804
16805
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16795

def assign_project_location_notebook_runtime(parent, google_cloud_aiplatform_v1beta1_assign_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/notebookRuntimes:assign', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_assign_notebook_runtime_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_batch_create_features_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation

Creates a batch of Features in a given EntityType.

Parameters:

  • parent (String)

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

  • google_cloud_aiplatform_v1beta1_batch_create_features_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8941

def batch_project_location_featurestore_entity_type_feature_create(parent, google_cloud_aiplatform_v1beta1_batch_create_features_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/features:batchCreate', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_batch_create_features_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_batch_read_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_batch_read_feature_values_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def batch_project_location_featurestore_read_feature_values(featurestore, google_cloud_aiplatform_v1beta1_batch_read_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+featurestore}:batchReadFeatureValues', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_batch_read_feature_values_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_batch_migrate_resources_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_batch_migrate_resources_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchMigrateResourcesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13149

def batch_project_location_migratable_resource_migrate(parent, google_cloud_aiplatform_v1beta1_batch_migrate_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/migratableResources:batchMigrate', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchMigrateResourcesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_batch_migrate_resources_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_batch_import_evaluated_annotations_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsResponse

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_v1beta1_batch_import_evaluated_annotations_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15323
15324
15325
15326
15327
15328
15329
15330
15331
15332
15333
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15323

def batch_project_location_model_evaluation_slice_import(parent, google_cloud_aiplatform_v1beta1_batch_import_evaluated_annotations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}:batchImport', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_batch_import_evaluated_annotations_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsResponse
  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_v1beta1_batch_cancel_pipeline_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_batch_cancel_pipeline_jobs_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchCancelPipelineJobsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17875
17876
17877
17878
17879
17880
17881
17882
17883
17884
17885
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17875

def batch_project_location_pipeline_job_cancel(parent, google_cloud_aiplatform_v1beta1_batch_cancel_pipeline_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/pipelineJobs:batchCancel', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchCancelPipelineJobsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_batch_cancel_pipeline_jobs_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_batch_delete_pipeline_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_batch_delete_pipeline_jobs_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17910
17911
17912
17913
17914
17915
17916
17917
17918
17919
17920
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17910

def batch_project_location_pipeline_job_delete(parent, google_cloud_aiplatform_v1beta1_batch_delete_pipeline_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/pipelineJobs:batchDelete', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_batch_delete_pipeline_jobs_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_batch_create_tensorboard_time_series_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesResponse

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_v1beta1_batch_create_tensorboard_time_series_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



21798
21799
21800
21801
21802
21803
21804
21805
21806
21807
21808
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21798

def batch_project_location_tensorboard_experiment_create(parent, google_cloud_aiplatform_v1beta1_batch_create_tensorboard_time_series_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}:batchCreate', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_batch_create_tensorboard_time_series_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesResponse
  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_v1beta1_batch_create_tensorboard_runs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsResponse

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_v1beta1_batch_create_tensorboard_runs_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



22249
22250
22251
22252
22253
22254
22255
22256
22257
22258
22259
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22249

def batch_project_location_tensorboard_experiment_run_create(parent, google_cloud_aiplatform_v1beta1_batch_create_tensorboard_runs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/runs:batchCreate', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_batch_create_tensorboard_runs_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchReadTensorboardTimeSeriesDataResponse

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



21512
21513
21514
21515
21516
21517
21518
21519
21520
21521
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21512

def batch_project_location_tensorboard_read(tensorboard, time_series: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+tensorboard}:batchRead', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchReadTensorboardTimeSeriesDataResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchReadTensorboardTimeSeriesDataResponse
  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_agent_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



332
333
334
335
336
337
338
339
340
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 332

def cancel_project_location_agent_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_app_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



515
516
517
518
519
520
521
522
523
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 515

def cancel_project_location_app_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_batch_prediction_job(name, google_cloud_aiplatform_v1beta1_cancel_batch_prediction_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_cancel_batch_prediction_job_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def cancel_project_location_batch_prediction_job(name, google_cloud_aiplatform_v1beta1_cancel_batch_prediction_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_cancel_batch_prediction_job_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_cancel_custom_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_cancel_custom_job_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CancelCustomJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1065

def cancel_project_location_custom_job(name, google_cloud_aiplatform_v1beta1_cancel_custom_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CancelCustomJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_cancel_custom_job_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



1253
1254
1255
1256
1257
1258
1259
1260
1261
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1253

def cancel_project_location_custom_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_cancel_data_labeling_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_cancel_data_labeling_job_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CancelDataLabelingJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1431

def cancel_project_location_data_labeling_job(name, google_cloud_aiplatform_v1beta1_cancel_data_labeling_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CancelDataLabelingJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_cancel_data_labeling_job_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



1624
1625
1626
1627
1628
1629
1630
1631
1632
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1624

def cancel_project_location_data_labeling_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



2191
2192
2193
2194
2195
2196
2197
2198
2199
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2191

def cancel_project_location_dataset_annotation_spec_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



2469
2470
2471
2472
2473
2474
2475
2476
2477
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2469

def cancel_project_location_dataset_data_item_annotation_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



2652
2653
2654
2655
2656
2657
2658
2659
2660
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2652

def cancel_project_location_dataset_data_item_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



3051
3052
3053
3054
3055
3056
3057
3058
3059
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3051

def cancel_project_location_dataset_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



3312
3313
3314
3315
3316
3317
3318
3319
3320
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3312

def cancel_project_location_dataset_saved_query_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



3676
3677
3678
3679
3680
3681
3682
3683
3684
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3676

def cancel_project_location_deployment_resource_pool_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_edge_device_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



3859
3860
3861
3862
3863
3864
3865
3866
3867
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3859

def cancel_project_location_edge_device_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



4886
4887
4888
4889
4890
4891
4892
4893
4894
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 4886

def cancel_project_location_endpoint_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_example_store_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5215
5216
5217
5218
5219
5220
5221
5222
5223
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5215

def cancel_project_location_example_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_extension_controller_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5398
5399
5400
5401
5402
5403
5404
5405
5406
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5398

def cancel_project_location_extension_controller_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_extension_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5831
5832
5833
5834
5835
5836
5837
5838
5839
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5831

def cancel_project_location_extension_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



9210
9211
9212
9213
9214
9215
9216
9217
9218
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9210

def cancel_project_location_featurestore_entity_type_feature_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



9393
9394
9395
9396
9397
9398
9399
9400
9401
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9393

def cancel_project_location_featurestore_entity_type_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



9576
9577
9578
9579
9580
9581
9582
9583
9584
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9576

def cancel_project_location_featurestore_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_cancel_hyperparameter_tuning_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_cancel_hyperparameter_tuning_job_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CancelHyperparameterTuningJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9763

def cancel_project_location_hyperparameter_tuning_job(name, google_cloud_aiplatform_v1beta1_cancel_hyperparameter_tuning_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CancelHyperparameterTuningJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_cancel_hyperparameter_tuning_job_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



9954
9955
9956
9957
9958
9959
9960
9961
9962
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9954

def cancel_project_location_hyperparameter_tuning_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



10500
10501
10502
10503
10504
10505
10506
10507
10508
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10500

def cancel_project_location_index_endpoint_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



10929
10930
10931
10932
10933
10934
10935
10936
10937
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10929

def cancel_project_location_index_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



11575
11576
11577
11578
11579
11580
11581
11582
11583
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11575

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



12160
12161
12162
12163
12164
12165
12166
12167
12168
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12160

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



12667
12668
12669
12670
12671
12672
12673
12674
12675
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12667

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



12970
12971
12972
12973
12974
12975
12976
12977
12978
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12970

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



13225
13226
13227
13228
13229
13230
13231
13232
13233
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13225

def cancel_project_location_migratable_resource_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



13720
13721
13722
13723
13724
13725
13726
13727
13728
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13720

def cancel_project_location_model_deployment_monitoring_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



15144
15145
15146
15147
15148
15149
15150
15151
15152
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15144

def cancel_project_location_model_evaluation_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_monitor_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



14306
14307
14308
14309
14310
14311
14312
14313
14314
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14306

def cancel_project_location_model_monitor_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



15440
15441
15442
15443
15444
15445
15446
15447
15448
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15440

def cancel_project_location_model_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_cancel_nas_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_cancel_nas_job_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CancelNasJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15624
15625
15626
15627
15628
15629
15630
15631
15632
15633
15634
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15624

def cancel_project_location_nas_job(name, google_cloud_aiplatform_v1beta1_cancel_nas_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CancelNasJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_cancel_nas_job_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



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

def cancel_project_location_notebook_execution_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



17114
17115
17116
17117
17118
17119
17120
17121
17122
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17114

def cancel_project_location_notebook_runtime_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



16616
16617
16618
16619
16620
16621
16622
16623
16624
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16616

def cancel_project_location_notebook_runtime_template_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



17297
17298
17299
17300
17301
17302
17303
17304
17305
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17297

def cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



17693
17694
17695
17696
17697
17698
17699
17700
17701
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17693

def cancel_project_location_persistent_resource_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_cancel_pipeline_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_cancel_pipeline_job_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CancelPipelineJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17951
17952
17953
17954
17955
17956
17957
17958
17959
17960
17961
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17951

def cancel_project_location_pipeline_job(name, google_cloud_aiplatform_v1beta1_cancel_pipeline_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CancelPipelineJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_cancel_pipeline_job_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



18165
18166
18167
18168
18169
18170
18171
18172
18173
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18165

def cancel_project_location_pipeline_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



18808
18809
18810
18811
18812
18813
18814
18815
18816
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18808

def cancel_project_location_rag_corpora_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



19126
19127
19128
19129
19130
19131
19132
19133
19134
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19126

def cancel_project_location_rag_corpora_rag_file_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



19516
19517
19518
19519
19520
19521
19522
19523
19524
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19516

def cancel_project_location_reasoning_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



19977
19978
19979
19980
19981
19982
19983
19984
19985
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19977

def cancel_project_location_schedule_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



20443
20444
20445
20446
20447
20448
20449
20450
20451
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20443

def cancel_project_location_specialist_pool_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



20796
20797
20798
20799
20800
20801
20802
20803
20804
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20796

def cancel_project_location_study_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



21325
21326
21327
21328
21329
21330
21331
21332
21333
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21325

def cancel_project_location_study_trial_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



22069
22070
22071
22072
22073
22074
22075
22076
22077
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22069

def cancel_project_location_tensorboard_experiment_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



22521
22522
22523
22524
22525
22526
22527
22528
22529
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22521

def cancel_project_location_tensorboard_experiment_run_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



23014
23015
23016
23017
23018
23019
23020
23021
23022
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23014

def cancel_project_location_tensorboard_experiment_run_time_series_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



23197
23198
23199
23200
23201
23202
23203
23204
23205
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23197

def cancel_project_location_tensorboard_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_cancel_training_pipeline_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_cancel_training_pipeline_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



23382
23383
23384
23385
23386
23387
23388
23389
23390
23391
23392
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23382

def cancel_project_location_training_pipeline(name, google_cloud_aiplatform_v1beta1_cancel_training_pipeline_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_cancel_training_pipeline_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



23573
23574
23575
23576
23577
23578
23579
23580
23581
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23573

def cancel_project_location_training_pipeline_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_cancel_tuning_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_cancel_tuning_job_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CancelTuningJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



23758
23759
23760
23761
23762
23763
23764
23765
23766
23767
23768
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23758

def cancel_project_location_tuning_job(name, google_cloud_aiplatform_v1beta1_cancel_tuning_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:cancel', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CancelTuningJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_cancel_tuning_job_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_check_trial_early_stopping_state_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_check_trial_early_stopping_state_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21011

def check_project_location_study_trial_trial_early_stopping_state(trial_name, google_cloud_aiplatform_v1beta1_check_trial_early_stopping_state_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+trialName}:checkTrialEarlyStoppingState', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_check_trial_early_stopping_state_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_complete_trial_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial

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_v1beta1_complete_trial_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CompleteTrialRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21045

def complete_project_location_study_trial(name, google_cloud_aiplatform_v1beta1_complete_trial_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:complete', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CompleteTrialRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_complete_trial_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial
  command.params['name'] = name unless name.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::AiplatformV1beta1::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/openapi

  • google_api_http_body_object (Google::Apis::AiplatformV1beta1::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



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

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, 'v1beta1/{+endpoint}/chat/completions', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleApiHttpBody::Representation
  command.request_object = google_api_http_body_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_project_location_endpoint_tokens(endpoint, google_cloud_aiplatform_v1beta1_compute_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ComputeTokensResponse

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_v1beta1_compute_tokens_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ComputeTokensRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 4037

def compute_project_location_endpoint_tokens(endpoint, google_cloud_aiplatform_v1beta1_compute_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:computeTokens', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ComputeTokensRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_compute_tokens_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ComputeTokensResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ComputeTokensResponse
  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_v1beta1_compute_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ComputeTokensResponse

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_v1beta1_compute_tokens_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ComputeTokensRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def compute_project_location_publisher_model_tokens(endpoint, google_cloud_aiplatform_v1beta1_compute_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:computeTokens', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ComputeTokensRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_compute_tokens_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ComputeTokensResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ComputeTokensResponse
  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_v1beta1_copy_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_copy_model_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CopyModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14488
14489
14490
14491
14492
14493
14494
14495
14496
14497
14498
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14488

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

#count_project_location_endpoint_tokens(endpoint, google_cloud_aiplatform_v1beta1_count_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CountTokensResponse

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_v1beta1_count_tokens_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CountTokensRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def count_project_location_endpoint_tokens(endpoint, google_cloud_aiplatform_v1beta1_count_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:countTokens', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CountTokensRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_count_tokens_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CountTokensResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CountTokensResponse
  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_v1beta1_count_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CountTokensResponse

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_v1beta1_count_tokens_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CountTokensRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18377
18378
18379
18380
18381
18382
18383
18384
18385
18386
18387
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18377

def count_project_location_publisher_model_tokens(endpoint, google_cloud_aiplatform_v1beta1_count_tokens_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:countTokens', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CountTokensRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_count_tokens_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CountTokensResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CountTokensResponse
  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_project_location_batch_prediction_job(parent, google_cloud_aiplatform_v1beta1_batch_prediction_job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchPredictionJob

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_v1beta1_batch_prediction_job_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchPredictionJob) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the 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_v1beta1/service.rb', line 734

def create_project_location_batch_prediction_job(parent, google_cloud_aiplatform_v1beta1_batch_prediction_job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/batchPredictionJobs', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchPredictionJob::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_batch_prediction_job_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchPredictionJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchPredictionJob
  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_v1beta1_cached_content_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CachedContent

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_v1beta1_cached_content_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CachedContent) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



885
886
887
888
889
890
891
892
893
894
895
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 885

def create_project_location_cached_content(parent, google_cloud_aiplatform_v1beta1_cached_content_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/cachedContents', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CachedContent::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_cached_content_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CachedContent::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CachedContent
  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_v1beta1_custom_job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomJob

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_v1beta1_custom_job_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomJob) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1100

def create_project_location_custom_job(parent, google_cloud_aiplatform_v1beta1_custom_job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/customJobs', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomJob::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_custom_job_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomJob
  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_v1beta1_data_labeling_job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DataLabelingJob

Creates a DataLabelingJob.

Parameters:

  • parent (String)

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

  • google_cloud_aiplatform_v1beta1_data_labeling_job_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DataLabelingJob) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1465

def create_project_location_data_labeling_job(parent, google_cloud_aiplatform_v1beta1_data_labeling_job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/dataLabelingJobs', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DataLabelingJob::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_data_labeling_job_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DataLabelingJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DataLabelingJob
  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_v1beta1_dataset_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_dataset_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Dataset) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1802

def create_project_location_dataset(parent, google_cloud_aiplatform_v1beta1_dataset_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/datasets', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Dataset::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_dataset_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_dataset_version_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_dataset_version_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DatasetVersion) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2830

def create_project_location_dataset_dataset_version(parent, google_cloud_aiplatform_v1beta1_dataset_version_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/datasetVersions', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DatasetVersion::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_dataset_version_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_create_deployment_resource_pool_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_create_deployment_resource_pool_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CreateDeploymentResourcePoolRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3490

def create_project_location_deployment_resource_pool(parent, google_cloud_aiplatform_v1beta1_create_deployment_resource_pool_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/deploymentResourcePools', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CreateDeploymentResourcePoolRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_create_deployment_resource_pool_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_endpoint_object = nil, endpoint_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_endpoint_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Endpoint) (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



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

def create_project_location_endpoint(parent, google_cloud_aiplatform_v1beta1_endpoint_object = nil, endpoint_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/endpoints', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Endpoint::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_endpoint_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_feature_group_object = nil, feature_group_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_feature_group_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureGroup) (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 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



6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6014

def create_project_location_feature_group(parent, google_cloud_aiplatform_v1beta1_feature_group_object = nil, feature_group_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/featureGroups', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureGroup::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_feature_group_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_feature_object = nil, feature_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_feature_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Feature) (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



6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6221

def create_project_location_feature_group_feature(parent, google_cloud_aiplatform_v1beta1_feature_object = nil, feature_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/features', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Feature::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_feature_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_feature_online_store_object = nil, feature_online_store_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_feature_online_store_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureOnlineStore) (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



6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6740

def create_project_location_feature_online_store(parent, google_cloud_aiplatform_v1beta1_feature_online_store_object = nil, feature_online_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/featureOnlineStores', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureOnlineStore::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_feature_online_store_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_feature_view_object = nil, feature_view_id: nil, run_sync_immediately: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_feature_view_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureView) (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



7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7076

def create_project_location_feature_online_store_feature_view(parent, google_cloud_aiplatform_v1beta1_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, 'v1beta1/{+parent}/featureViews', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureView::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_feature_view_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_featurestore_object = nil, featurestore_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_featurestore_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Featurestore) (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



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

def create_project_location_featurestore(parent, google_cloud_aiplatform_v1beta1_featurestore_object = nil, featurestore_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/featurestores', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Featurestore::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_featurestore_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_entity_type_object = nil, entity_type_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_entity_type_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EntityType) (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



8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8364

def create_project_location_featurestore_entity_type(parent, google_cloud_aiplatform_v1beta1_entity_type_object = nil, entity_type_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/entityTypes', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EntityType::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_entity_type_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_feature_object = nil, feature_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_feature_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Feature) (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



8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8983

def create_project_location_featurestore_entity_type_feature(parent, google_cloud_aiplatform_v1beta1_feature_object = nil, feature_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/features', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Feature::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_feature_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_hyperparameter_tuning_job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1HyperparameterTuningJob

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_v1beta1_hyperparameter_tuning_job_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1HyperparameterTuningJob) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9797

def create_project_location_hyperparameter_tuning_job(parent, google_cloud_aiplatform_v1beta1_hyperparameter_tuning_job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/hyperparameterTuningJobs', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1HyperparameterTuningJob::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_hyperparameter_tuning_job_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1HyperparameterTuningJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1HyperparameterTuningJob
  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_v1beta1_index_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_index_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Index) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10678

def create_project_location_index(parent, google_cloud_aiplatform_v1beta1_index_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/indexes', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Index::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_index_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_index_endpoint_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_index_endpoint_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1IndexEndpoint) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10132

def create_project_location_index_endpoint(parent, google_cloud_aiplatform_v1beta1_index_endpoint_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/indexEndpoints', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1IndexEndpoint::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_index_endpoint_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_metadata_store_object = nil, metadata_store_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_metadata_store_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MetadataStore) (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



11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11115

def (parent,  = nil, metadata_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/metadataStores', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MetadataStore::Representation
  command.request_object = 
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_artifact_object = nil, artifact_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Artifact

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_v1beta1_artifact_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Artifact) (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



11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11266

def (parent, google_cloud_aiplatform_v1beta1_artifact_object = nil, artifact_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/artifacts', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Artifact::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_artifact_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Artifact::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Artifact
  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_v1beta1_context_object = nil, context_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Context

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_v1beta1_context_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Context) (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



11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11835

def (parent, google_cloud_aiplatform_v1beta1_context_object = nil, context_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/contexts', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Context::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_context_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Context::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Context
  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_v1beta1_execution_object = nil, execution_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Execution

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_v1beta1_execution_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Execution) (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



12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12384

def (parent, google_cloud_aiplatform_v1beta1_execution_object = nil, execution_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/executions', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Execution::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_execution_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Execution::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Execution
  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_v1beta1_metadata_schema_object = nil, metadata_schema_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MetadataSchema

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_v1beta1_metadata_schema_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MetadataSchema) (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



12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
12864
12865
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12854

def (parent,  = nil, metadata_schema_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/metadataSchemas', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MetadataSchema::Representation
  command.request_object = 
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MetadataSchema::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MetadataSchema
  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_v1beta1_model_deployment_monitoring_job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob

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_v1beta1_model_deployment_monitoring_job_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13404

def create_project_location_model_deployment_monitoring_job(parent, google_cloud_aiplatform_v1beta1_model_deployment_monitoring_job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/modelDeploymentMonitoringJobs', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_model_deployment_monitoring_job_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob
  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_model_monitor(parent, google_cloud_aiplatform_v1beta1_model_monitor_object = nil, model_monitor_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation

Creates a ModelMonitor.

Parameters:

  • parent (String)

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

  • google_cloud_aiplatform_v1beta1_model_monitor_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitor) (defaults to: nil)
  • model_monitor_id (String) (defaults to: nil)

    Optional. The ID to use for the Model Monitor, which will become the final component of the model monitor 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



13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13902

def create_project_location_model_monitor(parent, google_cloud_aiplatform_v1beta1_model_monitor_object = nil, model_monitor_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/modelMonitors', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitor::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_model_monitor_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation
  command.params['parent'] = parent unless parent.nil?
  command.query['modelMonitorId'] = model_monitor_id unless model_monitor_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_model_monitor_model_monitoring_job(parent, google_cloud_aiplatform_v1beta1_model_monitoring_job_object = nil, model_monitoring_job_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitoringJob

Creates a ModelMonitoringJob.

Parameters:

  • parent (String)

    Required. The parent of the ModelMonitoringJob. Format: projects/project/ locations/location/modelMoniitors/model_monitor``

  • google_cloud_aiplatform_v1beta1_model_monitoring_job_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitoringJob) (defaults to: nil)
  • model_monitoring_job_id (String) (defaults to: nil)

    Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job 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



14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
14165
14166
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14155

def create_project_location_model_monitor_model_monitoring_job(parent, google_cloud_aiplatform_v1beta1_model_monitoring_job_object = nil, model_monitoring_job_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/modelMonitoringJobs', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitoringJob::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_model_monitoring_job_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitoringJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitoringJob
  command.params['parent'] = parent unless parent.nil?
  command.query['modelMonitoringJobId'] = model_monitoring_job_id unless model_monitoring_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_nas_job(parent, google_cloud_aiplatform_v1beta1_nas_job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NasJob

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_v1beta1_nas_job_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NasJob) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15658
15659
15660
15661
15662
15663
15664
15665
15666
15667
15668
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15658

def create_project_location_nas_job(parent, google_cloud_aiplatform_v1beta1_nas_job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/nasJobs', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NasJob::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_nas_job_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NasJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NasJob
  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_v1beta1_notebook_execution_job_object = nil, notebook_execution_job_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_notebook_execution_job_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookExecutionJob) (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



15878
15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15878

def create_project_location_notebook_execution_job(parent, google_cloud_aiplatform_v1beta1_notebook_execution_job_object = nil, notebook_execution_job_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/notebookExecutionJobs', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookExecutionJob::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_notebook_execution_job_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_notebook_runtime_template_object = nil, notebook_runtime_template_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_notebook_runtime_template_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate) (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



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

def create_project_location_notebook_runtime_template(parent, google_cloud_aiplatform_v1beta1_notebook_runtime_template_object = nil, notebook_runtime_template_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/notebookRuntimeTemplates', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_notebook_runtime_template_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_persistent_resource_object = nil, persistent_resource_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_persistent_resource_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PersistentResource) (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



17479
17480
17481
17482
17483
17484
17485
17486
17487
17488
17489
17490
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17479

def create_project_location_persistent_resource(parent, google_cloud_aiplatform_v1beta1_persistent_resource_object = nil, persistent_resource_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/persistentResources', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PersistentResource::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_persistent_resource_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_pipeline_job_object = nil, pipeline_job_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PipelineJob

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_v1beta1_pipeline_job_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PipelineJob) (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



17990
17991
17992
17993
17994
17995
17996
17997
17998
17999
18000
18001
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17990

def create_project_location_pipeline_job(parent, google_cloud_aiplatform_v1beta1_pipeline_job_object = nil, pipeline_job_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/pipelineJobs', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PipelineJob::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_pipeline_job_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PipelineJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PipelineJob
  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_v1beta1_rag_corpus_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_rag_corpus_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagCorpus) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def create_project_location_rag_corpora(parent, google_cloud_aiplatform_v1beta1_rag_corpus_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/ragCorpora', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagCorpus::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_rag_corpus_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_reasoning_engine_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_reasoning_engine_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngine) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19304
19305
19306
19307
19308
19309
19310
19311
19312
19313
19314
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19304

def create_project_location_reasoning_engine(parent, google_cloud_aiplatform_v1beta1_reasoning_engine_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/reasoningEngines', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngine::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_reasoning_engine_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_schedule_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schedule

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_v1beta1_schedule_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schedule) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19694
19695
19696
19697
19698
19699
19700
19701
19702
19703
19704
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19694

def create_project_location_schedule(parent, google_cloud_aiplatform_v1beta1_schedule_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/schedules', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schedule::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_schedule_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schedule::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schedule
  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_v1beta1_specialist_pool_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_specialist_pool_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SpecialistPool) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20259
20260
20261
20262
20263
20264
20265
20266
20267
20268
20269
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20259

def create_project_location_specialist_pool(parent, google_cloud_aiplatform_v1beta1_specialist_pool_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/specialistPools', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SpecialistPool::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_specialist_pool_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_study_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Study

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_v1beta1_study_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Study) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20621
20622
20623
20624
20625
20626
20627
20628
20629
20630
20631
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20621

def create_project_location_study(parent, google_cloud_aiplatform_v1beta1_study_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/studies', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Study::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_study_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Study::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Study
  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_v1beta1_trial_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial

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_v1beta1_trial_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



21079
21080
21081
21082
21083
21084
21085
21086
21087
21088
21089
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21079

def create_project_location_study_trial(parent, google_cloud_aiplatform_v1beta1_trial_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/trials', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_trial_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial
  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_v1beta1_tensorboard_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_tensorboard_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Tensorboard) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



21545
21546
21547
21548
21549
21550
21551
21552
21553
21554
21555
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21545

def create_project_location_tensorboard(parent, google_cloud_aiplatform_v1beta1_tensorboard_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/tensorboards', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Tensorboard::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_tensorboard_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_tensorboard_experiment_object = nil, tensorboard_experiment_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardExperiment

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_v1beta1_tensorboard_experiment_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardExperiment) (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



21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21837

def create_project_location_tensorboard_experiment(parent, google_cloud_aiplatform_v1beta1_tensorboard_experiment_object = nil, tensorboard_experiment_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/experiments', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardExperiment::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_tensorboard_experiment_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardExperiment::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardExperiment
  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_v1beta1_tensorboard_run_object = nil, tensorboard_run_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardRun

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_v1beta1_tensorboard_run_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardRun) (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



22288
22289
22290
22291
22292
22293
22294
22295
22296
22297
22298
22299
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22288

def create_project_location_tensorboard_experiment_run(parent, google_cloud_aiplatform_v1beta1_tensorboard_run_object = nil, tensorboard_run_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/runs', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardRun::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_tensorboard_run_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardRun::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardRun
  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_v1beta1_tensorboard_time_series_object = nil, tensorboard_time_series_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardTimeSeries

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_v1beta1_tensorboard_time_series_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardTimeSeries) (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



22704
22705
22706
22707
22708
22709
22710
22711
22712
22713
22714
22715
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22704

def create_project_location_tensorboard_experiment_run_time_series(parent, google_cloud_aiplatform_v1beta1_tensorboard_time_series_object = nil, tensorboard_time_series_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/timeSeries', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardTimeSeries::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_tensorboard_time_series_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardTimeSeries::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardTimeSeries
  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_v1beta1_training_pipeline_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TrainingPipeline

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_v1beta1_training_pipeline_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TrainingPipeline) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



23417
23418
23419
23420
23421
23422
23423
23424
23425
23426
23427
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23417

def create_project_location_training_pipeline(parent, google_cloud_aiplatform_v1beta1_training_pipeline_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/trainingPipelines', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TrainingPipeline::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_training_pipeline_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TrainingPipeline::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TrainingPipeline
  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_v1beta1_tuning_job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TuningJob

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_v1beta1_tuning_job_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TuningJob) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



23793
23794
23795
23796
23797
23798
23799
23800
23801
23802
23803
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23793

def create_project_location_tuning_job(parent, google_cloud_aiplatform_v1beta1_tuning_job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/tuningJobs', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TuningJob::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_tuning_job_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TuningJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TuningJob
  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_project_location_agent_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



365
366
367
368
369
370
371
372
373
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 365

def delete_project_location_agent_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_app_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



548
549
550
551
552
553
554
555
556
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 548

def delete_project_location_app_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_batch_prediction_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



768
769
770
771
772
773
774
775
776
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 768

def delete_project_location_batch_prediction_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



917
918
919
920
921
922
923
924
925
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 917

def delete_project_location_cached_content(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



1133
1134
1135
1136
1137
1138
1139
1140
1141
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1133

def delete_project_location_custom_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



1286
1287
1288
1289
1290
1291
1292
1293
1294
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1286

def delete_project_location_custom_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



1498
1499
1500
1501
1502
1503
1504
1505
1506
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1498

def delete_project_location_data_labeling_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



1657
1658
1659
1660
1661
1662
1663
1664
1665
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1657

def delete_project_location_data_labeling_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



1835
1836
1837
1838
1839
1840
1841
1842
1843
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1835

def delete_project_location_dataset(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



2224
2225
2226
2227
2228
2229
2230
2231
2232
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2224

def delete_project_location_dataset_annotation_spec_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



2502
2503
2504
2505
2506
2507
2508
2509
2510
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2502

def delete_project_location_dataset_data_item_annotation_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



2685
2686
2687
2688
2689
2690
2691
2692
2693
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2685

def delete_project_location_dataset_data_item_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



2864
2865
2866
2867
2868
2869
2870
2871
2872
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2864

def delete_project_location_dataset_dataset_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



3084
3085
3086
3087
3088
3089
3090
3091
3092
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3084

def delete_project_location_dataset_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



3228
3229
3230
3231
3232
3233
3234
3235
3236
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3228

def delete_project_location_dataset_saved_query(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



3345
3346
3347
3348
3349
3350
3351
3352
3353
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3345

def delete_project_location_dataset_saved_query_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



3524
3525
3526
3527
3528
3529
3530
3531
3532
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3524

def delete_project_location_deployment_resource_pool(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



3709
3710
3711
3712
3713
3714
3715
3716
3717
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3709

def delete_project_location_deployment_resource_pool_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_edge_device_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



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

def delete_project_location_edge_device_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



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

def delete_project_location_endpoint(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



4919
4920
4921
4922
4923
4924
4925
4926
4927
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 4919

def delete_project_location_endpoint_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_evaluation_task_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5065
5066
5067
5068
5069
5070
5071
5072
5073
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5065

def delete_project_location_evaluation_task_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_example_store_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5248
5249
5250
5251
5252
5253
5254
5255
5256
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5248

def delete_project_location_example_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_extension(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation

Deletes an Extension.

Parameters:

  • name (String)

    Required. The name of the Extension resource to be deleted. Format: projects/ project/locations/location/extensions/extension``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def delete_project_location_extension(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_extension_controller_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5431
5432
5433
5434
5435
5436
5437
5438
5439
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5431

def delete_project_location_extension_controller_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_extension_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5864
5865
5866
5867
5868
5869
5870
5871
5872
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5864

def delete_project_location_extension_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6051

def delete_project_location_feature_group(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



6257
6258
6259
6260
6261
6262
6263
6264
6265
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6257

def delete_project_location_feature_group_feature(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



6444
6445
6446
6447
6448
6449
6450
6451
6452
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6444

def delete_project_location_feature_group_feature_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



6590
6591
6592
6593
6594
6595
6596
6597
6598
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6590

def delete_project_location_feature_group_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6779

def delete_project_location_feature_online_store(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



7112
7113
7114
7115
7116
7117
7118
7119
7120
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7112

def delete_project_location_feature_online_store_feature_view(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



7630
7631
7632
7633
7634
7635
7636
7637
7638
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7630

def delete_project_location_feature_online_store_feature_view_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



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

def delete_project_location_feature_online_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8004

def delete_project_location_featurestore(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8402

def delete_project_location_featurestore_entity_type(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



9019
9020
9021
9022
9023
9024
9025
9026
9027
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9019

def delete_project_location_featurestore_entity_type_feature(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



9243
9244
9245
9246
9247
9248
9249
9250
9251
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9243

def delete_project_location_featurestore_entity_type_feature_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_delete_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_delete_feature_values_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8442

def delete_project_location_featurestore_entity_type_feature_values(entity_type, google_cloud_aiplatform_v1beta1_delete_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+entityType}:deleteFeatureValues', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_delete_feature_values_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



9426
9427
9428
9429
9430
9431
9432
9433
9434
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9426

def delete_project_location_featurestore_entity_type_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



9609
9610
9611
9612
9613
9614
9615
9616
9617
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9609

def delete_project_location_featurestore_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



9831
9832
9833
9834
9835
9836
9837
9838
9839
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9831

def delete_project_location_hyperparameter_tuning_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



9987
9988
9989
9990
9991
9992
9993
9994
9995
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9987

def delete_project_location_hyperparameter_tuning_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



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

def delete_project_location_index(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



10165
10166
10167
10168
10169
10170
10171
10172
10173
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10165

def delete_project_location_index_endpoint(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



10533
10534
10535
10536
10537
10538
10539
10540
10541
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10533

def delete_project_location_index_endpoint_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



10962
10963
10964
10965
10966
10967
10968
10969
10970
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10962

def delete_project_location_index_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



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

def (name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11305

def (name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



11608
11609
11610
11611
11612
11613
11614
11615
11616
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11608

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11877

def (name, etag: nil, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



12193
12194
12195
12196
12197
12198
12199
12200
12201
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12193

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12423

def (name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



12700
12701
12702
12703
12704
12705
12706
12707
12708
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12700

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



13003
13004
13005
13006
13007
13008
13009
13010
13011
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13003

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



13258
13259
13260
13261
13262
13263
13264
13265
13266
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13258

def delete_project_location_migratable_resource_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



14522
14523
14524
14525
14526
14527
14528
14529
14530
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14522

def delete_project_location_model(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



13438
13439
13440
13441
13442
13443
13444
13445
13446
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13438

def delete_project_location_model_deployment_monitoring_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



13753
13754
13755
13756
13757
13758
13759
13760
13761
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13753

def delete_project_location_model_deployment_monitoring_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



15177
15178
15179
15180
15181
15182
15183
15184
15185
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15177

def delete_project_location_model_evaluation_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_monitor(name, force: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation

Deletes a ModelMonitor.

Parameters:

  • name (String)

    Required. The name of the ModelMonitor resource to be deleted. Format: projects/project/locations/location/modelMonitords/model_monitor``

  • force (Boolean) (defaults to: nil)

    Optional. Force delete the model monitor with schedules.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13938
13939
13940
13941
13942
13943
13944
13945
13946
13947
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13938

def delete_project_location_model_monitor(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_model_monitor_model_monitoring_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation

Deletes a ModelMonitoringJob.

Parameters:

  • name (String)

    Required. The resource name of the model monitoring job to delete. Format: projects/project/locations/location/modelMonitors/model_monitor/ modelMonitoringJobs/model_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



14190
14191
14192
14193
14194
14195
14196
14197
14198
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14190

def delete_project_location_model_monitor_model_monitoring_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_monitor_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



14339
14340
14341
14342
14343
14344
14345
14346
14347
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14339

def delete_project_location_model_monitor_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



15473
15474
15475
15476
15477
15478
15479
15480
15481
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15473

def delete_project_location_model_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



14556
14557
14558
14559
14560
14561
14562
14563
14564
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14556

def delete_project_location_model_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}:deleteVersion', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



15691
15692
15693
15694
15695
15696
15697
15698
15699
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15691

def delete_project_location_nas_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



15911
15912
15913
15914
15915
15916
15917
15918
15919
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15911

def delete_project_location_notebook_execution_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



16143
16144
16145
16146
16147
16148
16149
16150
16151
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16143

def delete_project_location_notebook_execution_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



16830
16831
16832
16833
16834
16835
16836
16837
16838
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16830

def delete_project_location_notebook_runtime(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



17147
17148
17149
17150
17151
17152
17153
17154
17155
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17147

def delete_project_location_notebook_runtime_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



16325
16326
16327
16328
16329
16330
16331
16332
16333
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16325

def delete_project_location_notebook_runtime_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



16649
16650
16651
16652
16653
16654
16655
16656
16657
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16649

def delete_project_location_notebook_runtime_template_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



17330
17331
17332
17333
17334
17335
17336
17337
17338
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17330

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



17513
17514
17515
17516
17517
17518
17519
17520
17521
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17513

def delete_project_location_persistent_resource(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



17726
17727
17728
17729
17730
17731
17732
17733
17734
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17726

def delete_project_location_persistent_resource_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



18024
18025
18026
18027
18028
18029
18030
18031
18032
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18024

def delete_project_location_pipeline_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



18198
18199
18200
18201
18202
18203
18204
18205
18206
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18198

def delete_project_location_pipeline_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



18700
18701
18702
18703
18704
18705
18706
18707
18708
18709
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18700

def delete_project_location_rag_corpora(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



18841
18842
18843
18844
18845
18846
18847
18848
18849
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18841

def delete_project_location_rag_corpora_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



18985
18986
18987
18988
18989
18990
18991
18992
18993
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18985

def delete_project_location_rag_corpora_rag_file(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



19159
19160
19161
19162
19163
19164
19165
19166
19167
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19159

def delete_project_location_rag_corpora_rag_file_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



19337
19338
19339
19340
19341
19342
19343
19344
19345
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19337

def delete_project_location_reasoning_engine(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



19549
19550
19551
19552
19553
19554
19555
19556
19557
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19549

def delete_project_location_reasoning_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



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

def delete_project_location_schedule(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



20010
20011
20012
20013
20014
20015
20016
20017
20018
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20010

def delete_project_location_schedule_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_solver_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



20156
20157
20158
20159
20160
20161
20162
20163
20164
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20156

def delete_project_location_solver_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



20296
20297
20298
20299
20300
20301
20302
20303
20304
20305
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20296

def delete_project_location_specialist_pool(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



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

def delete_project_location_specialist_pool_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



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

def delete_project_location_study(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



20829
20830
20831
20832
20833
20834
20835
20836
20837
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20829

def delete_project_location_study_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



21112
21113
21114
21115
21116
21117
21118
21119
21120
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21112

def delete_project_location_study_trial(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



21358
21359
21360
21361
21362
21363
21364
21365
21366
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21358

def delete_project_location_study_trial_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



21578
21579
21580
21581
21582
21583
21584
21585
21586
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21578

def delete_project_location_tensorboard(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



21872
21873
21874
21875
21876
21877
21878
21879
21880
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21872

def delete_project_location_tensorboard_experiment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



22102
22103
22104
22105
22106
22107
22108
22109
22110
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22102

def delete_project_location_tensorboard_experiment_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



22323
22324
22325
22326
22327
22328
22329
22330
22331
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22323

def delete_project_location_tensorboard_experiment_run(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



22554
22555
22556
22557
22558
22559
22560
22561
22562
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22554

def delete_project_location_tensorboard_experiment_run_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



22739
22740
22741
22742
22743
22744
22745
22746
22747
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22739

def delete_project_location_tensorboard_experiment_run_time_series(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



23047
23048
23049
23050
23051
23052
23053
23054
23055
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23047

def delete_project_location_tensorboard_experiment_run_time_series_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



23230
23231
23232
23233
23234
23235
23236
23237
23238
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23230

def delete_project_location_tensorboard_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



23450
23451
23452
23453
23454
23455
23456
23457
23458
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23450

def delete_project_location_training_pipeline(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



23606
23607
23608
23609
23610
23611
23612
23613
23614
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23606

def delete_project_location_training_pipeline_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_deploy_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_deploy_model_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DeployModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 4181

def deploy_project_location_endpoint_model(endpoint, google_cloud_aiplatform_v1beta1_deploy_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:deployModel', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DeployModelRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_deploy_model_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_deploy_index_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_deploy_index_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DeployIndexRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10199

def deploy_project_location_index_endpoint_index(index_endpoint, google_cloud_aiplatform_v1beta1_deploy_index_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+indexEndpoint}:deployIndex', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DeployIndexRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_deploy_index_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_direct_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DirectPredictResponse

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_v1beta1_direct_predict_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DirectPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 4216

def direct_project_location_endpoint_predict(endpoint, google_cloud_aiplatform_v1beta1_direct_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:directPredict', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DirectPredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_direct_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DirectPredictResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DirectPredictResponse
  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_v1beta1_direct_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DirectRawPredictResponse

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_v1beta1_direct_raw_predict_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DirectRawPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 4251

def direct_project_location_endpoint_raw_predict(endpoint, google_cloud_aiplatform_v1beta1_direct_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:directRawPredict', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DirectRawPredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_direct_raw_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DirectRawPredictResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DirectRawPredictResponse
  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_v1beta1_evaluate_instances_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluateInstancesResponse

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_v1beta1_evaluate_instances_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluateInstancesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



185
186
187
188
189
190
191
192
193
194
195
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 185

def evaluate_project_location_instances(location, google_cloud_aiplatform_v1beta1_evaluate_instances_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+location}:evaluateInstances', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluateInstancesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_evaluate_instances_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluateInstancesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluateInstancesResponse
  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

#execute_project_location_extension(name, google_cloud_aiplatform_v1beta1_execute_extension_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteExtensionResponse

Executes the request against a given extension.

Parameters:

  • name (String)

    Required. Name (identifier) of the extension; Format: projects/project/ locations/location/extensions/extension``

  • google_cloud_aiplatform_v1beta1_execute_extension_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteExtensionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5607

def execute_project_location_extension(name, google_cloud_aiplatform_v1beta1_execute_extension_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:execute', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteExtensionRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_execute_extension_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteExtensionResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteExtensionResponse
  command.params['name'] = name unless name.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_v1beta1_explain_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExplainResponse

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_v1beta1_explain_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExplainRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 4288

def explain_project_location_endpoint(endpoint, google_cloud_aiplatform_v1beta1_explain_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:explain', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExplainRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_explain_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExplainResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExplainResponse
  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_v1beta1_export_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_export_data_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExportDataRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1867

def export_project_location_dataset(name, google_cloud_aiplatform_v1beta1_export_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:export', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExportDataRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_export_data_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_export_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_export_feature_values_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExportFeatureValuesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8477

def export_project_location_featurestore_entity_type_feature_values(entity_type, google_cloud_aiplatform_v1beta1_export_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+entityType}:exportFeatureValues', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExportFeatureValuesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_export_feature_values_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_export_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_export_model_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExportModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the 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
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14591

def export_project_location_model(name, google_cloud_aiplatform_v1beta1_export_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:export', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExportModelRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_export_model_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_export_tensorboard_time_series_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataResponse

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_v1beta1_export_tensorboard_time_series_data_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



22772
22773
22774
22775
22776
22777
22778
22779
22780
22781
22782
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22772

def export_project_location_tensorboard_experiment_run_time_series_tensorboard_time_series(tensorboard_time_series, google_cloud_aiplatform_v1beta1_export_tensorboard_time_series_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_export_tensorboard_time_series_data_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataResponse
  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_feature_online_store_feature_view_feature_values(feature_view, google_cloud_aiplatform_v1beta1_fetch_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse

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_v1beta1_fetch_feature_values_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7144

def fetch_project_location_feature_online_store_feature_view_feature_values(feature_view, google_cloud_aiplatform_v1beta1_fetch_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+featureView}:fetchFeatureValues', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_fetch_feature_values_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse
  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

#find_project_location_index_endpoint_neighbors(index_endpoint, google_cloud_aiplatform_v1beta1_find_neighbors_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FindNeighborsResponse

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_v1beta1_find_neighbors_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FindNeighborsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10233

def find_project_location_index_endpoint_neighbors(index_endpoint, google_cloud_aiplatform_v1beta1_find_neighbors_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+indexEndpoint}:findNeighbors', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FindNeighborsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_find_neighbors_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FindNeighborsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FindNeighborsResponse
  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_project_location_endpoint_content(model, google_cloud_aiplatform_v1beta1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentResponse

Generate content with multimodal inputs.

Parameters:

  • model (String)

    Required. The name of the publisher model requested to serve the prediction. Format: projects/project/locations/location/publishers/*/models/*

  • google_cloud_aiplatform_v1beta1_generate_content_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 4322

def generate_project_location_endpoint_content(model, google_cloud_aiplatform_v1beta1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+model}:generateContent', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_generate_content_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentResponse
  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_notebook_execution_job_access_token(name, google_cloud_aiplatform_v1beta1_generate_access_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse

Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/ colab-on-vertex-euc-dd

Parameters:

  • name (String)

    Required. The name of the resource requesting the OAuth2 token. Format: projects/project/locations/location/notebookRuntimes/notebook_runtime` projects/`project`/locations/`location`/notebookExecutionJobs/` notebook_execution_job

  • google_cloud_aiplatform_v1beta1_generate_access_token_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



15947
15948
15949
15950
15951
15952
15953
15954
15955
15956
15957
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15947

def generate_project_location_notebook_execution_job_access_token(name, google_cloud_aiplatform_v1beta1_generate_access_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:generateAccessToken', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_generate_access_token_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse
  command.params['name'] = name unless name.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_notebook_runtime_access_token(name, google_cloud_aiplatform_v1beta1_generate_access_token_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse

Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/ colab-on-vertex-euc-dd

Parameters:

  • name (String)

    Required. The name of the resource requesting the OAuth2 token. Format: projects/project/locations/location/notebookRuntimes/notebook_runtime` projects/`project`/locations/`location`/notebookExecutionJobs/` notebook_execution_job

  • google_cloud_aiplatform_v1beta1_generate_access_token_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16866
16867
16868
16869
16870
16871
16872
16873
16874
16875
16876
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16866

def generate_project_location_notebook_runtime_access_token(name, google_cloud_aiplatform_v1beta1_generate_access_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:generateAccessToken', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_generate_access_token_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse
  command.params['name'] = name unless name.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_v1beta1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentResponse

Generate content with multimodal inputs.

Parameters:

  • model (String)

    Required. The name of the publisher model requested to serve the prediction. Format: projects/project/locations/location/publishers/*/models/*

  • google_cloud_aiplatform_v1beta1_generate_content_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18411
18412
18413
18414
18415
18416
18417
18418
18419
18420
18421
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18411

def generate_project_location_publisher_model_content(model, google_cloud_aiplatform_v1beta1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+model}:generateContent', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_generate_content_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentResponse
  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_project_cache_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CacheConfig

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



119
120
121
122
123
124
125
126
127
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 119

def get_project_cache_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CacheConfig::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CacheConfig
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



217
218
219
220
221
222
223
224
225
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 217

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudLocationLocation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_agent_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



396
397
398
399
400
401
402
403
404
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 396

def get_project_location_agent_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_app_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



579
580
581
582
583
584
585
586
587
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 579

def get_project_location_app_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_batch_prediction_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchPredictionJob

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



799
800
801
802
803
804
805
806
807
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 799

def get_project_location_batch_prediction_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchPredictionJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BatchPredictionJob
  command.params['name'] = name unless name.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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CachedContent

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



947
948
949
950
951
952
953
954
955
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 947

def get_project_location_cached_content(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CachedContent::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CachedContent
  command.params['name'] = name unless name.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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomJob

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



1164
1165
1166
1167
1168
1169
1170
1171
1172
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1164

def get_project_location_custom_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomJob
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



1317
1318
1319
1320
1321
1322
1323
1324
1325
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1317

def get_project_location_custom_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DataLabelingJob

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



1529
1530
1531
1532
1533
1534
1535
1536
1537
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1529

def get_project_location_data_labeling_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DataLabelingJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DataLabelingJob
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



1688
1689
1690
1691
1692
1693
1694
1695
1696
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1688

def get_project_location_data_labeling_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Dataset

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



1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1901

def get_project_location_dataset(name, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Dataset::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Dataset
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AnnotationSpec

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



2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2153

def get_project_location_dataset_annotation_spec(name, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AnnotationSpec::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AnnotationSpec
  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::AiplatformV1beta1::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



2255
2256
2257
2258
2259
2260
2261
2262
2263
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2255

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



2533
2534
2535
2536
2537
2538
2539
2540
2541
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2533

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



2716
2717
2718
2719
2720
2721
2722
2723
2724
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2716

def get_project_location_dataset_data_item_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DatasetVersion

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



2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2898

def get_project_location_dataset_dataset_version(name, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DatasetVersion::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DatasetVersion
  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::AiplatformV1beta1::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



3115
3116
3117
3118
3119
3120
3121
3122
3123
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3115

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



3376
3377
3378
3379
3380
3381
3382
3383
3384
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3376

def get_project_location_dataset_saved_query_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DeploymentResourcePool

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



3556
3557
3558
3559
3560
3561
3562
3563
3564
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3556

def get_project_location_deployment_resource_pool(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DeploymentResourcePool::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DeploymentResourcePool
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



3740
3741
3742
3743
3744
3745
3746
3747
3748
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3740

def get_project_location_deployment_resource_pool_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_edge_device_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



3923
3924
3925
3926
3927
3928
3929
3930
3931
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3923

def get_project_location_edge_device_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Endpoint

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



4355
4356
4357
4358
4359
4360
4361
4362
4363
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 4355

def get_project_location_endpoint(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Endpoint::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Endpoint
  command.params['name'] = name unless name.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_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



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

def get_project_location_endpoint_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_endpoint_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



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

def get_project_location_endpoint_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_evaluation_task_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5096
5097
5098
5099
5100
5101
5102
5103
5104
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5096

def get_project_location_evaluation_task_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_example_store_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5279
5280
5281
5282
5283
5284
5285
5286
5287
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5279

def get_project_location_example_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_extension(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Extension

Gets an Extension.

Parameters:

  • name (String)

    Required. The name of the Extension resource. Format: projects/project/ locations/location/extensions/extension``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5640
5641
5642
5643
5644
5645
5646
5647
5648
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5640

def get_project_location_extension(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Extension::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Extension
  command.params['name'] = name unless name.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_extension_controller_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5462
5463
5464
5465
5466
5467
5468
5469
5470
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5462

def get_project_location_extension_controller_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_extension_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



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

def get_project_location_extension_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureGroup

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



6082
6083
6084
6085
6086
6087
6088
6089
6090
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6082

def get_project_location_feature_group(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureGroup::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureGroup
  command.params['name'] = name unless name.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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Feature

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



6290
6291
6292
6293
6294
6295
6296
6297
6298
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6290

def get_project_location_feature_group_feature(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Feature::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Feature
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



6475
6476
6477
6478
6479
6480
6481
6482
6483
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6475

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



6621
6622
6623
6624
6625
6626
6627
6628
6629
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6621

def get_project_location_feature_group_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureOnlineStore

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



6810
6811
6812
6813
6814
6815
6816
6817
6818
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6810

def get_project_location_feature_online_store(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureOnlineStore::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureOnlineStore
  command.params['name'] = name unless name.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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureView

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



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

def get_project_location_feature_online_store_feature_view(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureView::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureView
  command.params['name'] = name unless name.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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureViewSync

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



7542
7543
7544
7545
7546
7547
7548
7549
7550
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7542

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, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureViewSync::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureViewSync
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7222

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, 'v1beta1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



7661
7662
7663
7664
7665
7666
7667
7668
7669
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7661

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



6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6854

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, 'v1beta1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



7807
7808
7809
7810
7811
7812
7813
7814
7815
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7807

def get_project_location_feature_online_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Featurestore

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



8035
8036
8037
8038
8039
8040
8041
8042
8043
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8035

def get_project_location_featurestore(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Featurestore::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Featurestore
  command.params['name'] = name unless name.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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EntityType

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



8510
8511
8512
8513
8514
8515
8516
8517
8518
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8510

def get_project_location_featurestore_entity_type(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EntityType::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EntityType
  command.params['name'] = name unless name.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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Feature

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



9052
9053
9054
9055
9056
9057
9058
9059
9060
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9052

def get_project_location_featurestore_entity_type_feature(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Feature::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Feature
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



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

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



8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8554

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, 'v1beta1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



9457
9458
9459
9460
9461
9462
9463
9464
9465
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9457

def get_project_location_featurestore_entity_type_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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, google_iam_v1_get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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.

  • google_iam_v1_get_iam_policy_request_object (Google::Apis::AiplatformV1beta1::GoogleIamV1GetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8069

def get_project_location_featurestore_iam_policy(resource, google_iam_v1_get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+resource}:getIamPolicy', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1GetIamPolicyRequest::Representation
  command.request_object = google_iam_v1_get_iam_policy_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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

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



9640
9641
9642
9643
9644
9645
9646
9647
9648
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9640

def get_project_location_featurestore_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1HyperparameterTuningJob

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



9863
9864
9865
9866
9867
9868
9869
9870
9871
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9863

def get_project_location_hyperparameter_tuning_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1HyperparameterTuningJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1HyperparameterTuningJob
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



10018
10019
10020
10021
10022
10023
10024
10025
10026
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10018

def get_project_location_hyperparameter_tuning_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Index

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



10743
10744
10745
10746
10747
10748
10749
10750
10751
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10743

def get_project_location_index(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Index::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Index
  command.params['name'] = name unless name.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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1IndexEndpoint

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



10266
10267
10268
10269
10270
10271
10272
10273
10274
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10266

def get_project_location_index_endpoint(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1IndexEndpoint::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1IndexEndpoint
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



10564
10565
10566
10567
10568
10569
10570
10571
10572
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10564

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



10993
10994
10995
10996
10997
10998
10999
11000
11001
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10993

def get_project_location_index_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MetadataStore

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



11184
11185
11186
11187
11188
11189
11190
11191
11192
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11184

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MetadataStore::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MetadataStore
  command.params['name'] = name unless name.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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Artifact

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



11338
11339
11340
11341
11342
11343
11344
11345
11346
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11338

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Artifact::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Artifact
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



11639
11640
11641
11642
11643
11644
11645
11646
11647
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11639

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

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



11911
11912
11913
11914
11915
11916
11917
11918
11919
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11911

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Context::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Context
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



12224
12225
12226
12227
12228
12229
12230
12231
12232
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12224

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

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



12456
12457
12458
12459
12460
12461
12462
12463
12464
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12456

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Execution::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Execution
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



12731
12732
12733
12734
12735
12736
12737
12738
12739
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12731

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

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



12889
12890
12891
12892
12893
12894
12895
12896
12897
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12889

def (name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MetadataSchema::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MetadataSchema
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



13034
13035
13036
13037
13038
13039
13040
13041
13042
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13034

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



13289
13290
13291
13292
13293
13294
13295
13296
13297
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13289

def get_project_location_migratable_resource_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Model

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



14630
14631
14632
14633
14634
14635
14636
14637
14638
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14630

def get_project_location_model(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Model::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Model
  command.params['name'] = name unless name.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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob

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



13470
13471
13472
13473
13474
13475
13476
13477
13478
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13470

def get_project_location_model_deployment_monitoring_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



13784
13785
13786
13787
13788
13789
13790
13791
13792
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13784

def get_project_location_model_deployment_monitoring_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelEvaluation

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



15028
15029
15030
15031
15032
15033
15034
15035
15036
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15028

def get_project_location_model_evaluation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelEvaluation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelEvaluation
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



15208
15209
15210
15211
15212
15213
15214
15215
15216
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15208

def get_project_location_model_evaluation_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelEvaluationSlice

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



15357
15358
15359
15360
15361
15362
15363
15364
15365
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15357

def get_project_location_model_evaluation_slice(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelEvaluationSlice::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelEvaluationSlice
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14674

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, 'v1beta1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_monitor(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitor

Gets a ModelMonitor.

Parameters:

  • name (String)

    Required. The name of the ModelMonitor resource. Format: projects/project/ locations/location/modelMonitors/model_monitor``

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13970
13971
13972
13973
13974
13975
13976
13977
13978
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13970

def get_project_location_model_monitor(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitor::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitor
  command.params['name'] = name unless name.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_monitor_model_monitoring_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitoringJob

Gets a ModelMonitoringJob.

Parameters:

  • name (String)

    Required. The resource name of the ModelMonitoringJob. Format: projects/ project/locations/location/modelMonitors/model_monitor/ modelMonitoringJobs/model_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



14222
14223
14224
14225
14226
14227
14228
14229
14230
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14222

def get_project_location_model_monitor_model_monitoring_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitoringJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitoringJob
  command.params['name'] = name unless name.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_monitor_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



14370
14371
14372
14373
14374
14375
14376
14377
14378
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14370

def get_project_location_model_monitor_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



15504
15505
15506
15507
15508
15509
15510
15511
15512
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15504

def get_project_location_model_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NasJob

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



15722
15723
15724
15725
15726
15727
15728
15729
15730
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15722

def get_project_location_nas_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NasJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NasJob
  command.params['name'] = name unless name.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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NasTrialDetail

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



15805
15806
15807
15808
15809
15810
15811
15812
15813
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15805

def get_project_location_nas_job_nas_trial_detail(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NasTrialDetail::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NasTrialDetail
  command.params['name'] = name unless name.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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookExecutionJob

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



15981
15982
15983
15984
15985
15986
15987
15988
15989
15990
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15981

def get_project_location_notebook_execution_job(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookExecutionJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookExecutionJob
  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::AiplatformV1beta1::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



16174
16175
16176
16177
16178
16179
16180
16181
16182
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16174

def get_project_location_notebook_execution_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookRuntime

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



16900
16901
16902
16903
16904
16905
16906
16907
16908
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16900

def get_project_location_notebook_runtime(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookRuntime::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookRuntime
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



17178
17179
17180
17181
17182
17183
17184
17185
17186
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17178

def get_project_location_notebook_runtime_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate

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



16357
16358
16359
16360
16361
16362
16363
16364
16365
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16357

def get_project_location_notebook_runtime_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



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

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, 'v1beta1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



16680
16681
16682
16683
16684
16685
16686
16687
16688
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16680

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



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

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PersistentResource

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



17545
17546
17547
17548
17549
17550
17551
17552
17553
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17545

def get_project_location_persistent_resource(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PersistentResource::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PersistentResource
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



17757
17758
17759
17760
17761
17762
17763
17764
17765
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17757

def get_project_location_persistent_resource_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PipelineJob

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



18055
18056
18057
18058
18059
18060
18061
18062
18063
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18055

def get_project_location_pipeline_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PipelineJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PipelineJob
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



18229
18230
18231
18232
18233
18234
18235
18236
18237
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18229

def get_project_location_pipeline_job_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_publisher_model_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



18457
18458
18459
18460
18461
18462
18463
18464
18465
18466
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18457

def get_project_location_publisher_model_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_rag_corpora(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagCorpus

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



18732
18733
18734
18735
18736
18737
18738
18739
18740
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18732

def get_project_location_rag_corpora(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagCorpus::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagCorpus
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



18872
18873
18874
18875
18876
18877
18878
18879
18880
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18872

def get_project_location_rag_corpora_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagFile

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



19016
19017
19018
19019
19020
19021
19022
19023
19024
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19016

def get_project_location_rag_corpora_rag_file(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagFile::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagFile
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



19190
19191
19192
19193
19194
19195
19196
19197
19198
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19190

def get_project_location_rag_corpora_rag_file_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngine

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



19368
19369
19370
19371
19372
19373
19374
19375
19376
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19368

def get_project_location_reasoning_engine(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngine::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngine
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



19580
19581
19582
19583
19584
19585
19586
19587
19588
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19580

def get_project_location_reasoning_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schedule

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



19758
19759
19760
19761
19762
19763
19764
19765
19766
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19758

def get_project_location_schedule(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schedule::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schedule
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



20041
20042
20043
20044
20045
20046
20047
20048
20049
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20041

def get_project_location_schedule_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_solver_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



20187
20188
20189
20190
20191
20192
20193
20194
20195
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20187

def get_project_location_solver_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SpecialistPool

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



20328
20329
20330
20331
20332
20333
20334
20335
20336
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20328

def get_project_location_specialist_pool(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SpecialistPool::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SpecialistPool
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



20507
20508
20509
20510
20511
20512
20513
20514
20515
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20507

def get_project_location_specialist_pool_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Study

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



20685
20686
20687
20688
20689
20690
20691
20692
20693
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20685

def get_project_location_study(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Study::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Study
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



20860
20861
20862
20863
20864
20865
20866
20867
20868
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20860

def get_project_location_study_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial

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



21143
21144
21145
21146
21147
21148
21149
21150
21151
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21143

def get_project_location_study_trial(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



21389
21390
21391
21392
21393
21394
21395
21396
21397
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21389

def get_project_location_study_trial_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Tensorboard

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



21609
21610
21611
21612
21613
21614
21615
21616
21617
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21609

def get_project_location_tensorboard(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Tensorboard::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Tensorboard
  command.params['name'] = name unless name.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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardExperiment

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



21904
21905
21906
21907
21908
21909
21910
21911
21912
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21904

def get_project_location_tensorboard_experiment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardExperiment::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardExperiment
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



22133
22134
22135
22136
22137
22138
22139
22140
22141
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22133

def get_project_location_tensorboard_experiment_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardRun

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



22355
22356
22357
22358
22359
22360
22361
22362
22363
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22355

def get_project_location_tensorboard_experiment_run(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardRun::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardRun
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



22585
22586
22587
22588
22589
22590
22591
22592
22593
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22585

def get_project_location_tensorboard_experiment_run_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardTimeSeries

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



22806
22807
22808
22809
22810
22811
22812
22813
22814
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22806

def get_project_location_tensorboard_experiment_run_time_series(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardTimeSeries::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardTimeSeries
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



23078
23079
23080
23081
23082
23083
23084
23085
23086
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23078

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



23261
23262
23263
23264
23265
23266
23267
23268
23269
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23261

def get_project_location_tensorboard_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TrainingPipeline

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



23481
23482
23483
23484
23485
23486
23487
23488
23489
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23481

def get_project_location_training_pipeline(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TrainingPipeline::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TrainingPipeline
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



23637
23638
23639
23640
23641
23642
23643
23644
23645
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23637

def get_project_location_training_pipeline_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TuningJob

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



23826
23827
23828
23829
23830
23831
23832
23833
23834
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23826

def get_project_location_tuning_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TuningJob::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TuningJob
  command.params['name'] = name unless name.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, language_code: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PublisherModel

Gets a Model Garden publisher model.

Parameters:

  • name (String)

    Required. The name of the PublisherModel resource. Format: publishers/ publisher/models/publisher_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 (see go/bcp47).

  • 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



23903
23904
23905
23906
23907
23908
23909
23910
23911
23912
23913
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23903

def get_publisher_model(name, language_code: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PublisherModel::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PublisherModel
  command.params['name'] = name unless name.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_v1beta1_import_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_import_data_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ImportDataRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1934

def import_project_location_dataset(name, google_cloud_aiplatform_v1beta1_import_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:import', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ImportDataRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_import_data_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_extension(parent, google_cloud_aiplatform_v1beta1_extension_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation

Imports an Extension.

Parameters:

  • parent (String)

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

  • google_cloud_aiplatform_v1beta1_extension_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Extension) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5672

def import_project_location_extension(parent, google_cloud_aiplatform_v1beta1_extension_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/extensions:import', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Extension::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_extension_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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

#import_project_location_featurestore_entity_type_feature_values(entity_type, google_cloud_aiplatform_v1beta1_import_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_import_feature_values_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ImportFeatureValuesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def import_project_location_featurestore_entity_type_feature_values(entity_type, google_cloud_aiplatform_v1beta1_import_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+entityType}:importFeatureValues', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ImportFeatureValuesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_import_feature_values_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_import_model_evaluation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelEvaluation

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_v1beta1_import_model_evaluation_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ImportModelEvaluationRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def import_project_location_model_evaluation(parent, google_cloud_aiplatform_v1beta1_import_model_evaluation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/evaluations:import', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ImportModelEvaluationRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_import_model_evaluation_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelEvaluation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelEvaluation
  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_v1beta1_import_rag_files_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_import_rag_files_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ImportRagFilesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19048
19049
19050
19051
19052
19053
19054
19055
19056
19057
19058
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19048

def import_project_location_rag_corpora_rag_file(parent, google_cloud_aiplatform_v1beta1_import_rag_files_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/ragFiles:import', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ImportRagFilesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_import_rag_files_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_project_location_agent_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



433
434
435
436
437
438
439
440
441
442
443
444
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 433

def list_project_location_agent_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_app_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



616
617
618
619
620
621
622
623
624
625
626
627
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 616

def list_project_location_app_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListBatchPredictionJobsResponse

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



849
850
851
852
853
854
855
856
857
858
859
860
861
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 849

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, 'v1beta1/{+parent}/batchPredictionJobs', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListBatchPredictionJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListBatchPredictionJobsResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListCachedContentsResponse

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



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

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, 'v1beta1/{+parent}/cachedContents', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListCachedContentsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListCachedContentsResponse
  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::AiplatformV1beta1::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



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

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListCustomJobsResponse

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



1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1212

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, 'v1beta1/{+parent}/customJobs', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListCustomJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListCustomJobsResponse
  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::AiplatformV1beta1::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



1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1725

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListDataLabelingJobsResponse

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



1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1582

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, 'v1beta1/{+parent}/dataLabelingJobs', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListDataLabelingJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListDataLabelingJobsResponse
  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::AiplatformV1beta1::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



2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2292

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2570

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListAnnotationsResponse

Lists Annotations belongs to a dataitem

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



2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2427

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, 'v1beta1/{+parent}/annotations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListAnnotationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListAnnotationsResponse
  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::AiplatformV1beta1::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



2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2753

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListDataItemsResponse

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



2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2379

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, 'v1beta1/{+parent}/dataItems', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListDataItemsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListDataItemsResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse

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



2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2941

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, 'v1beta1/{+parent}/datasetVersions', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse
  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::AiplatformV1beta1::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



3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3152

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListSavedQueriesResponse

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



3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3270

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, 'v1beta1/{+parent}/savedQueries', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListSavedQueriesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListSavedQueriesResponse
  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::AiplatformV1beta1::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



3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3413

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListDatasetsResponse

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



1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1985

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, 'v1beta1/{+parent}/datasets', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListDatasetsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListDatasetsResponse
  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::AiplatformV1beta1::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



3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3777

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListDeploymentResourcePoolsResponse

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



3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3595

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, 'v1beta1/{+parent}/deploymentResourcePools', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListDeploymentResourcePoolsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListDeploymentResourcePoolsResponse
  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_edge_device_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3960

def list_project_location_edge_device_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_endpoint_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



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

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListEndpointsResponse

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"

  • 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



4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 4449

def list_project_location_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, 'v1beta1/{+parent}/endpoints', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListEndpointsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListEndpointsResponse
  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_evaluation_task_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5133

def list_project_location_evaluation_task_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_example_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5316

def list_project_location_example_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_extension_controller_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5499

def list_project_location_extension_controller_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_extension_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5932

def list_project_location_extension_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_extensions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListExtensionsResponse

Lists Extensions in a location.

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

    Optional. The standard list filter. Supported fields: * display_name * create_time * update_time More detail in AIP-160.

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5718

def list_project_location_extensions(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, 'v1beta1/{+parent}/extensions', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListExtensionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListExtensionsResponse
  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_group_feature_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6512

def list_project_location_feature_group_feature_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeaturesResponse

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



6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6357

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, 'v1beta1/{+parent}/features', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeaturesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeaturesResponse
  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_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6658

def list_project_location_feature_group_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse

Lists FeatureGroups in a given project and location.

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

    Lists the FeatureGroups that match the filter expression. The following fields are supported: * create_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format. * update_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format.

    • labels: Supports key-value equality and key presence. Examples: * create_time > "2020-01-01" OR update_time > "2020-01-01" FeatureGroups created or updated after 2020-01-01. * labels.env = "prod" FeatureGroups with label "env" set to "prod".
  • order_by (String) (defaults to: nil)

    A comma-separated list of fields to order by, sorted in ascending order. Use " desc" after a field name for descending. Supported Fields: * create_time * update_time

  • page_size (Fixnum) (defaults to: nil)

    The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.

  • page_token (String) (defaults to: nil)

    A page token, received from a previous FeatureGroupAdminService. ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureGroupAdminService. ListFeatureGroups must match the call that provided the page token.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6135

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, 'v1beta1/{+parent}/featureGroups', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeatureViewSyncsResponse

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



7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7593

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, 'v1beta1/{+parent}/featureViewSyncs', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeatureViewSyncsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeatureViewSyncsResponse
  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_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7698

def list_project_location_feature_online_store_feature_view_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeatureViewsResponse

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



7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7279

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, 'v1beta1/{+parent}/featureViews', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeatureViewsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeatureViewsResponse
  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_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7844

def list_project_location_feature_online_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeatureOnlineStoresResponse

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



6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6910

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, 'v1beta1/{+parent}/featureOnlineStores', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeatureOnlineStoresResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeatureOnlineStoresResponse
  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::AiplatformV1beta1::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



9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9311

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeaturesResponse

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



9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9119

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, 'v1beta1/{+parent}/features', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeaturesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeaturesResponse
  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::AiplatformV1beta1::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



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

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListEntityTypesResponse

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



8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8659

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, 'v1beta1/{+parent}/entityTypes', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListEntityTypesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListEntityTypesResponse
  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::AiplatformV1beta1::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



9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9677

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeaturestoresResponse

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



8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8127

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, 'v1beta1/{+parent}/featurestores', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeaturestoresResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListFeaturestoresResponse
  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::AiplatformV1beta1::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



10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10055

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListHyperparameterTuningJobsResponse

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



9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9913

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, 'v1beta1/{+parent}/hyperparameterTuningJobs', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListHyperparameterTuningJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListHyperparameterTuningJobsResponse
  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::AiplatformV1beta1::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



10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10601

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListIndexEndpointsResponse

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



10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10316

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, 'v1beta1/{+parent}/indexEndpoints', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListIndexEndpointsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListIndexEndpointsResponse
  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::AiplatformV1beta1::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



11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11030

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListIndexesResponse

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



10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10783

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, 'v1beta1/{+parent}/indexes', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListIndexesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListIndexesResponse
  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::AiplatformV1beta1::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



11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11676

def (name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListArtifactsResponse

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



11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11402

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, 'v1beta1/{+parent}/artifacts', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListArtifactsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListArtifactsResponse
  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::AiplatformV1beta1::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



12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12261

def (name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListContextsResponse

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



11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11975

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, 'v1beta1/{+parent}/contexts', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListContextsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListContextsResponse
  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::AiplatformV1beta1::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



12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12768

def (name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListExecutionsResponse

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



12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12520

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, 'v1beta1/{+parent}/executions', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListExecutionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListExecutionsResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListMetadataSchemasResponse

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



12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12930

def (parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/metadataSchemas', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListMetadataSchemasResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListMetadataSchemasResponse
  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::AiplatformV1beta1::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



13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13071

def (name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListMetadataStoresResponse

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



11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11223

def (parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/metadataStores', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListMetadataStoresResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListMetadataStoresResponse
  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::AiplatformV1beta1::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



13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13326

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



13821
13822
13823
13824
13825
13826
13827
13828
13829
13830
13831
13832
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13821

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelDeploymentMonitoringJobsResponse

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



13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13517

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, 'v1beta1/{+parent}/modelDeploymentMonitoringJobs', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelDeploymentMonitoringJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelDeploymentMonitoringJobsResponse
  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::AiplatformV1beta1::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



15245
15246
15247
15248
15249
15250
15251
15252
15253
15254
15255
15256
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15245

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelEvaluationSlicesResponse

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



15399
15400
15401
15402
15403
15404
15405
15406
15407
15408
15409
15410
15411
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15399

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, 'v1beta1/{+parent}/slices', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelEvaluationSlicesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelEvaluationSlicesResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelEvaluationsResponse

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



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

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, 'v1beta1/{+parent}/evaluations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelEvaluationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelEvaluationsResponse
  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_monitor_model_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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelMonitoringJobsResponse

Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of modelMonitor id in the parent. Format projects/project_id/locations/location/moodelMonitors/-/ modelMonitoringJobs

Parameters:

  • parent (String)

    Required. The parent of the ModelMonitoringJob. Format: projects/project/ locations/location/modelMonitors/model_monitor``

  • filter (String) (defaults to: nil)

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

  • 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



14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14265

def list_project_location_model_monitor_model_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, 'v1beta1/{+parent}/modelMonitoringJobs', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelMonitoringJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelMonitoringJobsResponse
  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_monitor_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



14407
14408
14409
14410
14411
14412
14413
14414
14415
14416
14417
14418
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14407

def list_project_location_model_monitor_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_monitors(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelMonitorsResponse

Lists ModelMonitors in a Location.

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

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

  • 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



14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14009

def list_project_location_model_monitors(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, 'v1beta1/{+parent}/modelMonitors', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelMonitorsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelMonitorsResponse
  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::AiplatformV1beta1::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



15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15541

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelVersionsResponse

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



14774
14775
14776
14777
14778
14779
14780
14781
14782
14783
14784
14785
14786
14787
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14774

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, 'v1beta1/{+name}:listVersions', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelVersionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelVersionsResponse
  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, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelsResponse

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"
  • 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



14723
14724
14725
14726
14727
14728
14729
14730
14731
14732
14733
14734
14735
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14723

def list_project_location_models(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, 'v1beta1/{+parent}/models', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListModelsResponse
  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_nas_job_nas_trial_details(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListNasTrialDetailsResponse

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



15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
15852
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15842

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, 'v1beta1/{+parent}/nasTrialDetails', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListNasTrialDetailsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListNasTrialDetailsResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListNasJobsResponse

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



15770
15771
15772
15773
15774
15775
15776
15777
15778
15779
15780
15781
15782
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15770

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, 'v1beta1/{+parent}/nasJobs', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListNasJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListNasJobsResponse
  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::AiplatformV1beta1::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



16211
16212
16213
16214
16215
16216
16217
16218
16219
16220
16221
16222
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16211

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListNotebookExecutionJobsResponse

Lists NotebookExecutionJobs in a Location.

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

    Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * notebookExecutionJob supports = and !=. notebookExecutionJob represents the NotebookExecutionJob ID. * displayName supports = and != and regex. * schedule supports = and != and regex. Some examples: * notebookExecutionJob="123" * notebookExecutionJob="my-execution-job" * displayName="myDisplayName" and displayName=~"myDisplayNameRegex"

  • order_by (String) (defaults to: nil)

    Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * display_name * create_time * update_time Example: display_name, create_time desc.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The standard list page size.

  • page_token (String) (defaults to: nil)

    Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobs.next_page_token of the previous NotebookService. ListNotebookExecutionJobs call.

  • view (String) (defaults to: nil)

    Optional. The NotebookExecutionJob view. Defaults to BASIC.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

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, 'v1beta1/{+parent}/notebookExecutionJobs', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListNotebookExecutionJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListNotebookExecutionJobsResponse
  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::AiplatformV1beta1::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



17215
17216
17217
17218
17219
17220
17221
17222
17223
17224
17225
17226
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17215

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



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

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListNotebookRuntimeTemplatesResponse

Lists NotebookRuntimeTemplates in a Location.

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

    Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * notebookRuntimeTemplate supports = and !=. notebookRuntimeTemplate represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * display_name supports = and != * labels supports general map functions that is: * labels.key=value - key: value equality * labels.key:* or labels:key - key existence * A key including a space must be quoted.labels."a key". *notebookRuntimeTypesupports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * notebookRuntimeTemplate=notebookRuntimeTemplate123*displayName=" myDisplayName"*labels.myKey="myValue"*notebookRuntimeType=USER_DEFINED`

  • order_by (String) (defaults to: nil)

    Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * display_name * create_time * update_time Example: display_name, create_time desc.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The standard list page size.

  • page_token (String) (defaults to: nil)

    Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.

  • read_mask (String) (defaults to: nil)

    Optional. Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16458
16459
16460
16461
16462
16463
16464
16465
16466
16467
16468
16469
16470
16471
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16458

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, 'v1beta1/{+parent}/notebookRuntimeTemplates', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListNotebookRuntimeTemplatesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListNotebookRuntimeTemplatesResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListNotebookRuntimesResponse

Lists NotebookRuntimes in a Location.

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

    Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * notebookRuntime supports = and !=. notebookRuntime represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * displayName supports = and != and regex. * notebookRuntimeTemplate supports = and !=. notebookRuntimeTemplate represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * healthState supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * runtimeState supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * runtimeUser supports = and !=. * API version is UI only: uiState supports = and !=. uiState enum: [ UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * notebookRuntimeType supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * notebookRuntime="notebookRuntime123" * displayName="myDisplayName" and displayName=~"myDisplayNameRegex" * notebookRuntimeTemplate=" notebookRuntimeTemplate321" * healthState=HEALTHY * runtimeState=RUNNING * runtimeUser="test@google.com" * uiState=UI_RESOURCE_STATE_BEING_DELETED * notebookRuntimeType=USER_DEFINED

  • order_by (String) (defaults to: nil)

    Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * display_name * create_time * update_time Example: display_name, create_time desc.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The standard list page size.

  • page_token (String) (defaults to: nil)

    Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService. ListNotebookRuntimes call.

  • read_mask (String) (defaults to: nil)

    Optional. Mask specifying which fields to read.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16966
16967
16968
16969
16970
16971
16972
16973
16974
16975
16976
16977
16978
16979
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16966

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, 'v1beta1/{+parent}/notebookRuntimes', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListNotebookRuntimesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListNotebookRuntimesResponse
  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::AiplatformV1beta1::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



17398
17399
17400
17401
17402
17403
17404
17405
17406
17407
17408
17409
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17398

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



17794
17795
17796
17797
17798
17799
17800
17801
17802
17803
17804
17805
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17794

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListPersistentResourcesResponse

Lists PersistentResources in a Location.

Parameters:

  • parent (String)

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

  • page_size (Fixnum) (defaults to: nil)

    Optional. The standard list page size.

  • page_token (String) (defaults to: nil)

    Optional. The standard list page token. Typically obtained via ListPersistentResourceResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17582
17583
17584
17585
17586
17587
17588
17589
17590
17591
17592
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17582

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, 'v1beta1/{+parent}/persistentResources', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListPersistentResourcesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListPersistentResourcesResponse
  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::AiplatformV1beta1::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



18266
18267
18268
18269
18270
18271
18272
18273
18274
18275
18276
18277
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18266

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListPipelineJobsResponse

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



18123
18124
18125
18126
18127
18128
18129
18130
18131
18132
18133
18134
18135
18136
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18123

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, 'v1beta1/{+parent}/pipelineJobs', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListPipelineJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListPipelineJobsResponse
  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::AiplatformV1beta1::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



18909
18910
18911
18912
18913
18914
18915
18916
18917
18918
18919
18920
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18909

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



19227
19228
19229
19230
19231
19232
19233
19234
19235
19236
19237
19238
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19227

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListRagFilesResponse

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



19087
19088
19089
19090
19091
19092
19093
19094
19095
19096
19097
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19087

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, 'v1beta1/{+parent}/ragFiles', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListRagFilesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListRagFilesResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListRagCorporaResponse

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



18769
18770
18771
18772
18773
18774
18775
18776
18777
18778
18779
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18769

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, 'v1beta1/{+parent}/ragCorpora', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListRagCorporaResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListRagCorporaResponse
  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::AiplatformV1beta1::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



19617
19618
19619
19620
19621
19622
19623
19624
19625
19626
19627
19628
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19617

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse

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



19406
19407
19408
19409
19410
19411
19412
19413
19414
19415
19416
19417
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19406

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, 'v1beta1/{+parent}/reasoningEngines', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse
  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::AiplatformV1beta1::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



20078
20079
20080
20081
20082
20083
20084
20085
20086
20087
20088
20089
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20078

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListSchedulesResponse

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



19820
19821
19822
19823
19824
19825
19826
19827
19828
19829
19830
19831
19832
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19820

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, 'v1beta1/{+parent}/schedules', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListSchedulesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListSchedulesResponse
  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_solver_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



20224
20225
20226
20227
20228
20229
20230
20231
20232
20233
20234
20235
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20224

def list_project_location_solver_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_pool_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



20544
20545
20546
20547
20548
20549
20550
20551
20552
20553
20554
20555
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20544

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListSpecialistPoolsResponse

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



20367
20368
20369
20370
20371
20372
20373
20374
20375
20376
20377
20378
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20367

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, 'v1beta1/{+parent}/specialistPools', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListSpecialistPoolsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListSpecialistPoolsResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListStudiesResponse

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



20722
20723
20724
20725
20726
20727
20728
20729
20730
20731
20732
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20722

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, 'v1beta1/{+parent}/studies', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListStudiesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListStudiesResponse
  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::AiplatformV1beta1::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



20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20897

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



21426
21427
21428
21429
21430
21431
21432
21433
21434
21435
21436
21437
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21426

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_list_optimal_trials_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListOptimalTrialsResponse

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_v1beta1_list_optimal_trials_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListOptimalTrialsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



21215
21216
21217
21218
21219
21220
21221
21222
21223
21224
21225
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21215

def list_project_location_study_trial_optimal_trials(parent, google_cloud_aiplatform_v1beta1_list_optimal_trials_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/trials:listOptimalTrials', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListOptimalTrialsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_list_optimal_trials_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListOptimalTrialsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListOptimalTrialsResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTrialsResponse

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



21180
21181
21182
21183
21184
21185
21186
21187
21188
21189
21190
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21180

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, 'v1beta1/{+parent}/trials', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTrialsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTrialsResponse
  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::AiplatformV1beta1::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



22170
22171
22172
22173
22174
22175
22176
22177
22178
22179
22180
22181
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22170

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



22622
22623
22624
22625
22626
22627
22628
22629
22630
22631
22632
22633
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22622

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTensorboardTimeSeriesResponse

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



22853
22854
22855
22856
22857
22858
22859
22860
22861
22862
22863
22864
22865
22866
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22853

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, 'v1beta1/{+parent}/timeSeries', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTensorboardTimeSeriesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTensorboardTimeSeriesResponse
  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::AiplatformV1beta1::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



23115
23116
23117
23118
23119
23120
23121
23122
23123
23124
23125
23126
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23115

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTensorboardRunsResponse

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



22402
22403
22404
22405
22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22402

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, 'v1beta1/{+parent}/runs', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTensorboardRunsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTensorboardRunsResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTensorboardExperimentsResponse

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



21950
21951
21952
21953
21954
21955
21956
21957
21958
21959
21960
21961
21962
21963
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21950

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, 'v1beta1/{+parent}/experiments', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTensorboardExperimentsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTensorboardExperimentsResponse
  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::AiplatformV1beta1::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



23298
23299
23300
23301
23302
23303
23304
23305
23306
23307
23308
23309
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23298

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTensorboardsResponse

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



21655
21656
21657
21658
21659
21660
21661
21662
21663
21664
21665
21666
21667
21668
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21655

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, 'v1beta1/{+parent}/tensorboards', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTensorboardsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTensorboardsResponse
  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::AiplatformV1beta1::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



23674
23675
23676
23677
23678
23679
23680
23681
23682
23683
23684
23685
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23674

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, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTrainingPipelinesResponse

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



23532
23533
23534
23535
23536
23537
23538
23539
23540
23541
23542
23543
23544
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23532

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, 'v1beta1/{+parent}/trainingPipelines', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTrainingPipelinesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTrainingPipelinesResponse
  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_jobs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTuningJobsResponse

Lists TuningJobs in a Location.

Parameters:

  • parent (String)

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

  • filter (String) (defaults to: nil)

    Optional. The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    Optional. The standard list page size.

  • page_token (String) (defaults to: nil)

    Optional. The standard list page token. Typically obtained via ListTuningJob. next_page_token of the previous GenAiTuningService.ListTuningJob][] call.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



23864
23865
23866
23867
23868
23869
23870
23871
23872
23873
23874
23875
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23864

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, 'v1beta1/{+parent}/tuningJobs', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTuningJobsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListTuningJobsResponse
  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::AiplatformV1beta1::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



257
258
259
260
261
262
263
264
265
266
267
268
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 257

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, 'v1beta1/{+name}/locations', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudLocationListLocationsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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

#list_publisher_models(parent, filter: nil, language_code: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListPublisherModelsResponse

Lists publisher models in Model Garden.

Parameters:

  • parent (String)

    Required. The name of the Publisher from which to list the PublisherModels. Format: publishers/publisher``

  • filter (String) (defaults to: nil)

    Optional. The standard list filter.

  • language_code (String) (defaults to: nil)

    Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in (see go/bcp47). If not set, by default English (en).

  • 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. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService. ListPublisherModels call.

  • 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



23953
23954
23955
23956
23957
23958
23959
23960
23961
23962
23963
23964
23965
23966
23967
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23953

def list_publisher_models(parent, filter: nil, language_code: 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, 'v1beta1/{+parent}/models', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListPublisherModelsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListPublisherModelsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['languageCode'] = language_code unless language_code.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

#lookup_project_location_study(parent, google_cloud_aiplatform_v1beta1_lookup_study_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Study

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_v1beta1_lookup_study_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LookupStudyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



20757
20758
20759
20760
20761
20762
20763
20764
20765
20766
20767
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20757

def lookup_project_location_study(parent, google_cloud_aiplatform_v1beta1_lookup_study_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/studies:lookup', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LookupStudyRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_lookup_study_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Study::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Study
  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_v1beta1_merge_version_aliases_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Model

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_v1beta1_merge_version_aliases_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MergeVersionAliasesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def merge_project_location_model_version_aliases(name, google_cloud_aiplatform_v1beta1_merge_version_aliases_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:mergeVersionAliases', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MergeVersionAliasesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_merge_version_aliases_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Model::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Model
  command.params['name'] = name unless name.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_v1beta1_mutate_deployed_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_mutate_deployed_model_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MutateDeployedModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 4489

def mutate_project_location_endpoint_deployed_model(endpoint, google_cloud_aiplatform_v1beta1_mutate_deployed_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:mutateDeployedModel', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MutateDeployedModelRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_mutate_deployed_model_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_deployed_index_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_deployed_index_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DeployedIndex) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10353

def mutate_project_location_index_endpoint_deployed_index(index_endpoint, google_cloud_aiplatform_v1beta1_deployed_index_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+indexEndpoint}:mutateDeployedIndex', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DeployedIndex::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_deployed_index_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_project_location_cached_content(name, google_cloud_aiplatform_v1beta1_cached_content_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CachedContent

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_v1beta1_cached_content_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CachedContent) (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



1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1024

def patch_project_location_cached_content(name, google_cloud_aiplatform_v1beta1_cached_content_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CachedContent::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_cached_content_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CachedContent::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CachedContent
  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_v1beta1_dataset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Dataset

Updates a Dataset.

Parameters:

  • name (String)

    Output only. The resource name of the Dataset.

  • google_cloud_aiplatform_v1beta1_dataset_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Dataset) (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



2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2025

def patch_project_location_dataset(name, google_cloud_aiplatform_v1beta1_dataset_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Dataset::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_dataset_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Dataset::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Dataset
  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_v1beta1_dataset_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DatasetVersion

Updates a DatasetVersion.

Parameters:

  • name (String)

    Output only. The resource name of the DatasetVersion.

  • google_cloud_aiplatform_v1beta1_dataset_version_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DatasetVersion) (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



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

def patch_project_location_dataset_dataset_version(name, google_cloud_aiplatform_v1beta1_dataset_version_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DatasetVersion::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_dataset_version_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DatasetVersion::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DatasetVersion
  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_v1beta1_endpoint_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Endpoint

Updates an Endpoint.

Parameters:

  • name (String)

    Output only. The resource name of the Endpoint.

  • google_cloud_aiplatform_v1beta1_endpoint_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Endpoint) (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



4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 4525

def patch_project_location_endpoint(name, google_cloud_aiplatform_v1beta1_endpoint_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Endpoint::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_endpoint_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Endpoint::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Endpoint
  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_extension(name, google_cloud_aiplatform_v1beta1_extension_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Extension

Updates an Extension.

Parameters:

  • name (String)

    Identifier. The resource name of the Extension.

  • google_cloud_aiplatform_v1beta1_extension_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Extension) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

    Required. Mask specifying which fields to update. Supported fields: * display_name * description * runtime_config * tool_use_examples * manifest.description

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5757

def patch_project_location_extension(name, google_cloud_aiplatform_v1beta1_extension_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Extension::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_extension_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Extension::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Extension
  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_v1beta1_feature_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_feature_group_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureGroup) (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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6178

def patch_project_location_feature_group(name, google_cloud_aiplatform_v1beta1_feature_group_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureGroup::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_feature_group_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_feature_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_feature_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Feature) (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 FeatureRegistry 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



6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6408

def patch_project_location_feature_group_feature(name, google_cloud_aiplatform_v1beta1_feature_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Feature::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_feature_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_feature_online_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_feature_online_store_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureOnlineStore) (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: * big_query_source * bigtable * labels * sync_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



6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6954

def patch_project_location_feature_online_store(name, google_cloud_aiplatform_v1beta1_feature_online_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureOnlineStore::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_feature_online_store_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_feature_view_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_feature_view_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureView) (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 * serviceAgentType

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7323

def patch_project_location_feature_online_store_feature_view(name, google_cloud_aiplatform_v1beta1_feature_view_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FeatureView::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_feature_view_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_featurestore_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_featurestore_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Featurestore) (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



8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8172

def patch_project_location_featurestore(name, google_cloud_aiplatform_v1beta1_featurestore_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Featurestore::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_featurestore_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EntityType

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_v1beta1_entity_type_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EntityType) (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



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

def patch_project_location_featurestore_entity_type(name, google_cloud_aiplatform_v1beta1_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EntityType::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_entity_type_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EntityType::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EntityType
  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_v1beta1_feature_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Feature

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_v1beta1_feature_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Feature) (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 FeatureRegistry 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



9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9170

def patch_project_location_featurestore_entity_type_feature(name, google_cloud_aiplatform_v1beta1_feature_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Feature::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_feature_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Feature::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Feature
  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_v1beta1_index_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation

Updates an Index.

Parameters:

  • name (String)

    Output only. The resource name of the Index.

  • google_cloud_aiplatform_v1beta1_index_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Index) (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



10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10821

def patch_project_location_index(name, google_cloud_aiplatform_v1beta1_index_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Index::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_index_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_index_endpoint_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1IndexEndpoint

Updates an IndexEndpoint.

Parameters:

  • name (String)

    Output only. The resource name of the IndexEndpoint.

  • google_cloud_aiplatform_v1beta1_index_endpoint_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1IndexEndpoint) (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



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

def patch_project_location_index_endpoint(name, google_cloud_aiplatform_v1beta1_index_endpoint_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1IndexEndpoint::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_index_endpoint_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1IndexEndpoint::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1IndexEndpoint
  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_v1beta1_artifact_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Artifact

Updates a stored Artifact.

Parameters:

  • name (String)

    Output only. The resource name of the Artifact.

  • google_cloud_aiplatform_v1beta1_artifact_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Artifact) (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



11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11441

def (name, google_cloud_aiplatform_v1beta1_artifact_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Artifact::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_artifact_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Artifact::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Artifact
  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_v1beta1_context_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Context

Updates a stored Context.

Parameters:

  • name (String)

    Immutable. The resource name of the Context.

  • google_cloud_aiplatform_v1beta1_context_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Context) (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



12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12014

def (name, google_cloud_aiplatform_v1beta1_context_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Context::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_context_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Context::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Context
  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_v1beta1_execution_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Execution

Updates a stored Execution.

Parameters:

  • name (String)

    Output only. The resource name of the Execution.

  • google_cloud_aiplatform_v1beta1_execution_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Execution) (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



12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12559

def (name, google_cloud_aiplatform_v1beta1_execution_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Execution::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_execution_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Execution::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Execution
  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_v1beta1_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Model

Updates a Model.

Parameters:

  • name (String)

    The resource name of the Model.

  • google_cloud_aiplatform_v1beta1_model_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Model) (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



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

def patch_project_location_model(name, google_cloud_aiplatform_v1beta1_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Model::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_model_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Model::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Model
  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_v1beta1_model_deployment_monitoring_job_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation

Updates a ModelDeploymentMonitoringJob.

Parameters:

  • name (String)

    Output only. Resource name of a ModelDeploymentMonitoringJob.

  • google_cloud_aiplatform_v1beta1_model_deployment_monitoring_job_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob) (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



13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
13583
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13572

def patch_project_location_model_deployment_monitoring_job(name, google_cloud_aiplatform_v1beta1_model_deployment_monitoring_job_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_model_deployment_monitoring_job_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_model_monitor(name, google_cloud_aiplatform_v1beta1_model_monitor_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation

Updates a ModelMonitor.

Parameters:

  • name (String)

    Immutable. Resource name of the ModelMonitor. Format: projects/project/ locations/location/modelMonitors/model_monitor``.

  • google_cloud_aiplatform_v1beta1_model_monitor_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitor) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

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



14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14047

def patch_project_location_model_monitor(name, google_cloud_aiplatform_v1beta1_model_monitor_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelMonitor::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_model_monitor_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_notebook_runtime_template_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate

Updates a NotebookRuntimeTemplate.

Parameters:

  • name (String)

    The resource name of the NotebookRuntimeTemplate.

  • google_cloud_aiplatform_v1beta1_notebook_runtime_template_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate) (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



16498
16499
16500
16501
16502
16503
16504
16505
16506
16507
16508
16509
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16498

def patch_project_location_notebook_runtime_template(name, google_cloud_aiplatform_v1beta1_notebook_runtime_template_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_notebook_runtime_template_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate
  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_v1beta1_persistent_resource_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation

Updates a PersistentResource.

Parameters:

  • name (String)

    Immutable. Resource name of a PersistentResource.

  • google_cloud_aiplatform_v1beta1_persistent_resource_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PersistentResource) (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



17618
17619
17620
17621
17622
17623
17624
17625
17626
17627
17628
17629
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17618

def patch_project_location_persistent_resource(name, google_cloud_aiplatform_v1beta1_persistent_resource_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PersistentResource::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_persistent_resource_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_reasoning_engine(name, google_cloud_aiplatform_v1beta1_reasoning_engine_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation

Updates a reasoning engine.

Parameters:

  • name (String)

    Identifier. The resource name of the ReasoningEngine.

  • google_cloud_aiplatform_v1beta1_reasoning_engine_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngine) (defaults to: nil)
  • update_mask (String) (defaults to: nil)

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



19442
19443
19444
19445
19446
19447
19448
19449
19450
19451
19452
19453
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19442

def patch_project_location_reasoning_engine(name, google_cloud_aiplatform_v1beta1_reasoning_engine_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngine::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_reasoning_engine_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_schedule_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schedule

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_v1beta1_schedule_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schedule) (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



19862
19863
19864
19865
19866
19867
19868
19869
19870
19871
19872
19873
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19862

def patch_project_location_schedule(name, google_cloud_aiplatform_v1beta1_schedule_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schedule::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_schedule_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schedule::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schedule
  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_v1beta1_specialist_pool_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation

Updates a SpecialistPool.

Parameters:

  • name (String)

    Required. The resource name of the SpecialistPool.

  • google_cloud_aiplatform_v1beta1_specialist_pool_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SpecialistPool) (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



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

def patch_project_location_specialist_pool(name, google_cloud_aiplatform_v1beta1_specialist_pool_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SpecialistPool::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_specialist_pool_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_tensorboard_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation

Updates a Tensorboard.

Parameters:

  • name (String)

    Output only. Name of the Tensorboard. Format: projects/project/locations/ location/tensorboards/tensorboard``

  • google_cloud_aiplatform_v1beta1_tensorboard_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Tensorboard) (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



21698
21699
21700
21701
21702
21703
21704
21705
21706
21707
21708
21709
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21698

def patch_project_location_tensorboard(name, google_cloud_aiplatform_v1beta1_tensorboard_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Tensorboard::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_tensorboard_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_tensorboard_experiment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardExperiment

Updates a TensorboardExperiment.

Parameters:

  • name (String)

    Output only. Name of the TensorboardExperiment. Format: projects/project/ locations/location/tensorboards/tensorboard/experiments/experiment``

  • google_cloud_aiplatform_v1beta1_tensorboard_experiment_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardExperiment) (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



21993
21994
21995
21996
21997
21998
21999
22000
22001
22002
22003
22004
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21993

def patch_project_location_tensorboard_experiment(name, google_cloud_aiplatform_v1beta1_tensorboard_experiment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardExperiment::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_tensorboard_experiment_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardExperiment::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardExperiment
  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_v1beta1_tensorboard_run_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardRun

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_v1beta1_tensorboard_run_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardRun) (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



22445
22446
22447
22448
22449
22450
22451
22452
22453
22454
22455
22456
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22445

def patch_project_location_tensorboard_experiment_run(name, google_cloud_aiplatform_v1beta1_tensorboard_run_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardRun::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_tensorboard_run_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardRun::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardRun
  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_v1beta1_tensorboard_time_series_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardTimeSeries

Updates a TensorboardTimeSeries.

Parameters:

  • name (String)

    Output only. Name of the TensorboardTimeSeries.

  • google_cloud_aiplatform_v1beta1_tensorboard_time_series_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardTimeSeries) (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



22895
22896
22897
22898
22899
22900
22901
22902
22903
22904
22905
22906
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22895

def patch_project_location_tensorboard_experiment_run_time_series(name, google_cloud_aiplatform_v1beta1_tensorboard_time_series_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardTimeSeries::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_tensorboard_time_series_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardTimeSeries::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1TensorboardTimeSeries
  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_v1beta1_pause_model_deployment_monitoring_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_pause_model_deployment_monitoring_job_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PauseModelDeploymentMonitoringJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13610

def pause_project_location_model_deployment_monitoring_job(name, google_cloud_aiplatform_v1beta1_pause_model_deployment_monitoring_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:pause', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PauseModelDeploymentMonitoringJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_pause_model_deployment_monitoring_job_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_pause_schedule_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_pause_schedule_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PauseScheduleRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19899
19900
19901
19902
19903
19904
19905
19906
19907
19908
19909
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19899

def pause_project_location_schedule(name, google_cloud_aiplatform_v1beta1_pause_schedule_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:pause', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PauseScheduleRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_pause_schedule_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PredictResponse

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_v1beta1_predict_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def predict_project_location_endpoint(endpoint, google_cloud_aiplatform_v1beta1_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:predict', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PredictResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PredictResponse
  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_v1beta1_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PredictResponse

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_v1beta1_predict_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18490
18491
18492
18493
18494
18495
18496
18497
18498
18499
18500
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18490

def predict_project_location_publisher_model(endpoint, google_cloud_aiplatform_v1beta1_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:predict', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PredictResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PredictResponse
  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_v1beta1_purge_artifacts_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation

Purges Artifacts.

Parameters:

  • parent (String)

    Required. The metadata store to purge Artifacts from. Format: projects/ project/locations/location/metadataStores/metadatastore``

  • google_cloud_aiplatform_v1beta1_purge_artifacts_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PurgeArtifactsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11477

def (parent, google_cloud_aiplatform_v1beta1_purge_artifacts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/artifacts:purge', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PurgeArtifactsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_purge_artifacts_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_purge_contexts_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation

Purges Contexts.

Parameters:

  • parent (String)

    Required. The metadata store to purge Contexts from. Format: projects/ project/locations/location/metadataStores/metadatastore``

  • google_cloud_aiplatform_v1beta1_purge_contexts_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PurgeContextsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12050

def (parent, google_cloud_aiplatform_v1beta1_purge_contexts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/contexts:purge', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PurgeContextsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_purge_contexts_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_purge_executions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation

Purges Executions.

Parameters:

  • parent (String)

    Required. The metadata store to purge Executions from. Format: projects/ project/locations/location/metadataStores/metadatastore``

  • google_cloud_aiplatform_v1beta1_purge_executions_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PurgeExecutionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12595

def (parent, google_cloud_aiplatform_v1beta1_purge_executions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/executions:purge', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PurgeExecutionsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_purge_executions_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1QueryDeployedModelsResponse

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



3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3637

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, 'v1beta1/{+deploymentResourcePool}:queryDeployedModels', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1QueryDeployedModelsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1QueryDeployedModelsResponse
  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_extension(name, google_cloud_aiplatform_v1beta1_query_extension_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1QueryExtensionResponse

Queries an extension with a default controller.

Parameters:

  • name (String)

    Required. Name (identifier) of the extension; Format: projects/project/ locations/location/extensions/extension``

  • google_cloud_aiplatform_v1beta1_query_extension_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1QueryExtensionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5792

def query_project_location_extension(name, google_cloud_aiplatform_v1beta1_query_extension_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:query', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1QueryExtensionRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_query_extension_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1QueryExtensionResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1QueryExtensionResponse
  command.params['name'] = name unless name.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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LineageSubgraph

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



11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11536

def (artifact, filter: nil, max_hops: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+artifact}:queryArtifactLineageSubgraph', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LineageSubgraph::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LineageSubgraph
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LineageSubgraph

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



12088
12089
12090
12091
12092
12093
12094
12095
12096
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12088

def (context, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+context}:queryContextLineageSubgraph', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LineageSubgraph::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LineageSubgraph
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LineageSubgraph

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



12630
12631
12632
12633
12634
12635
12636
12637
12638
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12630

def (execution, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+execution}:queryExecutionInputsAndOutputs', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LineageSubgraph::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LineageSubgraph
  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_v1beta1_query_reasoning_engine_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse

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_v1beta1_query_reasoning_engine_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19477
19478
19479
19480
19481
19482
19483
19484
19485
19486
19487
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19477

def query_project_location_reasoning_engine(name, google_cloud_aiplatform_v1beta1_query_reasoning_engine_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:query', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_query_reasoning_engine_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse
  command.params['name'] = name unless name.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_v1beta1_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_raw_predict_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RawPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def raw_project_location_endpoint_predict(endpoint, google_cloud_aiplatform_v1beta1_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:rawPredict', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RawPredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_raw_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_raw_predict_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RawPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18527
18528
18529
18530
18531
18532
18533
18534
18535
18536
18537
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18527

def raw_project_location_publisher_model_predict(endpoint, google_cloud_aiplatform_v1beta1_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:rawPredict', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RawPredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_raw_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_read_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse

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_v1beta1_read_feature_values_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadFeatureValuesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8753

def read_project_location_featurestore_entity_type_feature_values(entity_type, google_cloud_aiplatform_v1beta1_read_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+entityType}:readFeatureValues', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadFeatureValuesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_read_feature_values_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse
  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_v1beta1_read_index_datapoints_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadIndexDatapointsResponse

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_v1beta1_read_index_datapoints_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadIndexDatapointsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10425

def read_project_location_index_endpoint_index_datapoints(index_endpoint, google_cloud_aiplatform_v1beta1_read_index_datapoints_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+indexEndpoint}:readIndexDatapoints', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadIndexDatapointsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_read_index_datapoints_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadIndexDatapointsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadIndexDatapointsResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadTensorboardTimeSeriesDataResponse

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



22938
22939
22940
22941
22942
22943
22944
22945
22946
22947
22948
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22938

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, 'v1beta1/{+tensorboardTimeSeries}:read', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadTensorboardTimeSeriesDataResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadTensorboardTimeSeriesDataResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadTensorboardBlobDataResponse

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



22976
22977
22978
22979
22980
22981
22982
22983
22984
22985
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22976

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, 'v1beta1/{+timeSeries}:readBlobData', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadTensorboardBlobDataResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadTensorboardBlobDataResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadTensorboardSizeResponse

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



21732
21733
21734
21735
21736
21737
21738
21739
21740
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21732

def read_project_location_tensorboard_size(tensorboard, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+tensorboard}:readSize', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadTensorboardSizeResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadTensorboardSizeResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponse

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



21763
21764
21765
21766
21767
21768
21769
21770
21771
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21763

def read_project_location_tensorboard_usage(tensorboard, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+tensorboard}:readUsage', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponse
  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

#reboot_project_location_persistent_resource(name, google_cloud_aiplatform_v1beta1_reboot_persistent_resource_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_reboot_persistent_resource_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RebootPersistentResourceRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17654
17655
17656
17657
17658
17659
17660
17661
17662
17663
17664
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17654

def reboot_project_location_persistent_resource(name, google_cloud_aiplatform_v1beta1_reboot_persistent_resource_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:reboot', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RebootPersistentResourceRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_reboot_persistent_resource_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_remove_datapoints_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RemoveDatapointsResponse

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_v1beta1_remove_datapoints_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RemoveDatapointsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10856

def remove_project_location_index_datapoints(index, google_cloud_aiplatform_v1beta1_remove_datapoints_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+index}:removeDatapoints', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RemoveDatapointsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_remove_datapoints_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RemoveDatapointsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RemoveDatapointsResponse
  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_v1beta1_remove_context_children_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RemoveContextChildrenResponse

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_v1beta1_remove_context_children_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12121

def (context, google_cloud_aiplatform_v1beta1_remove_context_children_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+context}:removeContextChildren', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_remove_context_children_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RemoveContextChildrenResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RemoveContextChildrenResponse
  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

#report_project_location_notebook_execution_job_event(name, google_cloud_aiplatform_v1beta1_report_execution_event_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReportExecutionEventResponse

Parameters:

  • name (String)

    Required. The name of the NotebookExecutionJob resource. Format: projects/ project/locations/location/notebookExecutionJobs/notebook_execution_jobs``

  • google_cloud_aiplatform_v1beta1_report_execution_event_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReportExecutionEventRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



16071
16072
16073
16074
16075
16076
16077
16078
16079
16080
16081
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16071

def report_project_location_notebook_execution_job_event(name, google_cloud_aiplatform_v1beta1_report_execution_event_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:reportEvent', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReportExecutionEventRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_report_execution_event_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReportExecutionEventResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReportExecutionEventResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#report_project_location_notebook_runtime_event(name, google_cloud_aiplatform_v1beta1_report_runtime_event_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReportRuntimeEventResponse

Parameters:

  • name (String)

    Required. The name of the NotebookRuntime resource. Format: projects/project /locations/location/notebookRuntimes/notebook_runtime``

  • google_cloud_aiplatform_v1beta1_report_runtime_event_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17003
17004
17005
17006
17007
17008
17009
17010
17011
17012
17013
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17003

def report_project_location_notebook_runtime_event(name, google_cloud_aiplatform_v1beta1_report_runtime_event_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:reportEvent', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_report_runtime_event_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReportRuntimeEventResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReportRuntimeEventResponse
  command.params['name'] = name unless name.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::AiplatformV1beta1::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



3014
3015
3016
3017
3018
3019
3020
3021
3022
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3014

def restore_project_location_dataset_dataset_version(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}:restore', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_resume_model_deployment_monitoring_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_resume_model_deployment_monitoring_job_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ResumeModelDeploymentMonitoringJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13646

def resume_project_location_model_deployment_monitoring_job(name, google_cloud_aiplatform_v1beta1_resume_model_deployment_monitoring_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:resume', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ResumeModelDeploymentMonitoringJobRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_resume_model_deployment_monitoring_job_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_resume_schedule_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty

Resumes a paused Schedule to start scheduling new runs. Will mark Schedule. state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catchUp is set up true, all missed runs will be scheduled for backfill first.

Parameters:

  • name (String)

    Required. The name of the Schedule resource to be resumed. Format: projects/ project/locations/location/schedules/schedule``

  • google_cloud_aiplatform_v1beta1_resume_schedule_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ResumeScheduleRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



19938
19939
19940
19941
19942
19943
19944
19945
19946
19947
19948
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19938

def resume_project_location_schedule(name, google_cloud_aiplatform_v1beta1_resume_schedule_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:resume', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ResumeScheduleRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_resume_schedule_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_retrieve_contexts_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RetrieveContextsResponse

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_v1beta1_retrieve_contexts_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RetrieveContextsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



293
294
295
296
297
298
299
300
301
302
303
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 293

def retrieve_project_location_contexts(parent, google_cloud_aiplatform_v1beta1_retrieve_contexts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}:retrieveContexts', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RetrieveContextsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_retrieve_contexts_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RetrieveContextsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RetrieveContextsResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchDataItemsResponse

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



2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2107

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, 'v1beta1/{+dataset}:searchDataItems', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchDataItemsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchDataItemsResponse
  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_v1beta1_search_nearest_entities_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchNearestEntitiesResponse

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_v1beta1_search_nearest_entities_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7360

def search_project_location_feature_online_store_feature_view_nearest_entities(feature_view, google_cloud_aiplatform_v1beta1_search_nearest_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+featureView}:searchNearestEntities', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_search_nearest_entities_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchNearestEntitiesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchNearestEntitiesResponse
  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::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchFeaturesResponse

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



8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8248

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, 'v1beta1/{+location}/featurestores:searchFeatures', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchFeaturesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchFeaturesResponse
  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_v1beta1_search_migratable_resources_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchMigratableResourcesResponse

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_v1beta1_search_migratable_resources_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchMigratableResourcesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13186

def search_project_location_migratable_resources(parent, google_cloud_aiplatform_v1beta1_search_migratable_resources_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/migratableResources:search', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchMigratableResourcesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_search_migratable_resources_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchMigratableResourcesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchMigratableResourcesResponse
  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_v1beta1_search_model_deployment_monitoring_stats_anomalies_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesResponse

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_v1beta1_search_model_deployment_monitoring_stats_anomalies_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



13681
13682
13683
13684
13685
13686
13687
13688
13689
13690
13691
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13681

def search_project_location_model_deployment_monitoring_job_model_deployment_monitoring_stats_anomalies(model_deployment_monitoring_job, google_cloud_aiplatform_v1beta1_search_model_deployment_monitoring_stats_anomalies_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_search_model_deployment_monitoring_stats_anomalies_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesResponse
  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

#search_project_location_model_monitor_model_monitoring_alerts(model_monitor, google_cloud_aiplatform_v1beta1_search_model_monitoring_alerts_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsResponse

Returns the Model Monitoring alerts.

Parameters:

  • model_monitor (String)

    Required. ModelMonitor resource name. Format: projects/project/locations/ location/modelMonitors/model_monitor``

  • google_cloud_aiplatform_v1beta1_search_model_monitoring_alerts_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14082
14083
14084
14085
14086
14087
14088
14089
14090
14091
14092
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14082

def search_project_location_model_monitor_model_monitoring_alerts(model_monitor, google_cloud_aiplatform_v1beta1_search_model_monitoring_alerts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+modelMonitor}:searchModelMonitoringAlerts', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_search_model_monitoring_alerts_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsResponse
  command.params['modelMonitor'] = model_monitor unless model_monitor.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_monitor_model_monitoring_stats(model_monitor, google_cloud_aiplatform_v1beta1_search_model_monitoring_stats_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsResponse

Searches Model Monitoring Stats generated within a given time window.

Parameters:

  • model_monitor (String)

    Required. ModelMonitor resource name. Format: projects/project/locations/ location/modelMonitors/model_monitor``

  • google_cloud_aiplatform_v1beta1_search_model_monitoring_stats_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14116

def search_project_location_model_monitor_model_monitoring_stats(model_monitor, google_cloud_aiplatform_v1beta1_search_model_monitoring_stats_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+modelMonitor}:searchModelMonitoringStats', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_search_model_monitoring_stats_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsResponse
  command.params['modelMonitor'] = model_monitor unless model_monitor.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_v1beta1_streaming_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamingPredictResponse

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_v1beta1_streaming_predict_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamingPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 4632

def server_project_location_endpoint_streaming_predict(endpoint, google_cloud_aiplatform_v1beta1_streaming_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:serverStreamingPredict', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamingPredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_streaming_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamingPredictResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamingPredictResponse
  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_v1beta1_streaming_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamingPredictResponse

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_v1beta1_streaming_predict_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamingPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def server_project_location_publisher_model_streaming_predict(endpoint, google_cloud_aiplatform_v1beta1_streaming_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:serverStreamingPredict', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamingPredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_streaming_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamingPredictResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamingPredictResponse
  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_endpoint_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



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

def set_project_location_endpoint_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, 'v1beta1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1SetIamPolicyRequest::Representation
  command.request_object = google_iam_v1_set_iam_policy_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_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::AiplatformV1beta1::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::AiplatformV1beta1::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



7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7397

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, 'v1beta1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1SetIamPolicyRequest::Representation
  command.request_object = google_iam_v1_set_iam_policy_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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::AiplatformV1beta1::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



6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6992

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, 'v1beta1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1SetIamPolicyRequest::Representation
  command.request_object = google_iam_v1_set_iam_policy_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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::AiplatformV1beta1::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



8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8790

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, 'v1beta1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1SetIamPolicyRequest::Representation
  command.request_object = google_iam_v1_set_iam_policy_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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::AiplatformV1beta1::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



8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8286

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, 'v1beta1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1SetIamPolicyRequest::Representation
  command.request_object = google_iam_v1_set_iam_policy_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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::AiplatformV1beta1::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



14886
14887
14888
14889
14890
14891
14892
14893
14894
14895
14896
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14886

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, 'v1beta1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1SetIamPolicyRequest::Representation
  command.request_object = google_iam_v1_set_iam_policy_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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::AiplatformV1beta1::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



16536
16537
16538
16539
16540
16541
16542
16543
16544
16545
16546
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16536

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, 'v1beta1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1SetIamPolicyRequest::Representation
  command.request_object = google_iam_v1_set_iam_policy_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_start_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_start_notebook_runtime_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StartNotebookRuntimeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17039
17040
17041
17042
17043
17044
17045
17046
17047
17048
17049
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17039

def start_project_location_notebook_runtime(name, google_cloud_aiplatform_v1beta1_start_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:start', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StartNotebookRuntimeRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_start_notebook_runtime_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_stop_trial_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial

Stops a Trial.

Parameters:

  • name (String)

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

  • google_cloud_aiplatform_v1beta1_stop_trial_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StopTrialRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



21249
21250
21251
21252
21253
21254
21255
21256
21257
21258
21259
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21249

def stop_project_location_study_trial(name, google_cloud_aiplatform_v1beta1_stop_trial_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:stop', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StopTrialRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_stop_trial_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Trial
  command.params['name'] = name unless name.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_v1beta1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentResponse

Generate content with multimodal inputs with streaming support.

Parameters:

  • model (String)

    Required. The name of the publisher model requested to serve the prediction. Format: projects/project/locations/location/publishers/*/models/*

  • google_cloud_aiplatform_v1beta1_generate_content_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def stream_project_location_endpoint_generate_content(model, google_cloud_aiplatform_v1beta1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+model}:streamGenerateContent', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_generate_content_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentResponse
  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_v1beta1_stream_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_stream_raw_predict_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamRawPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 4737

def stream_project_location_endpoint_raw_predict(endpoint, google_cloud_aiplatform_v1beta1_stream_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:streamRawPredict', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamRawPredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_stream_raw_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentResponse

Generate content with multimodal inputs with streaming support.

Parameters:

  • model (String)

    Required. The name of the publisher model requested to serve the prediction. Format: projects/project/locations/location/publishers/*/models/*

  • google_cloud_aiplatform_v1beta1_generate_content_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def stream_project_location_publisher_model_generate_content(model, google_cloud_aiplatform_v1beta1_generate_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+model}:streamGenerateContent', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_generate_content_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerateContentResponse
  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_v1beta1_stream_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_stream_raw_predict_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamRawPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



18630
18631
18632
18633
18634
18635
18636
18637
18638
18639
18640
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18630

def stream_project_location_publisher_model_raw_predict(endpoint, google_cloud_aiplatform_v1beta1_stream_raw_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:streamRawPredict', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamRawPredictRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_stream_raw_predict_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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

#streaming_project_location_feature_online_store_feature_view_fetch_feature_values(feature_view, google_cloud_aiplatform_v1beta1_streaming_fetch_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesResponse

Bidirectional streaming RPC to fetch feature values under a FeatureView. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.

Parameters:

  • feature_view (String)

    Required. FeatureView resource format projects/project/locations/location/ featureOnlineStores/featureOnlineStore/featureViews/featureView``

  • google_cloud_aiplatform_v1beta1_streaming_fetch_feature_values_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7433

def streaming_project_location_feature_online_store_feature_view_fetch_feature_values(feature_view, google_cloud_aiplatform_v1beta1_streaming_fetch_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+featureView}:streamingFetchFeatureValues', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_streaming_fetch_feature_values_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesResponse
  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

#streaming_project_location_featurestore_entity_type_read_feature_values(entity_type, google_cloud_aiplatform_v1beta1_streaming_read_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse

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_v1beta1_streaming_read_feature_values_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamingReadFeatureValuesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8827

def streaming_project_location_featurestore_entity_type_read_feature_values(entity_type, google_cloud_aiplatform_v1beta1_streaming_read_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+entityType}:streamingReadFeatureValues', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1StreamingReadFeatureValuesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_streaming_read_feature_values_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse
  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_v1beta1_suggest_trials_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_suggest_trials_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SuggestTrialsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



21286
21287
21288
21289
21290
21291
21292
21293
21294
21295
21296
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21286

def suggest_project_location_study_trial(parent, google_cloud_aiplatform_v1beta1_suggest_trials_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/trials:suggest', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SuggestTrialsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_suggest_trials_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_sync_feature_view_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SyncFeatureViewResponse

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_v1beta1_sync_feature_view_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SyncFeatureViewRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7467

def sync_project_location_feature_online_store_feature_view(feature_view, google_cloud_aiplatform_v1beta1_sync_feature_view_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+featureView}:sync', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SyncFeatureViewRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_sync_feature_view_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SyncFeatureViewResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SyncFeatureViewResponse
  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_endpoint_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 4779

def test_project_location_endpoint_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_feature_view_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7509

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, 'v1beta1/{+resource}:testIamPermissions', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7034

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, 'v1beta1/{+resource}:testIamPermissions', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8869

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, 'v1beta1/{+resource}:testIamPermissions', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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.

  • google_iam_v1_test_iam_permissions_request_object (Google::Apis::AiplatformV1beta1::GoogleIamV1TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8325

def test_project_location_featurestore_iam_permissions(resource, google_iam_v1_test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1TestIamPermissionsRequest::Representation
  command.request_object = google_iam_v1_test_iam_permissions_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleIamV1TestIamPermissionsResponse
  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

#test_project_location_model_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14928

def test_project_location_model_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



16578
16579
16580
16581
16582
16583
16584
16585
16586
16587
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16578

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, 'v1beta1/{+resource}:testIamPermissions', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_undeploy_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_undeploy_model_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UndeployModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



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

def undeploy_project_location_endpoint_model(endpoint, google_cloud_aiplatform_v1beta1_undeploy_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+endpoint}:undeployModel', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UndeployModelRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_undeploy_model_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_undeploy_index_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_undeploy_index_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UndeployIndexRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10461

def undeploy_project_location_index_endpoint_index(index_endpoint, google_cloud_aiplatform_v1beta1_undeploy_index_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+indexEndpoint}:undeployIndex', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UndeployIndexRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_undeploy_index_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_cache_config_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation

Updates a cache config.

Parameters:

  • name (String)

    Identifier. Name of the cache config. Format: - projects/project/ cacheConfig.

  • google_cloud_aiplatform_v1beta1_cache_config_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CacheConfig) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



151
152
153
154
155
156
157
158
159
160
161
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 151

def update_project_cache_config(name, google_cloud_aiplatform_v1beta1_cache_config_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CacheConfig::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_cache_config_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_update_explanation_dataset_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_update_explanation_dataset_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UpdateExplanationDatasetRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14961
14962
14963
14964
14965
14966
14967
14968
14969
14970
14971
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14961

def update_project_location_model_explanation_dataset(model, google_cloud_aiplatform_v1beta1_update_explanation_dataset_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+model}:updateExplanationDataset', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UpdateExplanationDatasetRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_update_explanation_dataset_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_upgrade_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_upgrade_notebook_runtime_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UpgradeNotebookRuntimeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



17075
17076
17077
17078
17079
17080
17081
17082
17083
17084
17085
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17075

def upgrade_project_location_notebook_runtime(name, google_cloud_aiplatform_v1beta1_upgrade_notebook_runtime_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:upgrade', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UpgradeNotebookRuntimeRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_upgrade_notebook_runtime_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_upload_rag_file_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UploadRagFileResponse

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_v1beta1_upload_rag_file_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UploadRagFileRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available 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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 81

def upload_medium(parent, google_cloud_aiplatform_v1beta1_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, 'v1beta1/{+parent}/ragFiles:upload', options)
  else
    command = make_upload_command(:post, 'v1beta1/{+parent}/ragFiles:upload', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UploadRagFileRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_upload_rag_file_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UploadRagFileResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UploadRagFileResponse
  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_v1beta1_upload_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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_v1beta1_upload_model_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UploadModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



14995
14996
14997
14998
14999
15000
15001
15002
15003
15004
15005
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14995

def upload_project_location_model(parent, google_cloud_aiplatform_v1beta1_upload_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/models:upload', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UploadModelRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_upload_model_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_upsert_datapoints_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UpsertDatapointsResponse

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_v1beta1_upsert_datapoints_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UpsertDatapointsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10890

def upsert_project_location_index_datapoints(index, google_cloud_aiplatform_v1beta1_upsert_datapoints_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+index}:upsertDatapoints', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UpsertDatapointsRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_upsert_datapoints_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UpsertDatapointsResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UpsertDatapointsResponse
  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_agent_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



477
478
479
480
481
482
483
484
485
486
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 477

def wait_project_location_agent_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_app_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



660
661
662
663
664
665
666
667
668
669
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 660

def wait_project_location_app_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_custom_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1398

def wait_project_location_custom_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 1769

def wait_project_location_data_labeling_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2336

def wait_project_location_dataset_annotation_spec_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2614

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, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 2797

def wait_project_location_dataset_data_item_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3196

def wait_project_location_dataset_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 3457

def wait_project_location_dataset_saved_query_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



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

def wait_project_location_deployment_resource_pool_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_edge_device_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



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

def wait_project_location_edge_device_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5031

def wait_project_location_endpoint_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_evaluation_task_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5177

def wait_project_location_evaluation_task_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_example_store_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5360

def wait_project_location_example_store_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_extension_controller_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5543

def wait_project_location_extension_controller_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_extension_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 5976

def wait_project_location_extension_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6556

def wait_project_location_feature_group_feature_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 6702

def wait_project_location_feature_group_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 7742

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, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



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

def wait_project_location_feature_online_store_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9355

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, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9538

def wait_project_location_featurestore_entity_type_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 9721

def wait_project_location_featurestore_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10099

def wait_project_location_hyperparameter_tuning_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 10645

def wait_project_location_index_endpoint_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11074

def wait_project_location_index_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 11720

def (name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12305

def (name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 12812

def (name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13115

def (name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13370

def wait_project_location_migratable_resource_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



13865
13866
13867
13868
13869
13870
13871
13872
13873
13874
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 13865

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, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



15289
15290
15291
15292
15293
15294
15295
15296
15297
15298
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15289

def wait_project_location_model_evaluation_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_monitor_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::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



14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 14451

def wait_project_location_model_monitor_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



15585
15586
15587
15588
15589
15590
15591
15592
15593
15594
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 15585

def wait_project_location_model_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



16255
16256
16257
16258
16259
16260
16261
16262
16263
16264
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16255

def wait_project_location_notebook_execution_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



17259
17260
17261
17262
17263
17264
17265
17266
17267
17268
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17259

def wait_project_location_notebook_runtime_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



16761
16762
16763
16764
16765
16766
16767
16768
16769
16770
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 16761

def wait_project_location_notebook_runtime_template_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



17442
17443
17444
17445
17446
17447
17448
17449
17450
17451
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17442

def wait_project_location_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



17838
17839
17840
17841
17842
17843
17844
17845
17846
17847
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 17838

def wait_project_location_persistent_resource_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



18310
18311
18312
18313
18314
18315
18316
18317
18318
18319
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18310

def wait_project_location_pipeline_job_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



18953
18954
18955
18956
18957
18958
18959
18960
18961
18962
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 18953

def wait_project_location_rag_corpora_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



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

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, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



19661
19662
19663
19664
19665
19666
19667
19668
19669
19670
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 19661

def wait_project_location_reasoning_engine_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



20122
20123
20124
20125
20126
20127
20128
20129
20130
20131
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20122

def wait_project_location_schedule_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



20588
20589
20590
20591
20592
20593
20594
20595
20596
20597
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20588

def wait_project_location_specialist_pool_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 20941

def wait_project_location_study_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



21470
21471
21472
21473
21474
21475
21476
21477
21478
21479
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 21470

def wait_project_location_study_trial_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



22214
22215
22216
22217
22218
22219
22220
22221
22222
22223
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22214

def wait_project_location_tensorboard_experiment_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



22666
22667
22668
22669
22670
22671
22672
22673
22674
22675
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22666

def wait_project_location_tensorboard_experiment_run_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



23159
23160
23161
23162
23163
23164
23165
23166
23167
23168
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23159

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, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



23342
23343
23344
23345
23346
23347
23348
23349
23350
23351
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23342

def wait_project_location_tensorboard_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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::AiplatformV1beta1::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



23718
23719
23720
23721
23722
23723
23724
23725
23726
23727
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 23718

def wait_project_location_training_pipeline_operation(name, timeout: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:wait', options)
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::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_v1beta1_write_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1WriteFeatureValuesResponse

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_v1beta1_write_feature_values_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1WriteFeatureValuesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 8906

def write_project_location_featurestore_entity_type_feature_values(entity_type, google_cloud_aiplatform_v1beta1_write_feature_values_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+entityType}:writeFeatureValues', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1WriteFeatureValuesRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_write_feature_values_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1WriteFeatureValuesResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1WriteFeatureValuesResponse
  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_v1beta1_write_tensorboard_experiment_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataResponse

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_v1beta1_write_tensorboard_experiment_data_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



22030
22031
22032
22033
22034
22035
22036
22037
22038
22039
22040
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22030

def write_project_location_tensorboard_experiment(tensorboard_experiment, google_cloud_aiplatform_v1beta1_write_tensorboard_experiment_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+tensorboardExperiment}:write', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_write_tensorboard_experiment_data_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataResponse
  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_v1beta1_write_tensorboard_run_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1WriteTensorboardRunDataResponse

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_v1beta1_write_tensorboard_run_data_request_object (Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1WriteTensorboardRunDataRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

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

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required



22482
22483
22484
22485
22486
22487
22488
22489
22490
22491
22492
# File 'lib/google/apis/aiplatform_v1beta1/service.rb', line 22482

def write_project_location_tensorboard_experiment_run(tensorboard_run, google_cloud_aiplatform_v1beta1_write_tensorboard_run_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+tensorboardRun}:write', options)
  command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1WriteTensorboardRunDataRequest::Representation
  command.request_object = google_cloud_aiplatform_v1beta1_write_tensorboard_run_data_request_object
  command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1WriteTensorboardRunDataResponse::Representation
  command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1WriteTensorboardRunDataResponse
  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