google-cloud-ai_platform-v1 0.44.0 → 0.46.0

data/lib/google/cloud/ai_platform/v1/notebook_service/rest/client.rb

@@ -1269,6 +1269,384 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Creates a NotebookExecutionJob.
+              #
+              # @overload create_notebook_execution_job(request, options = nil)
+              #   Pass arguments to `create_notebook_execution_job` via a request object, either of type
+              #   {::Google::Cloud::AIPlatform::V1::CreateNotebookExecutionJobRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::AIPlatform::V1::CreateNotebookExecutionJobRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @overload create_notebook_execution_job(parent: nil, notebook_execution_job: nil, notebook_execution_job_id: nil)
+              #   Pass arguments to `create_notebook_execution_job` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param parent [::String]
+              #     Required. The resource name of the Location to create the
+              #     NotebookExecutionJob. Format: `projects/{project}/locations/{location}`
+              #   @param notebook_execution_job [::Google::Cloud::AIPlatform::V1::NotebookExecutionJob, ::Hash]
+              #     Required. The NotebookExecutionJob to create.
+              #   @param notebook_execution_job_id [::String]
+              #     Optional. User specified ID for the NotebookExecutionJob.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Gapic::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Gapic::Operation]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/ai_platform/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AIPlatform::V1::NotebookService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AIPlatform::V1::CreateNotebookExecutionJobRequest.new
+              #
+              #   # Call the create_notebook_execution_job method.
+              #   result = client.create_notebook_execution_job request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
+              def create_notebook_execution_job request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CreateNotebookExecutionJobRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                call_metadata = @config.rpcs.create_notebook_execution_job.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.create_notebook_execution_job.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.create_notebook_execution_job.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @notebook_service_stub.create_notebook_execution_job request, options do |result, operation|
+                  result = ::Gapic::Operation.new result, @operations_client, options: options
+                  yield result, operation if block_given?
+                  return result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Gets a NotebookExecutionJob.
+              #
+              # @overload get_notebook_execution_job(request, options = nil)
+              #   Pass arguments to `get_notebook_execution_job` via a request object, either of type
+              #   {::Google::Cloud::AIPlatform::V1::GetNotebookExecutionJobRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::AIPlatform::V1::GetNotebookExecutionJobRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @overload get_notebook_execution_job(name: nil, view: nil)
+              #   Pass arguments to `get_notebook_execution_job` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param name [::String]
+              #     Required. The name of the NotebookExecutionJob resource.
+              #   @param view [::Google::Cloud::AIPlatform::V1::NotebookExecutionJobView]
+              #     Optional. The NotebookExecutionJob view. Defaults to BASIC.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::AIPlatform::V1::NotebookExecutionJob]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::AIPlatform::V1::NotebookExecutionJob]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/ai_platform/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AIPlatform::V1::NotebookService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AIPlatform::V1::GetNotebookExecutionJobRequest.new
+              #
+              #   # Call the get_notebook_execution_job method.
+              #   result = client.get_notebook_execution_job request
+              #
+              #   # The returned object is of type Google::Cloud::AIPlatform::V1::NotebookExecutionJob.
+              #   p result
+              #
+              def get_notebook_execution_job request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::GetNotebookExecutionJobRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                call_metadata = @config.rpcs.get_notebook_execution_job.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.get_notebook_execution_job.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.get_notebook_execution_job.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @notebook_service_stub.get_notebook_execution_job request, options do |result, operation|
+                  yield result, operation if block_given?
+                  return result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Lists NotebookExecutionJobs in a Location.
+              #
+              # @overload list_notebook_execution_jobs(request, options = nil)
+              #   Pass arguments to `list_notebook_execution_jobs` via a request object, either of type
+              #   {::Google::Cloud::AIPlatform::V1::ListNotebookExecutionJobsRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::AIPlatform::V1::ListNotebookExecutionJobsRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @overload list_notebook_execution_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, order_by: nil, view: nil)
+              #   Pass arguments to `list_notebook_execution_jobs` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param parent [::String]
+              #     Required. The resource name of the Location from which to list the
+              #     NotebookExecutionJobs.
+              #     Format: `projects/{project}/locations/{location}`
+              #   @param filter [::String]
+              #     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"`
+              #   @param page_size [::Integer]
+              #     Optional. The standard list page size.
+              #   @param page_token [::String]
+              #     Optional. The standard list page token.
+              #     Typically obtained via
+              #     [ListNotebookExecutionJobs.next_page_token][] of the previous
+              #     {::Google::Cloud::AIPlatform::V1::NotebookService::Rest::Client#list_notebook_execution_jobs NotebookService.ListNotebookExecutionJobs}
+              #     call.
+              #   @param order_by [::String]
+              #     Optional. A comma-separated list of fields to order by, sorted in ascending
+              #     order. Use "desc" after a field name for descending. Supported fields:
+              #
+              #       * `display_name`
+              #       * `create_time`
+              #       * `update_time`
+              #
+              #     Example: `display_name, create_time desc`.
+              #   @param view [::Google::Cloud::AIPlatform::V1::NotebookExecutionJobView]
+              #     Optional. The NotebookExecutionJob view. Defaults to BASIC.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NotebookExecutionJob>]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AIPlatform::V1::NotebookExecutionJob>]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/ai_platform/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AIPlatform::V1::NotebookService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AIPlatform::V1::ListNotebookExecutionJobsRequest.new
+              #
+              #   # Call the list_notebook_execution_jobs method.
+              #   result = client.list_notebook_execution_jobs request
+              #
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
+              #     # Each element is of type ::Google::Cloud::AIPlatform::V1::NotebookExecutionJob.
+              #     p item
+              #   end
+              #
+              def list_notebook_execution_jobs request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::ListNotebookExecutionJobsRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                call_metadata = @config.rpcs.list_notebook_execution_jobs.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.list_notebook_execution_jobs.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.list_notebook_execution_jobs.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @notebook_service_stub.list_notebook_execution_jobs request, options do |result, operation|
+                  result = ::Gapic::Rest::PagedEnumerable.new @notebook_service_stub, :list_notebook_execution_jobs, "notebook_execution_jobs", request, result, options
+                  yield result, operation if block_given?
+                  return result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Deletes a NotebookExecutionJob.
+              #
+              # @overload delete_notebook_execution_job(request, options = nil)
+              #   Pass arguments to `delete_notebook_execution_job` via a request object, either of type
+              #   {::Google::Cloud::AIPlatform::V1::DeleteNotebookExecutionJobRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::AIPlatform::V1::DeleteNotebookExecutionJobRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @overload delete_notebook_execution_job(name: nil)
+              #   Pass arguments to `delete_notebook_execution_job` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param name [::String]
+              #     Required. The name of the NotebookExecutionJob resource to be deleted.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Gapic::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Gapic::Operation]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/ai_platform/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AIPlatform::V1::NotebookService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AIPlatform::V1::DeleteNotebookExecutionJobRequest.new
+              #
+              #   # Call the delete_notebook_execution_job method.
+              #   result = client.delete_notebook_execution_job request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
+              def delete_notebook_execution_job request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::DeleteNotebookExecutionJobRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                call_metadata = @config.rpcs.delete_notebook_execution_job.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::AIPlatform::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.delete_notebook_execution_job.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.delete_notebook_execution_job.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @notebook_service_stub.delete_notebook_execution_job request, options do |result, operation|
+                  result = ::Gapic::Operation.new result, @operations_client, options: options
+                  yield result, operation if block_given?
+                  return result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Configuration class for the NotebookService REST API.
               #
@@ -1464,6 +1842,26 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :start_notebook_runtime
+                  ##
+                  # RPC-specific configuration for `create_notebook_execution_job`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :create_notebook_execution_job
+                  ##
+                  # RPC-specific configuration for `get_notebook_execution_job`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :get_notebook_execution_job
+                  ##
+                  # RPC-specific configuration for `list_notebook_execution_jobs`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :list_notebook_execution_jobs
+                  ##
+                  # RPC-specific configuration for `delete_notebook_execution_job`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :delete_notebook_execution_job
 
                   # @private
                   def initialize parent_rpcs = nil
@@ -1489,6 +1887,14 @@ module Google
                     @upgrade_notebook_runtime = ::Gapic::Config::Method.new upgrade_notebook_runtime_config
                     start_notebook_runtime_config = parent_rpcs.start_notebook_runtime if parent_rpcs.respond_to? :start_notebook_runtime
                     @start_notebook_runtime = ::Gapic::Config::Method.new start_notebook_runtime_config
+                    create_notebook_execution_job_config = parent_rpcs.create_notebook_execution_job if parent_rpcs.respond_to? :create_notebook_execution_job
+                    @create_notebook_execution_job = ::Gapic::Config::Method.new create_notebook_execution_job_config
+                    get_notebook_execution_job_config = parent_rpcs.get_notebook_execution_job if parent_rpcs.respond_to? :get_notebook_execution_job
+                    @get_notebook_execution_job = ::Gapic::Config::Method.new get_notebook_execution_job_config
+                    list_notebook_execution_jobs_config = parent_rpcs.list_notebook_execution_jobs if parent_rpcs.respond_to? :list_notebook_execution_jobs
+                    @list_notebook_execution_jobs = ::Gapic::Config::Method.new list_notebook_execution_jobs_config
+                    delete_notebook_execution_job_config = parent_rpcs.delete_notebook_execution_job if parent_rpcs.respond_to? :delete_notebook_execution_job
+                    @delete_notebook_execution_job = ::Gapic::Config::Method.new delete_notebook_execution_job_config
 
                     yield self if block_given?
                   end