google-cloud-ai_platform-v1 0.27.0 → 0.29.0

data/proto_docs/google/cloud/aiplatform/v1/schedule.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        # An instance of a Schedule periodically schedules runs to make API calls based
+        # on user specified time specification and API request type.
+        # @!attribute [rw] cron
+        #   @return [::String]
+        #     Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled
+        #     runs. To explicitly set a timezone to the cron tab, apply a prefix in the
+        #     cron tab: "CRON_TZ=$\\{IANA_TIME_ZONE}" or "TZ=$\\{IANA_TIME_ZONE}".
+        #     The $\\{IANA_TIME_ZONE} may only be a valid string from IANA time zone
+        #     database. For example, "CRON_TZ=America/New_York 1 * * * *", or
+        #     "TZ=America/New_York 1 * * * *".
+        # @!attribute [rw] create_pipeline_job_request
+        #   @return [::Google::Cloud::AIPlatform::V1::CreatePipelineJobRequest]
+        #     Request for
+        #     {::Google::Cloud::AIPlatform::V1::PipelineService::Client#create_pipeline_job PipelineService.CreatePipelineJob}.
+        #     CreatePipelineJobRequest.parent field is required (format:
+        #     projects/\\{project}/locations/\\{location}).
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The resource name of the Schedule.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. User provided name of the Schedule.
+        #     The name can be up to 128 characters long and can consist of any UTF-8
+        #     characters.
+        # @!attribute [rw] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Optional. Timestamp after which the first run can be scheduled.
+        #     Default to Schedule create time if not specified.
+        # @!attribute [rw] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Optional. Timestamp after which no new runs can be scheduled.
+        #     If specified, The schedule will be completed when either
+        #     end_time is reached or when scheduled_run_count >= max_run_count.
+        #     If not specified, new runs will keep getting scheduled until this Schedule
+        #     is paused or deleted. Already scheduled runs will be allowed to complete.
+        #     Unset if not specified.
+        # @!attribute [rw] max_run_count
+        #   @return [::Integer]
+        #     Optional. Maximum run count of the schedule.
+        #     If specified, The schedule will be completed when either
+        #     started_run_count >= max_run_count or when end_time is reached.
+        #     If not specified, new runs will keep getting scheduled until this Schedule
+        #     is paused or deleted. Already scheduled runs will be allowed to complete.
+        #     Unset if not specified.
+        # @!attribute [r] started_run_count
+        #   @return [::Integer]
+        #     Output only. The number of runs started by this schedule.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::AIPlatform::V1::Schedule::State]
+        #     Output only. The state of this Schedule.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this Schedule was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this Schedule was updated.
+        # @!attribute [r] next_run_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this Schedule should schedule the next run.
+        #     Having a next_run_time in the past means the runs are being started
+        #     behind schedule.
+        # @!attribute [r] last_pause_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this Schedule was last paused.
+        #     Unset if never paused.
+        # @!attribute [r] last_resume_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when this Schedule was last resumed.
+        #     Unset if never resumed from pause.
+        # @!attribute [rw] max_concurrent_run_count
+        #   @return [::Integer]
+        #     Required. Maximum number of runs that can be started concurrently for this
+        #     Schedule. This is the limit for starting the scheduled requests and not the
+        #     execution of the operations/jobs created by the requests (if applicable).
+        # @!attribute [rw] allow_queueing
+        #   @return [::Boolean]
+        #     Optional. Whether new scheduled runs can be queued when max_concurrent_runs
+        #     limit is reached. If set to true, new runs will be queued instead of
+        #     skipped. Default to false.
+        # @!attribute [r] catch_up
+        #   @return [::Boolean]
+        #     Output only. Whether to backfill missed runs when the schedule is resumed
+        #     from PAUSED state. If set to true, all missed runs will be scheduled. New
+        #     runs will be scheduled after the backfill is complete. Default to false.
+        # @!attribute [r] last_scheduled_run_response
+        #   @return [::Google::Cloud::AIPlatform::V1::Schedule::RunResponse]
+        #     Output only. Response of the last scheduled run.
+        #     This is the response for starting the scheduled requests and not the
+        #     execution of the operations/jobs created by the requests (if applicable).
+        #     Unset if no run has been scheduled yet.
+        class Schedule
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Status of a scheduled run.
+          # @!attribute [rw] scheduled_run_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The scheduled run time based on the user-specified schedule.
+          # @!attribute [rw] run_response
+          #   @return [::String]
+          #     The response of the scheduled run.
+          class RunResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Possible state of the schedule.
+          module State
+            # Unspecified.
+            STATE_UNSPECIFIED = 0
+
+            # The Schedule is active. Runs are being scheduled on the user-specified
+            # timespec.
+            ACTIVE = 1
+
+            # The schedule is paused. No new runs will be created until the schedule
+            # is resumed. Already started runs will be allowed to complete.
+            PAUSED = 2
+
+            # The Schedule is completed. No new runs will be scheduled. Already started
+            # runs will be allowed to complete. Schedules in completed state cannot be
+            # paused or resumed.
+            COMPLETED = 3
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/schedule_service.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::ScheduleService::Client#create_schedule ScheduleService.CreateSchedule}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the Location to create the Schedule in.
+        #     Format: `projects/{project}/locations/{location}`
+        # @!attribute [rw] schedule
+        #   @return [::Google::Cloud::AIPlatform::V1::Schedule]
+        #     Required. The Schedule to create.
+        class CreateScheduleRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::ScheduleService::Client#get_schedule ScheduleService.GetSchedule}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the Schedule resource.
+        #     Format:
+        #     `projects/{project}/locations/{location}/schedules/{schedule}`
+        class GetScheduleRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::ScheduleService::Client#list_schedules ScheduleService.ListSchedules}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the Location to list the Schedules from.
+        #     Format: `projects/{project}/locations/{location}`
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     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 <request_type> 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:*`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     The standard list page size.
+        #     Default to 100 if not specified.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     The standard list page token.
+        #     Typically obtained via
+        #     {::Google::Cloud::AIPlatform::V1::ListSchedulesResponse#next_page_token ListSchedulesResponse.next_page_token}
+        #     of the previous
+        #     {::Google::Cloud::AIPlatform::V1::ScheduleService::Client#list_schedules ScheduleService.ListSchedules}
+        #     call.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     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`
+        class ListSchedulesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::AIPlatform::V1::ScheduleService::Client#list_schedules ScheduleService.ListSchedules}
+        # @!attribute [rw] schedules
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::Schedule>]
+        #     List of Schedules in the requested page.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results.
+        #     Pass to
+        #     {::Google::Cloud::AIPlatform::V1::ListSchedulesRequest#page_token ListSchedulesRequest.page_token}
+        #     to obtain that page.
+        class ListSchedulesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::ScheduleService::Client#delete_schedule ScheduleService.DeleteSchedule}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the Schedule resource to be deleted.
+        #     Format:
+        #     `projects/{project}/locations/{location}/schedules/{schedule}`
+        class DeleteScheduleRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::ScheduleService::Client#pause_schedule ScheduleService.PauseSchedule}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the Schedule resource to be paused.
+        #     Format:
+        #     `projects/{project}/locations/{location}/schedules/{schedule}`
+        class PauseScheduleRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::ScheduleService::Client#resume_schedule ScheduleService.ResumeSchedule}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the Schedule resource to be resumed.
+        #     Format:
+        #     `projects/{project}/locations/{location}/schedules/{schedule}`
+        # @!attribute [rw] catch_up
+        #   @return [::Boolean]
+        #     Optional. Whether to backfill missed runs when the schedule is resumed from
+        #     PAUSED state. If set to true, all missed runs will be scheduled. New runs
+        #     will be scheduled after the backfill is complete. This will also update
+        #     {::Google::Cloud::AIPlatform::V1::Schedule#catch_up Schedule.catch_up} field.
+        #     Default to false.
+        class ResumeScheduleRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::ScheduleService::Client#update_schedule ScheduleService.UpdateSchedule}.
+        # @!attribute [rw] schedule
+        #   @return [::Google::Cloud::AIPlatform::V1::Schedule]
+        #     Required. The Schedule which replaces the resource on the server.
+        #     The following restrictions will be applied:
+        #       * The scheduled request type cannot be changed.
+        #       * The output_only fields will be ignored if specified.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Required. The update mask applies to the resource. See
+        #     {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
+        class UpdateScheduleRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/types.rb

@@ -56,6 +56,105 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # A tensor value type.
+        # @!attribute [rw] dtype
+        #   @return [::Google::Cloud::AIPlatform::V1::Tensor::DataType]
+        #     The data type of tensor.
+        # @!attribute [rw] shape
+        #   @return [::Array<::Integer>]
+        #     Shape of the tensor.
+        # @!attribute [rw] bool_val
+        #   @return [::Array<::Boolean>]
+        #     Type specific representations that make it easy to create tensor protos in
+        #     all languages.  Only the representation corresponding to "dtype" can
+        #     be set.  The values hold the flattened representation of the tensor in
+        #     row major order.
+        #
+        #     [BOOL][google.aiplatform.master.Tensor.DataType.BOOL]
+        # @!attribute [rw] string_val
+        #   @return [::Array<::String>]
+        #     [STRING][google.aiplatform.master.Tensor.DataType.STRING]
+        # @!attribute [rw] bytes_val
+        #   @return [::Array<::String>]
+        #     [STRING][google.aiplatform.master.Tensor.DataType.STRING]
+        # @!attribute [rw] float_val
+        #   @return [::Array<::Float>]
+        #     [FLOAT][google.aiplatform.master.Tensor.DataType.FLOAT]
+        # @!attribute [rw] double_val
+        #   @return [::Array<::Float>]
+        #     [DOUBLE][google.aiplatform.master.Tensor.DataType.DOUBLE]
+        # @!attribute [rw] int_val
+        #   @return [::Array<::Integer>]
+        #     [INT_8][google.aiplatform.master.Tensor.DataType.INT8]
+        #     [INT_16][google.aiplatform.master.Tensor.DataType.INT16]
+        #     [INT_32][google.aiplatform.master.Tensor.DataType.INT32]
+        # @!attribute [rw] int64_val
+        #   @return [::Array<::Integer>]
+        #     [INT64][google.aiplatform.master.Tensor.DataType.INT64]
+        # @!attribute [rw] uint_val
+        #   @return [::Array<::Integer>]
+        #     [UINT8][google.aiplatform.master.Tensor.DataType.UINT8]
+        #     [UINT16][google.aiplatform.master.Tensor.DataType.UINT16]
+        #     [UINT32][google.aiplatform.master.Tensor.DataType.UINT32]
+        # @!attribute [rw] uint64_val
+        #   @return [::Array<::Integer>]
+        #     [UINT64][google.aiplatform.master.Tensor.DataType.UINT64]
+        # @!attribute [rw] list_val
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::Tensor>]
+        #     A list of tensor values.
+        # @!attribute [rw] struct_val
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AIPlatform::V1::Tensor}]
+        #     A map of string to tensor.
+        # @!attribute [rw] tensor_val
+        #   @return [::String]
+        #     Serialized raw tensor content.
+        class Tensor
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::AIPlatform::V1::Tensor]
+          class StructValEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Data type of the tensor.
+          module DataType
+            # Not a legal value for DataType. Used to indicate a DataType field has not
+            # been set.
+            DATA_TYPE_UNSPECIFIED = 0
+
+            # Data types that all computation devices are expected to be
+            # capable to support.
+            BOOL = 1
+
+            STRING = 2
+
+            FLOAT = 3
+
+            DOUBLE = 4
+
+            INT8 = 5
+
+            INT16 = 6
+
+            INT32 = 7
+
+            INT64 = 8
+
+            UINT8 = 9
+
+            UINT16 = 10
+
+            UINT32 = 11
+
+            UINT64 = 12
+          end
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-ai_platform-v1
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-13 00:00:00.000000000 Z
+date: 2023-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -278,6 +278,11 @@ files:
 - lib/google/cloud/ai_platform/v1/prediction_service/client.rb
 - lib/google/cloud/ai_platform/v1/prediction_service/credentials.rb
 - lib/google/cloud/ai_platform/v1/prediction_service/paths.rb
+- lib/google/cloud/ai_platform/v1/schedule_service.rb
+- lib/google/cloud/ai_platform/v1/schedule_service/client.rb
+- lib/google/cloud/ai_platform/v1/schedule_service/credentials.rb
+- lib/google/cloud/ai_platform/v1/schedule_service/operations.rb
+- lib/google/cloud/ai_platform/v1/schedule_service/paths.rb
 - lib/google/cloud/ai_platform/v1/specialist_pool_service.rb
 - lib/google/cloud/ai_platform/v1/specialist_pool_service/client.rb
 - lib/google/cloud/ai_platform/v1/specialist_pool_service/credentials.rb
@@ -372,6 +377,9 @@ files:
 - lib/google/cloud/aiplatform/v1/prediction_service_services_pb.rb
 - lib/google/cloud/aiplatform/v1/publisher_model_pb.rb
 - lib/google/cloud/aiplatform/v1/saved_query_pb.rb
+- lib/google/cloud/aiplatform/v1/schedule_pb.rb
+- lib/google/cloud/aiplatform/v1/schedule_service_pb.rb
+- lib/google/cloud/aiplatform/v1/schedule_service_services_pb.rb
 - lib/google/cloud/aiplatform/v1/service_networking_pb.rb
 - lib/google/cloud/aiplatform/v1/specialist_pool_pb.rb
 - lib/google/cloud/aiplatform/v1/specialist_pool_service_pb.rb
@@ -461,6 +469,8 @@ files:
 - proto_docs/google/cloud/aiplatform/v1/prediction_service.rb
 - proto_docs/google/cloud/aiplatform/v1/publisher_model.rb
 - proto_docs/google/cloud/aiplatform/v1/saved_query.rb
+- proto_docs/google/cloud/aiplatform/v1/schedule.rb
+- proto_docs/google/cloud/aiplatform/v1/schedule_service.rb
 - proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/image_classification.rb
 - proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/image_object_detection.rb
 - proto_docs/google/cloud/aiplatform/v1/schema/predict/instance/image_segmentation.rb