google-apis-aiplatform_v1 0.18.0 → 0.20.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -18773,6 +18773,154 @@ module Google
18773
18773
  execute_or_queue_command(command, &block)
18774
18774
  end
18775
18775
 
18776
+ # Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The
18777
+ # server makes a best effort to cancel the job, but success is not guaranteed.
18778
+ # Clients can use GenAiTuningService.GetTuningJob or other methods to check
18779
+ # whether the cancellation succeeded or whether the job completed despite
18780
+ # cancellation. On successful cancellation, the TuningJob is not deleted;
18781
+ # instead it becomes a job with a TuningJob.error value with a google.rpc.Status.
18782
+ # code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `
18783
+ # CANCELLED`.
18784
+ # @param [String] name
18785
+ # Required. The name of the TuningJob to cancel. Format: `projects/`project`/
18786
+ # locations/`location`/tuningJobs/`tuning_job``
18787
+ # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelTuningJobRequest] google_cloud_aiplatform_v1_cancel_tuning_job_request_object
18788
+ # @param [String] fields
18789
+ # Selector specifying which fields to include in a partial response.
18790
+ # @param [String] quota_user
18791
+ # Available to use for quota purposes for server-side applications. Can be any
18792
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
18793
+ # @param [Google::Apis::RequestOptions] options
18794
+ # Request-specific options
18795
+ #
18796
+ # @yield [result, err] Result & error if block supplied
18797
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleProtobufEmpty] parsed result object
18798
+ # @yieldparam err [StandardError] error object if request failed
18799
+ #
18800
+ # @return [Google::Apis::AiplatformV1::GoogleProtobufEmpty]
18801
+ #
18802
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
18803
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
18804
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
18805
+ def cancel_project_location_tuning_job(name, google_cloud_aiplatform_v1_cancel_tuning_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
18806
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
18807
+ command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelTuningJobRequest::Representation
18808
+ command.request_object = google_cloud_aiplatform_v1_cancel_tuning_job_request_object
18809
+ command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
18810
+ command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
18811
+ command.params['name'] = name unless name.nil?
18812
+ command.query['fields'] = fields unless fields.nil?
18813
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
18814
+ execute_or_queue_command(command, &block)
18815
+ end
18816
+
18817
+ # Creates a TuningJob. A created TuningJob right away will be attempted to be
18818
+ # run.
18819
+ # @param [String] parent
18820
+ # Required. The resource name of the Location to create the TuningJob in. Format:
18821
+ # `projects/`project`/locations/`location``
18822
+ # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob] google_cloud_aiplatform_v1_tuning_job_object
18823
+ # @param [String] fields
18824
+ # Selector specifying which fields to include in a partial response.
18825
+ # @param [String] quota_user
18826
+ # Available to use for quota purposes for server-side applications. Can be any
18827
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
18828
+ # @param [Google::Apis::RequestOptions] options
18829
+ # Request-specific options
18830
+ #
18831
+ # @yield [result, err] Result & error if block supplied
18832
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob] parsed result object
18833
+ # @yieldparam err [StandardError] error object if request failed
18834
+ #
18835
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob]
18836
+ #
18837
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
18838
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
18839
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
18840
+ def create_project_location_tuning_job(parent, google_cloud_aiplatform_v1_tuning_job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
18841
+ command = make_simple_command(:post, 'v1/{+parent}/tuningJobs', options)
18842
+ command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob::Representation
18843
+ command.request_object = google_cloud_aiplatform_v1_tuning_job_object
18844
+ command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob::Representation
18845
+ command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob
18846
+ command.params['parent'] = parent unless parent.nil?
18847
+ command.query['fields'] = fields unless fields.nil?
18848
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
18849
+ execute_or_queue_command(command, &block)
18850
+ end
18851
+
18852
+ # Gets a TuningJob.
18853
+ # @param [String] name
18854
+ # Required. The name of the TuningJob resource. Format: `projects/`project`/
18855
+ # locations/`location`/tuningJobs/`tuning_job``
18856
+ # @param [String] fields
18857
+ # Selector specifying which fields to include in a partial response.
18858
+ # @param [String] quota_user
18859
+ # Available to use for quota purposes for server-side applications. Can be any
18860
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
18861
+ # @param [Google::Apis::RequestOptions] options
18862
+ # Request-specific options
18863
+ #
18864
+ # @yield [result, err] Result & error if block supplied
18865
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob] parsed result object
18866
+ # @yieldparam err [StandardError] error object if request failed
18867
+ #
18868
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob]
18869
+ #
18870
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
18871
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
18872
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
18873
+ def get_project_location_tuning_job(name, fields: nil, quota_user: nil, options: nil, &block)
18874
+ command = make_simple_command(:get, 'v1/{+name}', options)
18875
+ command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob::Representation
18876
+ command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1TuningJob
18877
+ command.params['name'] = name unless name.nil?
18878
+ command.query['fields'] = fields unless fields.nil?
18879
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
18880
+ execute_or_queue_command(command, &block)
18881
+ end
18882
+
18883
+ # Lists TuningJobs in a Location.
18884
+ # @param [String] parent
18885
+ # Required. The resource name of the Location to list the TuningJobs from.
18886
+ # Format: `projects/`project`/locations/`location``
18887
+ # @param [String] filter
18888
+ # Optional. The standard list filter.
18889
+ # @param [Fixnum] page_size
18890
+ # Optional. The standard list page size.
18891
+ # @param [String] page_token
18892
+ # Optional. The standard list page token. Typically obtained via ListTuningJob.
18893
+ # next_page_token of the previous GenAiTuningService.ListTuningJob][] call.
18894
+ # @param [String] fields
18895
+ # Selector specifying which fields to include in a partial response.
18896
+ # @param [String] quota_user
18897
+ # Available to use for quota purposes for server-side applications. Can be any
18898
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
18899
+ # @param [Google::Apis::RequestOptions] options
18900
+ # Request-specific options
18901
+ #
18902
+ # @yield [result, err] Result & error if block supplied
18903
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTuningJobsResponse] parsed result object
18904
+ # @yieldparam err [StandardError] error object if request failed
18905
+ #
18906
+ # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTuningJobsResponse]
18907
+ #
18908
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
18909
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
18910
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
18911
+ def list_project_location_tuning_jobs(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
18912
+ command = make_simple_command(:get, 'v1/{+parent}/tuningJobs', options)
18913
+ command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTuningJobsResponse::Representation
18914
+ command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListTuningJobsResponse
18915
+ command.params['parent'] = parent unless parent.nil?
18916
+ command.query['filter'] = filter unless filter.nil?
18917
+ command.query['pageSize'] = page_size unless page_size.nil?
18918
+ command.query['pageToken'] = page_token unless page_token.nil?
18919
+ command.query['fields'] = fields unless fields.nil?
18920
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
18921
+ execute_or_queue_command(command, &block)
18922
+ end
18923
+
18776
18924
  # Starts asynchronous cancellation on a long-running operation. The server makes
18777
18925
  # a best effort to cancel the operation, but success is not guaranteed. If the
18778
18926
  # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
@@ -18841,6 +18989,46 @@ module Google
18841
18989
  execute_or_queue_command(command, &block)
18842
18990
  end
18843
18991
 
18992
+ # Lists operations that match the specified filter in the request. If the server
18993
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
18994
+ # @param [String] name
18995
+ # The name of the operation's parent resource.
18996
+ # @param [String] filter
18997
+ # The standard list filter.
18998
+ # @param [Fixnum] page_size
18999
+ # The standard list page size.
19000
+ # @param [String] page_token
19001
+ # The standard list page token.
19002
+ # @param [String] fields
19003
+ # Selector specifying which fields to include in a partial response.
19004
+ # @param [String] quota_user
19005
+ # Available to use for quota purposes for server-side applications. Can be any
19006
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
19007
+ # @param [Google::Apis::RequestOptions] options
19008
+ # Request-specific options
19009
+ #
19010
+ # @yield [result, err] Result & error if block supplied
19011
+ # @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse] parsed result object
19012
+ # @yieldparam err [StandardError] error object if request failed
19013
+ #
19014
+ # @return [Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse]
19015
+ #
19016
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
19017
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
19018
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
19019
+ def list_project_location_tuning_job_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
19020
+ command = make_simple_command(:get, 'v1/{+name}/operations', options)
19021
+ command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse::Representation
19022
+ command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningListOperationsResponse
19023
+ command.params['name'] = name unless name.nil?
19024
+ command.query['filter'] = filter unless filter.nil?
19025
+ command.query['pageSize'] = page_size unless page_size.nil?
19026
+ command.query['pageToken'] = page_token unless page_token.nil?
19027
+ command.query['fields'] = fields unless fields.nil?
19028
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
19029
+ execute_or_queue_command(command, &block)
19030
+ end
19031
+
18844
19032
  # Gets a Model Garden publisher model.
18845
19033
  # @param [String] name
18846
19034
  # Required. The name of the PublisherModel resource. Format: `publishers/`
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-aiplatform_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.18.0
4
+ version: 0.20.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-03-24 00:00:00.000000000 Z
11
+ date: 2024-04-07 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-aiplatform_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-aiplatform_v1/v0.18.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-aiplatform_v1/v0.20.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-aiplatform_v1
63
63
  post_install_message:
64
64
  rdoc_options: []