google-apis-aiplatform_v1 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abf9a624beaf54bc50fcd7a53feec08ee22acd671bc6c4ab01025a0ce8abbec4
-  data.tar.gz: a99847b154da73481fbf8eff52dcd3f713a4894b58b2fd55c273606411bcd52f
+  metadata.gz: a339acc9e2792d9aa7013da1b553c8c1ca02f20de7757eef4d32ab8ff77bfa7f
+  data.tar.gz: 18fc1b6da92d7fcf3a7c6260d0f6f87bfa28161835ba26099d8fba4cccbbf5d3
 SHA512:
-  metadata.gz: 684831517a5f7113430e1d83c906cf1c3a369dcd12d683d786d84a56e1ecd5acddfa13ac923f3bc83f063dd9745ee22d1561f62236691a6edad4df3b089b45db
-  data.tar.gz: '0179cf06e8a5cb3526b976db3c7b7b8a12eaf0eab8515210b1d6f035a3b1d80c9d626361dcdc2a6cda13b429711c4043696c53e3edf2b60c16397eb15e5c4b23'
+  metadata.gz: e81f4475ecb2435a3ba04299ed691d59c1d60761f58a532d8b4242e2ec165f3207859f676c470ab0644092508224cd991196c4097b80df27189ee2d1935cba7d
+  data.tar.gz: ae9e5be153a1084f0cfa16b7d87f64b1452a2d4ba05a43a54d8aa798e9cac12e194121aacea0d9a7069efbbc99e6e4bb567c0530d1aefa4664d79fab1eb364ee

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-aiplatform_v1
 
+### v0.5.0 (2023-10-29)
+
+* Regenerated from discovery document revision 20231023
+
+### v0.4.0 (2023-10-22)
+
+* Regenerated from discovery document revision 20231012
+
 ### v0.3.0 (2023-10-15)
 
 * Regenerated from discovery document revision 20231002

data/lib/google/apis/aiplatform_v1/classes.rb

@@ -2293,9 +2293,8 @@ module Google
       class GoogleCloudAiplatformV1CreateFeatureRequest
         include Google::Apis::Core::Hashable
       
-        # Feature Metadata information that describes an attribute of an entity type.
-        # For example, apple is an entity type, and color is a feature that describes
-        # apple.
+        # Feature Metadata information. For example, color is a feature that describes
+        # an apple.
         # Corresponds to the JSON property `feature`
         # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature]
         attr_accessor :feature
@@ -2308,7 +2307,11 @@ module Google
         # @return [String]
         attr_accessor :feature_id
       
-        # 
+        # 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_type`` Format for
+        # feature_group as parent: `projects/`project`/locations/`location`/
+        # featureGroups/`feature_group``
         # Corresponds to the JSON property `parent`
         # @return [String]
         attr_accessor :parent
@@ -2770,6 +2773,13 @@ module Google
         # @return [String]
         attr_accessor :network
       
+        # The ID of the location to store protected artifacts. e.g. us-central1.
+        # Populate only when the location is different than CustomJob location. List of
+        # supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
+        # Corresponds to the JSON property `protectedArtifactLocationId`
+        # @return [String]
+        attr_accessor :protected_artifact_location_id
+      
         # Optional. A list of names for the reserved ip ranges under the VPC network
         # that can be used for this job. If set, we will deploy the job within the
         # provided ip ranges. Otherwise, the job will be deployed to any ip ranges under
@@ -2817,6 +2827,7 @@ module Google
           @experiment = args[:experiment] if args.key?(:experiment)
           @experiment_run = args[:experiment_run] if args.key?(:experiment_run)
           @network = args[:network] if args.key?(:network)
+          @protected_artifact_location_id = args[:protected_artifact_location_id] if args.key?(:protected_artifact_location_id)
           @reserved_ip_ranges = args[:reserved_ip_ranges] if args.key?(:reserved_ip_ranges)
           @scheduling = args[:scheduling] if args.key?(:scheduling)
           @service_account = args[:service_account] if args.key?(:service_account)
@@ -5884,13 +5895,13 @@ module Google
         end
       end
       
-      # Feature Metadata information that describes an attribute of an entity type.
-      # For example, apple is an entity type, and color is a feature that describes
-      # apple.
+      # Feature Metadata information. For example, color is a feature that describes
+      # an apple.
       class GoogleCloudAiplatformV1Feature
         include Google::Apis::Core::Hashable
       
-        # Output only. Timestamp when this EntityType was created.
+        # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp
+        # when this EntityType was created.
         # Corresponds to the JSON property `createTime`
         # @return [String]
         attr_accessor :create_time
@@ -5900,10 +5911,11 @@ module Google
         # @return [String]
         attr_accessor :description
       
-        # Optional. If not set, use the monitoring_config defined for the EntityType
-        # this Feature belongs to. Only Features with type (Feature.ValueType) BOOL,
-        # STRING, DOUBLE or INT64 can enable monitoring. If set to true, all types of
-        # data monitoring are disabled despite the config on EntityType.
+        # Optional. Only applicable for Vertex AI Feature Store (Legacy). If not set,
+        # use the monitoring_config defined for the EntityType this Feature belongs to.
+        # Only Features with type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 can
+        # enable monitoring. If set to true, all types of data monitoring are disabled
+        # despite the config on EntityType.
         # Corresponds to the JSON property `disableMonitoring`
         # @return [Boolean]
         attr_accessor :disable_monitoring
@@ -5926,28 +5938,31 @@ module Google
         # @return [Hash<String,String>]
         attr_accessor :labels
       
-        # Output only. The list of historical stats and anomalies with specified
-        # objectives.
+        # Output only. Only applicable for Vertex AI Feature Store (Legacy). The list of
+        # historical stats and anomalies with specified objectives.
         # Corresponds to the JSON property `monitoringStatsAnomalies`
         # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FeatureMonitoringStatsAnomaly>]
         attr_accessor :monitoring_stats_anomalies
       
         # Immutable. Name of the Feature. Format: `projects/`project`/locations/`
         # location`/featurestores/`featurestore`/entityTypes/`entity_type`/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.
+        # 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.
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
       
-        # Output only. Timestamp when this EntityType was most recently updated.
+        # Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp
+        # when this EntityType was most recently updated.
         # Corresponds to the JSON property `updateTime`
         # @return [String]
         attr_accessor :update_time
       
-        # Immutable. Type of Feature value.
+        # Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of
+        # Feature value.
         # Corresponds to the JSON property `valueType`
         # @return [String]
         attr_accessor :value_type
@@ -21347,7 +21362,7 @@ module Google
         end
       end
       
-      # A message representing a Study.
+      # A message representing a Study. Next id: 12
       class GoogleCloudAiplatformV1Study
         include Google::Apis::Core::Hashable
       
@@ -21460,6 +21475,12 @@ module Google
         # @return [Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudySpecParameterSpec>]
         attr_accessor :parameters
       
+        # The configuration (stopping conditions) for automated stopping of a Study.
+        # Conditions include trial budgets, time budgets, and convergence detection.
+        # Corresponds to the JSON property `studyStoppingConfig`
+        # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudySpecStudyStoppingConfig]
+        attr_accessor :study_stopping_config
+      
         def initialize(**args)
            update!(**args)
         end
@@ -21474,6 +21495,7 @@ module Google
           @metrics = args[:metrics] if args.key?(:metrics)
           @observation_noise = args[:observation_noise] if args.key?(:observation_noise)
           @parameters = args[:parameters] if args.key?(:parameters)
+          @study_stopping_config = args[:study_stopping_config] if args.key?(:study_stopping_config)
         end
       end
       
@@ -21957,6 +21979,93 @@ module Google
         end
       end
       
+      # The configuration (stopping conditions) for automated stopping of a Study.
+      # Conditions include trial budgets, time budgets, and convergence detection.
+      class GoogleCloudAiplatformV1StudySpecStudyStoppingConfig
+        include Google::Apis::Core::Hashable
+      
+        # If the objective value has not improved for this much time, stop the study.
+        # WARNING: Effective only for single-objective studies.
+        # Corresponds to the JSON property `maxDurationNoProgress`
+        # @return [String]
+        attr_accessor :max_duration_no_progress
+      
+        # If there are more than this many trials, stop the study.
+        # Corresponds to the JSON property `maxNumTrials`
+        # @return [Fixnum]
+        attr_accessor :max_num_trials
+      
+        # If the objective value has not improved for this many consecutive trials, stop
+        # the study. WARNING: Effective only for single-objective studies.
+        # Corresponds to the JSON property `maxNumTrialsNoProgress`
+        # @return [Fixnum]
+        attr_accessor :max_num_trials_no_progress
+      
+        # Time-based Constraint for Study
+        # Corresponds to the JSON property `maximumRuntimeConstraint`
+        # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudyTimeConstraint]
+        attr_accessor :maximum_runtime_constraint
+      
+        # If there are fewer than this many COMPLETED trials, do not stop the study.
+        # Corresponds to the JSON property `minNumTrials`
+        # @return [Fixnum]
+        attr_accessor :min_num_trials
+      
+        # Time-based Constraint for Study
+        # Corresponds to the JSON property `minimumRuntimeConstraint`
+        # @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudyTimeConstraint]
+        attr_accessor :minimum_runtime_constraint
+      
+        # If true, a Study enters STOPPING_ASAP whenever it would normally enters
+        # STOPPING state. The bottom line is: set to true if you want to interrupt on-
+        # going evaluations of Trials as soon as the study stopping condition is met. (
+        # Please see Study.State documentation for the source of truth).
+        # Corresponds to the JSON property `shouldStopAsap`
+        # @return [Boolean]
+        attr_accessor :should_stop_asap
+        alias_method :should_stop_asap?, :should_stop_asap
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @max_duration_no_progress = args[:max_duration_no_progress] if args.key?(:max_duration_no_progress)
+          @max_num_trials = args[:max_num_trials] if args.key?(:max_num_trials)
+          @max_num_trials_no_progress = args[:max_num_trials_no_progress] if args.key?(:max_num_trials_no_progress)
+          @maximum_runtime_constraint = args[:maximum_runtime_constraint] if args.key?(:maximum_runtime_constraint)
+          @min_num_trials = args[:min_num_trials] if args.key?(:min_num_trials)
+          @minimum_runtime_constraint = args[:minimum_runtime_constraint] if args.key?(:minimum_runtime_constraint)
+          @should_stop_asap = args[:should_stop_asap] if args.key?(:should_stop_asap)
+        end
+      end
+      
+      # Time-based Constraint for Study
+      class GoogleCloudAiplatformV1StudyTimeConstraint
+        include Google::Apis::Core::Hashable
+      
+        # Compares the wallclock time to this time. Must use UTC timezone.
+        # Corresponds to the JSON property `endTime`
+        # @return [String]
+        attr_accessor :end_time
+      
+        # Counts the wallclock time passed since the creation of this Study.
+        # Corresponds to the JSON property `maxDuration`
+        # @return [String]
+        attr_accessor :max_duration
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @end_time = args[:end_time] if args.key?(:end_time)
+          @max_duration = args[:max_duration] if args.key?(:max_duration)
+        end
+      end
+      
       # Details of operations that perform Trials suggestion.
       class GoogleCloudAiplatformV1SuggestTrialsMetadata
         include Google::Apis::Core::Hashable

data/lib/google/apis/aiplatform_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module AiplatformV1
       # Version of the google-apis-aiplatform_v1 gem
-      GEM_VERSION = "0.3.0"
+      GEM_VERSION = "0.5.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20231002"
+      REVISION = "20231023"
     end
   end
 end

data/lib/google/apis/aiplatform_v1/representations.rb

@@ -3604,6 +3604,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudAiplatformV1StudySpecStudyStoppingConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudAiplatformV1StudyTimeConstraint
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudAiplatformV1SuggestTrialsMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -4814,6 +4826,7 @@ module Google
           property :experiment, as: 'experiment'
           property :experiment_run, as: 'experimentRun'
           property :network, as: 'network'
+          property :protected_artifact_location_id, as: 'protectedArtifactLocationId'
           collection :reserved_ip_ranges, as: 'reservedIpRanges'
           property :scheduling, as: 'scheduling', class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Scheduling, decorator: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Scheduling::Representation
       
@@ -9865,6 +9878,8 @@ module Google
           property :observation_noise, as: 'observationNoise'
           collection :parameters, as: 'parameters', class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudySpecParameterSpec, decorator: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudySpecParameterSpec::Representation
       
+          property :study_stopping_config, as: 'studyStoppingConfig', class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudySpecStudyStoppingConfig, decorator: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudySpecStudyStoppingConfig::Representation
+      
         end
       end
       
@@ -9999,6 +10014,29 @@ module Google
         end
       end
       
+      class GoogleCloudAiplatformV1StudySpecStudyStoppingConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :max_duration_no_progress, as: 'maxDurationNoProgress'
+          property :max_num_trials, as: 'maxNumTrials'
+          property :max_num_trials_no_progress, as: 'maxNumTrialsNoProgress'
+          property :maximum_runtime_constraint, as: 'maximumRuntimeConstraint', class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudyTimeConstraint, decorator: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudyTimeConstraint::Representation
+      
+          property :min_num_trials, as: 'minNumTrials'
+          property :minimum_runtime_constraint, as: 'minimumRuntimeConstraint', class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudyTimeConstraint, decorator: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1StudyTimeConstraint::Representation
+      
+          property :should_stop_asap, as: 'shouldStopAsap'
+        end
+      end
+      
+      class GoogleCloudAiplatformV1StudyTimeConstraint
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :end_time, as: 'endTime'
+          property :max_duration, as: 'maxDuration'
+        end
+      end
+      
       class GoogleCloudAiplatformV1SuggestTrialsMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/aiplatform_v1/service.rb

@@ -4593,6 +4593,11 @@ module Google
         
         # Creates a new Feature in a given EntityType.
         # @param [String] parent
+        #   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_type`` Format for
+        #   feature_group as parent: `projects/`project`/locations/`location`/
+        #   featureGroups/`feature_group``
         # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature] google_cloud_aiplatform_v1_feature_object
         # @param [String] feature_id
         #   Required. The ID to use for the Feature, which will become the final component
@@ -4664,9 +4669,10 @@ module Google
         
         # Gets details of a single Feature.
         # @param [String] name
-        #   Required. The name of the Feature resource. Format: `projects/`project`/
-        #   locations/`location`/featurestores/`featurestore`/entityTypes/`entity_type`` `
-        #   projects/`project`/locations/`location`/featureGroups/`feature_group``
+        #   Required. The name of the Feature resource. Format for entity_type as parent: `
+        #   projects/`project`/locations/`location`/featurestores/`featurestore`/
+        #   entityTypes/`entity_type`` Format for feature_group as parent: `projects/`
+        #   project`/locations/`location`/featureGroups/`feature_group``
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -4696,10 +4702,10 @@ module Google
         
         # Lists Features in a given EntityType.
         # @param [String] parent
-        #   Required. The resource name of the Location to list Features. Format: `
-        #   projects/`project`/locations/`location`/featurestores/`featurestore`/
-        #   entityTypes/`entity_type`` `projects/`project`/locations/`location`/
-        #   featureGroups/`feature_group``
+        #   Required. The resource name of the Location to list Features. Format for
+        #   entity_type as parent: `projects/`project`/locations/`location`/featurestores/`
+        #   featurestore`/entityTypes/`entity_type`` Format for feature_group as parent: `
+        #   projects/`project`/locations/`location`/featureGroups/`feature_group``
         # @param [String] filter
         #   Lists the Features that match the filter expression. The following filters are
         #   supported: * `value_type`: Supports = and != comparisons. * `create_time`:
@@ -4713,9 +4719,10 @@ module Google
         #   Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --
         #   > Any Feature which has a label with 'env' as the key.
         # @param [Fixnum] latest_stats_count
-        #   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.
+        #   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.
         # @param [String] order_by
         #   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` * `
@@ -4726,10 +4733,11 @@ module Google
         #   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.
         # @param [String] page_token
-        #   A page token, received from a previous FeaturestoreService.ListFeatures call.
-        #   Provide this to retrieve the subsequent page. When paginating, all other
-        #   parameters provided to FeaturestoreService.ListFeatures must match the call
-        #   that provided the page token.
+        #   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 or FeatureRegistryService.ListFeatures
+        #   must match the call that provided the page token.
         # @param [String] read_mask
         #   Mask specifying which fields to read.
         # @param [String] fields
@@ -4769,10 +4777,11 @@ module Google
         # @param [String] name
         #   Immutable. Name of the Feature. Format: `projects/`project`/locations/`
         #   location`/featurestores/`featurestore`/entityTypes/`entity_type`/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.
+        #   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.
         # @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Feature] google_cloud_aiplatform_v1_feature_object
         # @param [String] update_mask
         #   Field mask is used to specify the fields to be overwritten in the Features
@@ -4781,7 +4790,7 @@ module Google
         #   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`
+        #   disable_monitoring` (Not supported for FeatureRegistry Feature)
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-aiplatform_v1
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-15 00:00:00.000000000 Z
+date: 2023-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-aiplatform_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-aiplatform_v1/v0.3.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-aiplatform_v1/v0.5.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-aiplatform_v1
 post_install_message: 
 rdoc_options: []