google-cloud-ai_platform-v1 0.16.0 → 0.17.0

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

@@ -37,8 +37,11 @@ module Google
         # @!attribute [r] deployed_models
         #   @return [::Array<::Google::Cloud::AIPlatform::V1::DeployedModel>]
         #     Output only. The models deployed in this Endpoint.
-        #     To add or remove DeployedModels use {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel} and
-        #     {::Google::Cloud::AIPlatform::V1::EndpointService::Client#undeploy_model EndpointService.UndeployModel} respectively.
+        #     To add or remove DeployedModels use
+        #     {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel}
+        #     and
+        #     {::Google::Cloud::AIPlatform::V1::EndpointService::Client#undeploy_model EndpointService.UndeployModel}
+        #     respectively.
         # @!attribute [rw] traffic_split
         #   @return [::Google::Protobuf::Map{::String => ::Integer}]
         #     A map from a DeployedModel's ID to the percentage of this Endpoint's
@@ -82,7 +85,8 @@ module Google
         #     Private services access must already be configured for the network. If left
         #     unspecified, the Endpoint is not peered with any network.
         #
-        #     Only one of the fields, {::Google::Cloud::AIPlatform::V1::Endpoint#network network} or
+        #     Only one of the fields,
+        #     {::Google::Cloud::AIPlatform::V1::Endpoint#network network} or
         #     {::Google::Cloud::AIPlatform::V1::Endpoint#enable_private_service_connect enable_private_service_connect},
         #     can be set.
         #
@@ -94,14 +98,15 @@ module Google
         #   @return [::Boolean]
         #     Deprecated: If true, expose the Endpoint via private service connect.
         #
-        #     Only one of the fields, {::Google::Cloud::AIPlatform::V1::Endpoint#network network} or
+        #     Only one of the fields,
+        #     {::Google::Cloud::AIPlatform::V1::Endpoint#network network} or
         #     {::Google::Cloud::AIPlatform::V1::Endpoint#enable_private_service_connect enable_private_service_connect},
         #     can be set.
         # @!attribute [r] model_deployment_monitoring_job
         #   @return [::String]
-        #     Output only. Resource name of the Model Monitoring job associated with this Endpoint
-        #     if monitoring is enabled by [CreateModelDeploymentMonitoringJob][].
-        #     Format:
+        #     Output only. Resource name of the Model Monitoring job associated with this
+        #     Endpoint if monitoring is enabled by
+        #     [CreateModelDeploymentMonitoringJob][]. Format:
         #     `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`
         # @!attribute [rw] predict_request_response_logging_config
         #   @return [::Google::Cloud::AIPlatform::V1::PredictRequestResponseLoggingConfig]
@@ -140,14 +145,15 @@ module Google
         #     AI, and require only a modest additional configuration.
         # @!attribute [rw] id
         #   @return [::String]
-        #     Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI
-        #     will generate a value for this ID.
+        #     Immutable. The ID of the DeployedModel. If not provided upon deployment,
+        #     Vertex AI will generate a value for this ID.
         #
         #     This value should be 1-10 characters, and valid characters are /[0-9]/.
         # @!attribute [rw] model
         #   @return [::String]
-        #     Required. The resource name of the Model that this is the deployment of. Note that
-        #     the Model may be in a different location than the DeployedModel's Endpoint.
+        #     Required. The resource name of the Model that this is the deployment of.
+        #     Note that the Model may be in a different location than the DeployedModel's
+        #     Endpoint.
         #
         #     The resource name may contain version id or version alias to specify the
         #     version, if no version is specified, the default version will be deployed.
@@ -165,13 +171,21 @@ module Google
         #   @return [::Google::Cloud::AIPlatform::V1::ExplanationSpec]
         #     Explanation configuration for this DeployedModel.
         #
-        #     When deploying a Model using {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel}, this value
-        #     overrides the value of {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec}. All fields of
-        #     {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec} are optional in the request. If a field of
-        #     {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec} is not populated, the value of the same field of
-        #     {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec} is inherited. If the corresponding
-        #     {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec} is not populated, all fields of the
-        #     {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec} will be used for the explanation configuration.
+        #     When deploying a Model using
+        #     {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel},
+        #     this value overrides the value of
+        #     {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec}.
+        #     All fields of
+        #     {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec}
+        #     are optional in the request. If a field of
+        #     {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec}
+        #     is not populated, the value of the same field of
+        #     {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec}
+        #     is inherited. If the corresponding
+        #     {::Google::Cloud::AIPlatform::V1::Model#explanation_spec Model.explanation_spec}
+        #     is not populated, all fields of the
+        #     {::Google::Cloud::AIPlatform::V1::DeployedModel#explanation_spec explanation_spec}
+        #     will be used for the explanation configuration.
         # @!attribute [rw] service_account
         #   @return [::String]
         #     The service account that the DeployedModel's container runs as. Specify the
@@ -200,9 +214,10 @@ module Google
         #     Estimate your costs before enabling this option.
         # @!attribute [r] private_endpoints
         #   @return [::Google::Cloud::AIPlatform::V1::PrivateEndpoints]
-        #     Output only. Provide paths for users to send predict/explain/health requests directly to
-        #     the deployed model services running on Cloud via private services access.
-        #     This field is populated if {::Google::Cloud::AIPlatform::V1::Endpoint#network network} is configured.
+        #     Output only. Provide paths for users to send predict/explain/health
+        #     requests directly to the deployed model services running on Cloud via
+        #     private services access. This field is populated if
+        #     {::Google::Cloud::AIPlatform::V1::Endpoint#network network} is configured.
         class DeployedModel
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -224,8 +239,8 @@ module Google
         #     Output only. Http(s) path to send health check requests.
         # @!attribute [r] service_attachment
         #   @return [::String]
-        #     Output only. The name of the service attachment resource. Populated if private service
-        #     connect is enabled.
+        #     Output only. The name of the service attachment resource. Populated if
+        #     private service connect is enabled.
         class PrivateEndpoints
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -21,7 +21,8 @@ module Google
   module Cloud
     module AIPlatform
       module V1
-        # Request message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#create_endpoint EndpointService.CreateEndpoint}.
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#create_endpoint EndpointService.CreateEndpoint}.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The resource name of the Location to create the Endpoint in.
@@ -44,7 +45,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Runtime operation information for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#create_endpoint EndpointService.CreateEndpoint}.
+        # Runtime operation information for
+        # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#create_endpoint EndpointService.CreateEndpoint}.
         # @!attribute [rw] generic_metadata
         #   @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
         #     The operation generic information.
@@ -53,7 +55,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#get_endpoint EndpointService.GetEndpoint}
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#get_endpoint EndpointService.GetEndpoint}
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The name of the Endpoint resource.
@@ -64,18 +67,20 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#list_endpoints EndpointService.ListEndpoints}.
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#list_endpoints EndpointService.ListEndpoints}.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The resource name of the Location from which to list the Endpoints.
-        #     Format: `projects/{project}/locations/{location}`
+        #     Required. The resource name of the Location from which to list the
+        #     Endpoints. Format: `projects/{project}/locations/{location}`
         # @!attribute [rw] filter
         #   @return [::String]
-        #     Optional. An expression for filtering the results of the request. For field names
-        #     both snake_case and camelCase are supported.
+        #     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 {::Google::Cloud::AIPlatform::V1::Endpoint#name resource name}.
+        #         i.e. the last segment of the Endpoint's [resource
+        #         name][google.cloud.aiplatform.v1.Endpoint.name].
         #       * `display_name` supports = and, !=
         #       * `labels` supports general map functions that is:
         #         * `labels.key=value` - key:value equality
@@ -93,8 +98,10 @@ module Google
         #   @return [::String]
         #     Optional. The standard list page token.
         #     Typically obtained via
-        #     {::Google::Cloud::AIPlatform::V1::ListEndpointsResponse#next_page_token ListEndpointsResponse.next_page_token} of the previous
-        #     {::Google::Cloud::AIPlatform::V1::EndpointService::Client#list_endpoints EndpointService.ListEndpoints} call.
+        #     {::Google::Cloud::AIPlatform::V1::ListEndpointsResponse#next_page_token ListEndpointsResponse.next_page_token}
+        #     of the previous
+        #     {::Google::Cloud::AIPlatform::V1::EndpointService::Client#list_endpoints EndpointService.ListEndpoints}
+        #     call.
         # @!attribute [rw] read_mask
         #   @return [::Google::Protobuf::FieldMask]
         #     Optional. Mask specifying which fields to read.
@@ -113,32 +120,38 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Response message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#list_endpoints EndpointService.ListEndpoints}.
+        # Response message for
+        # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#list_endpoints EndpointService.ListEndpoints}.
         # @!attribute [rw] endpoints
         #   @return [::Array<::Google::Cloud::AIPlatform::V1::Endpoint>]
         #     List of Endpoints 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::ListEndpointsRequest#page_token ListEndpointsRequest.page_token} to obtain that page.
+        #     Pass to
+        #     {::Google::Cloud::AIPlatform::V1::ListEndpointsRequest#page_token ListEndpointsRequest.page_token}
+        #     to obtain that page.
         class ListEndpointsResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#update_endpoint EndpointService.UpdateEndpoint}.
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#update_endpoint EndpointService.UpdateEndpoint}.
         # @!attribute [rw] endpoint
         #   @return [::Google::Cloud::AIPlatform::V1::Endpoint]
         #     Required. The Endpoint which replaces the resource on the server.
         # @!attribute [rw] update_mask
         #   @return [::Google::Protobuf::FieldMask]
-        #     Required. The update mask applies to the resource. See {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
+        #     Required. The update mask applies to the resource. See
+        #     {::Google::Protobuf::FieldMask google.protobuf.FieldMask}.
         class UpdateEndpointRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#delete_endpoint EndpointService.DeleteEndpoint}.
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#delete_endpoint EndpointService.DeleteEndpoint}.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The name of the Endpoint resource to be deleted.
@@ -149,7 +162,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel}.
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel}.
         # @!attribute [rw] endpoint
         #   @return [::String]
         #     Required. The name of the Endpoint resource into which to deploy a Model.
@@ -158,8 +172,9 @@ module Google
         # @!attribute [rw] deployed_model
         #   @return [::Google::Cloud::AIPlatform::V1::DeployedModel]
         #     Required. The DeployedModel to be created within the Endpoint. Note that
-        #     {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split Endpoint.traffic_split} must be updated for the DeployedModel to start
-        #     receiving traffic, either as part of this call, or via
+        #     {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split Endpoint.traffic_split}
+        #     must be updated for the DeployedModel to start receiving traffic, either as
+        #     part of this call, or via
         #     {::Google::Cloud::AIPlatform::V1::EndpointService::Client#update_endpoint EndpointService.UpdateEndpoint}.
         # @!attribute [rw] traffic_split
         #   @return [::Google::Protobuf::Map{::String => ::Integer}]
@@ -167,13 +182,15 @@ module Google
         #     traffic that should be forwarded to that DeployedModel.
         #
         #     If this field is non-empty, then the Endpoint's
-        #     {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} will be overwritten with it.
-        #     To refer to the ID of the just being deployed Model, a "0" should be used,
-        #     and the actual ID of the new DeployedModel will be filled in its place by
-        #     this method. The traffic percentage values must add up to 100.
+        #     {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} will be
+        #     overwritten with it. To refer to the ID of the just being deployed Model, a
+        #     "0" should be used, and the actual ID of the new DeployedModel will be
+        #     filled in its place by this method. The traffic percentage values must add
+        #     up to 100.
         #
         #     If this field is empty, then the Endpoint's
-        #     {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} is not updated.
+        #     {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} is not
+        #     updated.
         class DeployModelRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -188,7 +205,8 @@ module Google
           end
         end
 
-        # Response message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel}.
+        # Response message for
+        # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel}.
         # @!attribute [rw] deployed_model
         #   @return [::Google::Cloud::AIPlatform::V1::DeployedModel]
         #     The DeployedModel that had been deployed in the Endpoint.
@@ -197,7 +215,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Runtime operation information for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel}.
+        # Runtime operation information for
+        # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#deploy_model EndpointService.DeployModel}.
         # @!attribute [rw] generic_metadata
         #   @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
         #     The operation generic information.
@@ -206,7 +225,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#undeploy_model EndpointService.UndeployModel}.
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#undeploy_model EndpointService.UndeployModel}.
         # @!attribute [rw] endpoint
         #   @return [::String]
         #     Required. The name of the Endpoint resource from which to undeploy a Model.
@@ -218,12 +238,12 @@ module Google
         # @!attribute [rw] traffic_split
         #   @return [::Google::Protobuf::Map{::String => ::Integer}]
         #     If this field is provided, then the Endpoint's
-        #     {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} will be overwritten with it. If
-        #     last DeployedModel is being undeployed from the Endpoint, the
-        #     [Endpoint.traffic_split] will always end up empty when this call returns.
-        #     A DeployedModel will be successfully undeployed only if it doesn't have
-        #     any traffic assigned to it when this method executes, or if this field
-        #     unassigns any traffic to it.
+        #     {::Google::Cloud::AIPlatform::V1::Endpoint#traffic_split traffic_split} will be
+        #     overwritten with it. If last DeployedModel is being undeployed from the
+        #     Endpoint, the [Endpoint.traffic_split] will always end up empty when this
+        #     call returns. A DeployedModel will be successfully undeployed only if it
+        #     doesn't have any traffic assigned to it when this method executes, or if
+        #     this field unassigns any traffic to it.
         class UndeployModelRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -238,13 +258,15 @@ module Google
           end
         end
 
-        # Response message for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#undeploy_model EndpointService.UndeployModel}.
+        # Response message for
+        # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#undeploy_model EndpointService.UndeployModel}.
         class UndeployModelResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Runtime operation information for {::Google::Cloud::AIPlatform::V1::EndpointService::Client#undeploy_model EndpointService.UndeployModel}.
+        # Runtime operation information for
+        # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#undeploy_model EndpointService.UndeployModel}.
         # @!attribute [rw] generic_metadata
         #   @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
         #     The operation generic information.

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

@@ -45,7 +45,8 @@ module Google
         #     Output only. Timestamp when this EntityType was most recently updated.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
-        #     Optional. The labels with user-defined metadata to organize your EntityTypes.
+        #     Optional. The labels with user-defined metadata to organize your
+        #     EntityTypes.
         #
         #     Label keys and values can be no longer than 64 characters
         #     (Unicode codepoints), can only contain lowercase letters, numeric
@@ -58,13 +59,14 @@ module Google
         #     and are immutable.
         # @!attribute [rw] etag
         #   @return [::String]
-        #     Optional. Used to perform a consistent read-modify-write updates. If not set, a blind
-        #     "overwrite" update happens.
+        #     Optional. Used to perform a consistent read-modify-write updates. If not
+        #     set, a blind "overwrite" update happens.
         # @!attribute [rw] monitoring_config
         #   @return [::Google::Cloud::AIPlatform::V1::FeaturestoreMonitoringConfig]
-        #     Optional. The default monitoring configuration for all Features with value type
-        #     ({::Google::Cloud::AIPlatform::V1::Feature::ValueType Feature.ValueType}) BOOL, STRING, DOUBLE or INT64 under this
-        #     EntityType.
+        #     Optional. The default monitoring configuration for all Features with value
+        #     type
+        #     ({::Google::Cloud::AIPlatform::V1::Feature::ValueType Feature.ValueType}) BOOL,
+        #     STRING, DOUBLE or INT64 under this EntityType.
         #
         #     If this is populated with
         #     [FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot