Skip to content
This repository has been archived by the owner on Jul 20, 2023. It is now read-only.

feat: add IAM policy to aiplatform_v1beta1.yaml #308

Merged
merged 8 commits into from
Jun 3, 2022
4 changes: 2 additions & 2 deletions protos/google/cloud/aiplatform/v1/endpoint.proto
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,8 @@ message DeployedModel {
// This value should be 1-10 characters, and valid characters are /[0-9]/.
string id = 1 [(google.api.field_behavior) = IMMUTABLE];

// Required. The 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.
string model = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand Down
3 changes: 3 additions & 0 deletions protos/google/cloud/aiplatform/v1/explanation_metadata.proto
Original file line number Diff line number Diff line change
Expand Up @@ -392,4 +392,7 @@ message ExplanationMetadata {
// than the one given on input. The output URI will point to a location where
// the user only has a read access.
string feature_attributions_schema_uri = 3;

// Name of the source to generate embeddings for example based explanations.
string latent_space_source = 5;
}
18 changes: 18 additions & 0 deletions protos/google/cloud/aiplatform/v1/featurestore.proto
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,29 @@ message Featurestore {
// OnlineServingConfig specifies the details for provisioning online serving
// resources.
message OnlineServingConfig {
// Online serving scaling configuration. If min_node_count and
// max_node_count are set to the same value, the cluster will be configured
// with the fixed number of node (no auto-scaling).
message Scaling {
// Required. The minimum number of nodes to scale down to. Must be greater than or
// equal to 1.
int32 min_node_count = 1 [(google.api.field_behavior) = REQUIRED];

// The maximum number of nodes to scale up to. Must be greater than
// min_node_count, and less than or equal to 10 times of 'min_node_count'.
int32 max_node_count = 2;
}

// The number of nodes for the online store. The number of nodes doesn't
// scale automatically, but you can manually update the number of
// nodes. If set to 0, the featurestore will not have an
// online store and cannot be used for online serving.
int32 fixed_node_count = 2;

// Online serving scaling configuration.
// Only one of `fixed_node_count` and `scaling` can be set. Setting one will
// reset the other.
Scaling scaling = 4;
}

// Possible states a featurestore can have.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ message ManualBatchTuningParameters {
// speeds up the batch operation's execution, but too high value will result
// in a whole batch not fitting in a machine's memory, and the whole
// operation will fail.
// The default value is 4.
// The default value is 64.
int32 batch_size = 1 [(google.api.field_behavior) = IMMUTABLE];
}
2 changes: 2 additions & 0 deletions protos/google/cloud/aiplatform/v1/model_monitoring.proto
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ message ModelMonitoringObjectiveConfig {
//
// "csv"
// The source file is a CSV file.
// "jsonl"
// The source file is a JSONL file.
string data_format = 2;

// The target field name the model is to predict.
Expand Down
44 changes: 44 additions & 0 deletions protos/google/cloud/aiplatform/v1/pipeline_failure_policy.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
// Copyright 2022 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
//
// http://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.

syntax = "proto3";

package google.cloud.aiplatform.v1;

option csharp_namespace = "Google.Cloud.AIPlatform.V1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "PipelineFailurePolicyProto";
option java_package = "com.google.cloud.aiplatform.v1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1";
option ruby_package = "Google::Cloud::AIPlatform::V1";

// Represents the failure policy of a pipeline. Currently, the default of a
// pipeline is that the pipeline will continue to run until no more tasks can be
// executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a
// pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling
// any new tasks when a task has failed. Any scheduled tasks will continue to
// completion.
enum PipelineFailurePolicy {
// Default value, and follows fail slow behavior.
PIPELINE_FAILURE_POLICY_UNSPECIFIED = 0;

// Indicates that the pipeline should continue to run until all possible
// tasks have been scheduled and completed.
PIPELINE_FAILURE_POLICY_FAIL_SLOW = 1;

// Indicates that the pipeline should stop scheduling new tasks after a task
// has failed.
PIPELINE_FAILURE_POLICY_FAIL_FAST = 2;
}
30 changes: 30 additions & 0 deletions protos/google/cloud/aiplatform/v1/pipeline_job.proto
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import "google/cloud/aiplatform/v1/artifact.proto";
import "google/cloud/aiplatform/v1/context.proto";
import "google/cloud/aiplatform/v1/encryption_spec.proto";
import "google/cloud/aiplatform/v1/execution.proto";
import "google/cloud/aiplatform/v1/pipeline_failure_policy.proto";
import "google/cloud/aiplatform/v1/pipeline_state.proto";
import "google/cloud/aiplatform/v1/value.proto";
import "google/protobuf/struct.proto";
Expand Down Expand Up @@ -72,6 +73,14 @@ message PipelineJob {
// `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built
// using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
map<string, google.protobuf.Value> parameter_values = 3;

// Represents the failure policy of a pipeline. Currently, the default of a
// pipeline is that the pipeline will continue to run until no more tasks
// can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
// However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
// will stop scheduling any new tasks when a task has failed. Any scheduled
// tasks will continue to completion.
PipelineFailurePolicy failure_policy = 4;
}

// Output only. The resource name of the PipelineJob.
Expand Down Expand Up @@ -150,6 +159,27 @@ message PipelineJob {
string network = 18 [(google.api.resource_reference) = {
type: "compute.googleapis.com/Network"
}];

// A template uri from where the [PipelineJob.pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec], if empty, will
// be downloaded.
string template_uri = 19;

// Output only. Pipeline template metadata. Will fill up fields if
// [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri] is from supported template registry.
PipelineTemplateMetadata template_metadata = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
}

// Pipeline template metadata if [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri] is from supported
// template registry. Currently, the only supported registry is Artifact
// Registry.
message PipelineTemplateMetadata {
// The version_name in artifact registry.
//
// Will always be presented in output if the [PipelineJob.template_uri][google.cloud.aiplatform.v1.PipelineJob.template_uri] is
// from supported template registry.
//
// Format is "sha256:abcdef123456...".
string version = 3;
}

// The runtime detail of PipelineJob.
Expand Down
2 changes: 1 addition & 1 deletion protos/google/cloud/aiplatform/v1/pipeline_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ message ListPipelineJobsRequest {
// Values must be in RFC 3339 format.
// * `labels`: Supports key-value equality and key presence.
// * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard.
// * `template_metadata.version_name`: Supports `=`, `!=` comparisons, and `:`
// * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:`
// wildcard.
//
// Filter expressions can be combined together using logical operators
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,9 @@ message BatchPredictionJob {
// Starting this job has no impact on any existing deployments of the Model
// and their resources.
// Exactly one of model and unmanaged_container_model must be set.
//
// The model resource name may contain version id or version alias to specify
// the version, if no version is specified, the default version will be used.
string model = 3 [(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/Model"
}];
Expand Down
4 changes: 4 additions & 0 deletions protos/google/cloud/aiplatform/v1beta1/completion_stats.proto
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,8 @@ message CompletionStats {
// Set to -1 if the number is unknown (for example, the operation failed
// before the total entity number could be collected).
int64 incomplete_count = 3 [(google.api.field_behavior) = OUTPUT_ONLY];

// Output only. The number of the successful forecast points that are generated by the
// forecasting model. This is ONLY used by the forecasting batch prediction.
int64 successful_forecast_point_count = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
}
7 changes: 5 additions & 2 deletions protos/google/cloud/aiplatform/v1beta1/endpoint.proto
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,11 @@ message DeployedModel {
// This value should be 1-10 characters, and valid characters are /[0-9]/.
string id = 1 [(google.api.field_behavior) = IMMUTABLE];

// Required. The 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.
string model = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand Down
4 changes: 2 additions & 2 deletions protos/google/cloud/aiplatform/v1beta1/explanation.proto
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,7 @@ message Examples {

// Preset config based on the desired query speed-precision trade-off
// and modality
Preset preset = 4;
Presets presets = 4;
}

// The Cloud Storage location for the input instances.
Expand All @@ -406,7 +406,7 @@ message Examples {
}

// Preset configuration for example-based explanations
message Preset {
message Presets {
// Preset option controlling parameters for query speed-precision trade-off
enum Query {
// More precise neighbors as a trade-off against slower response.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,6 @@ message StreamingReadFeatureValuesRequest {
}

// Value for a feature.
// (-- NEXT ID: 15 --)
message FeatureValue {
// Metadata of feature value.
message Metadata {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ message ManualBatchTuningParameters {
// speeds up the batch operation's execution, but too high value will result
// in a whole batch not fitting in a machine's memory, and the whole
// operation will fail.
// The default value is 4.
// The default value is 64.
int32 batch_size = 1 [(google.api.field_behavior) = IMMUTABLE];
}
2 changes: 2 additions & 0 deletions protos/google/cloud/aiplatform/v1beta1/model_monitoring.proto
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ message ModelMonitoringObjectiveConfig {
//
// "csv"
// The source file is a CSV file.
// "jsonl"
// The source file is a JSONL file.
string data_format = 2;

// The target field name the model is to predict.
Expand Down
6 changes: 3 additions & 3 deletions protos/google/cloud/aiplatform/v1beta1/model_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ service ModelService {
option (google.api.method_signature) = "model,update_mask";
}

// Incremental update the dataset used for a examples model.
// Incrementally update the dataset used for an examples model.
rpc UpdateExplanationDataset(UpdateExplanationDatasetRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1beta1/{model=projects/*/locations/*/models/*}:updateExplanationDataset"
Expand Down Expand Up @@ -250,9 +250,9 @@ message GetModelRequest {
//
// In order to retrieve a specific version of the model, also provide
// the version ID or version alias.
// Example: projects/{project}/locations/{location}/models/{model}@2
// Example: `projects/{project}/locations/{location}/models/{model}@2`
// or
// projects/{project}/locations/{location}/models/{model}@golden
// `projects/{project}/locations/{location}/models/{model}@golden`
// If no version ID or alias is specified, the "default" version will be
// returned. The "default" version alias is created for the first version of
// the model, and can be moved to other versions later on. There will be
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
// Copyright 2022 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
//
// http://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.

syntax = "proto3";

package google.cloud.aiplatform.v1beta1;

option csharp_namespace = "Google.Cloud.AIPlatform.V1Beta1";
option go_package = "google.golang.org/genproto/googleapis/cloud/aiplatform/v1beta1;aiplatform";
option java_multiple_files = true;
option java_outer_classname = "PipelineFailurePolicyProto";
option java_package = "com.google.cloud.aiplatform.v1beta1";
option php_namespace = "Google\\Cloud\\AIPlatform\\V1beta1";
option ruby_package = "Google::Cloud::AIPlatform::V1beta1";

// Represents the failure policy of a pipeline. Currently, the default of a
// pipeline is that the pipeline will continue to run until no more tasks can be
// executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a
// pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling
// any new tasks when a task has failed. Any scheduled tasks will continue to
// completion.
enum PipelineFailurePolicy {
// Default value, and follows fail slow behavior.
PIPELINE_FAILURE_POLICY_UNSPECIFIED = 0;

// Indicates that the pipeline should continue to run until all possible
// tasks have been scheduled and completed.
PIPELINE_FAILURE_POLICY_FAIL_SLOW = 1;

// Indicates that the pipeline should stop scheduling new tasks after a task
// has failed.
PIPELINE_FAILURE_POLICY_FAIL_FAST = 2;
}
9 changes: 9 additions & 0 deletions protos/google/cloud/aiplatform/v1beta1/pipeline_job.proto
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import "google/cloud/aiplatform/v1beta1/artifact.proto";
import "google/cloud/aiplatform/v1beta1/context.proto";
import "google/cloud/aiplatform/v1beta1/encryption_spec.proto";
import "google/cloud/aiplatform/v1beta1/execution.proto";
import "google/cloud/aiplatform/v1beta1/pipeline_failure_policy.proto";
import "google/cloud/aiplatform/v1beta1/pipeline_state.proto";
import "google/cloud/aiplatform/v1beta1/value.proto";
import "google/protobuf/struct.proto";
Expand Down Expand Up @@ -72,6 +73,14 @@ message PipelineJob {
// `PipelineJob.pipeline_spec.schema_version` 2.1.0, such as pipelines built
// using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
map<string, google.protobuf.Value> parameter_values = 3;

// Represents the failure policy of a pipeline. Currently, the default of a
// pipeline is that the pipeline will continue to run until no more tasks
// can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW.
// However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it
// will stop scheduling any new tasks when a task has failed. Any scheduled
// tasks will continue to completion.
PipelineFailurePolicy failure_policy = 4;
}

// Output only. The resource name of the PipelineJob.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ message ListPipelineJobsRequest {
// Values must be in RFC 3339 format.
// * `labels`: Supports key-value equality and key presence.
// * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard.
// * `template_metadata.version_name`: Supports `=`, `!=` comparisons, and `:`
// * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:`
// wildcard.
//
// Filter expressions can be combined together using logical operators
Expand Down
Loading