Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: [ai-platform] add service_networking.proto to aiplatform v1 #3937

Merged
merged 21 commits into from
Feb 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
d9a4263
feat: add disable_explanations to DeployedModel in aiplatform v1beta1…
gcf-owl-bot[bot] Feb 3, 2023
d2c3814
feat: add service_networking.proto to aiplatform v1
gcf-owl-bot[bot] Feb 3, 2023
ee104ab
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Feb 3, 2023
3511ad2
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Feb 3, 2023
ce00b30
Merge branch 'owl-bot-copy-packages-google-cloud-aiplatform' of https…
gcf-owl-bot[bot] Feb 3, 2023
eb78167
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Feb 3, 2023
07a029c
Merge branch 'owl-bot-copy-packages-google-cloud-aiplatform' of https…
gcf-owl-bot[bot] Feb 3, 2023
a173637
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Feb 3, 2023
032db82
Merge branch 'owl-bot-copy-packages-google-cloud-aiplatform' of https…
gcf-owl-bot[bot] Feb 3, 2023
261401a
chore: update .gitignore to always include protos folder
gcf-owl-bot[bot] Feb 4, 2023
6aeb700
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Feb 4, 2023
9029403
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Feb 4, 2023
f2ee686
Merge branch 'owl-bot-copy-packages-google-cloud-aiplatform' of https…
gcf-owl-bot[bot] Feb 4, 2023
3ad057a
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Feb 4, 2023
68b99dc
Merge branch 'owl-bot-copy-packages-google-cloud-aiplatform' of https…
gcf-owl-bot[bot] Feb 4, 2023
8838fdd
chore(gitignore): only ignore folders in the top level
gcf-owl-bot[bot] Feb 7, 2023
448078a
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Feb 7, 2023
0073a1c
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Feb 7, 2023
bf82a53
Merge branch 'owl-bot-copy-packages-google-cloud-aiplatform' of https…
gcf-owl-bot[bot] Feb 7, 2023
d3a68e7
Merge branch 'main' into owl-bot-copy-packages-google-cloud-aiplatform
sofisl Feb 7, 2023
daccd18
Merge branch 'main' into owl-bot-copy-packages-google-cloud-aiplatform
sofisl Feb 7, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions packages/google-cloud-aiplatform/.gitignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
**/*.log
**/node_modules
.coverage
coverage
.nyc_output
docs/
out/
build/
/.coverage
/coverage
/.nyc_output
/docs/
/out/
/build/
system-test/secrets.js
system-test/*key.json
*.lock
Expand Down
16 changes: 16 additions & 0 deletions packages/google-cloud-aiplatform/README.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ message Endpoint {
// this key.
EncryptionSpec encryption_spec = 10;

// The full name of the Google Compute Engine
// Optional. The full name of the Google Compute Engine
// [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks)
// to which the Endpoint should be peered.
//
Expand All @@ -113,6 +113,7 @@ message Endpoint {
// Where `{project}` is a project number, as in `12345`, and `{network}` is
// network name.
string network = 13 [
(google.api.field_behavior) = OPTIONAL,
(google.api.resource_reference) = { type: "compute.googleapis.com/Network" }
];

Expand Down Expand Up @@ -224,6 +225,8 @@ message DeployedModel {
// User can disable container logging by setting this flag to true.
bool disable_container_logging = 15;

// If true, online prediction access logs are sent to StackDriver
// Logging.
// These logs are like standard server access logs, containing
// information like timestamp and latency for each prediction request.
//
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ package google.cloud.aiplatform.v1;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/aiplatform/v1/machine_resources.proto";
import "google/cloud/aiplatform/v1/service_networking.proto";
import "google/protobuf/timestamp.proto";

option csharp_namespace = "Google.Cloud.AIPlatform.V1";
Expand Down Expand Up @@ -102,6 +103,14 @@ message IndexEndpoint {
// can be set.
bool enable_private_service_connect = 10
[deprecated = true, (google.api.field_behavior) = OPTIONAL];

// Optional. Configuration for private service connect.
//
// [network][google.cloud.aiplatform.v1.IndexEndpoint.network] and
// [private_service_connect_config][google.cloud.aiplatform.v1.IndexEndpoint.private_service_connect_config]
// are mutually exclusive.
PrivateServiceConnectConfig private_service_connect_config = 12
[(google.api.field_behavior) = OPTIONAL];
}

// A deployment of an Index. IndexEndpoints contain one or more DeployedIndexes.
Expand Down Expand Up @@ -177,10 +186,10 @@ message DeployedIndex {
// e2-standard-16 and all machine types available for LARGE shard.
//
// Available machine types for LARGE shard:
// e2-standard-32, e2-highmem-16, n2d-standard-32.
// e2-highmem-16, n2d-standard-32.
//
// n1-standard-16 and n1-standard-32 are still available, but we recommend
// e2-standard-16 and e2-standard-32 for cost efficiency.
// e2-standard-16 and e2-highmem-16 for cost efficiency.
DedicatedResources dedicated_resources = 16
[(google.api.field_behavior) = OPTIONAL];

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import "google/cloud/aiplatform/v1/custom_job.proto";
import "google/cloud/aiplatform/v1/data_labeling_job.proto";
import "google/cloud/aiplatform/v1/hyperparameter_tuning_job.proto";
import "google/cloud/aiplatform/v1/model_deployment_monitoring_job.proto";
import "google/cloud/aiplatform/v1/nas_job.proto";
import "google/cloud/aiplatform/v1/operation.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
Expand All @@ -43,7 +44,8 @@ option ruby_package = "Google::Cloud::AIPlatform::V1";
service JobService {
option (google.api.default_host) = "aiplatform.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";
"https://www.googleapis.com/auth/cloud-platform,"
"https://www.googleapis.com/auth/cloud-platform.read-only";

// Creates a CustomJob. A created CustomJob right away
// will be attempted to be run.
Expand Down Expand Up @@ -219,6 +221,81 @@ service JobService {
option (google.api.method_signature) = "name";
}

// Creates a NasJob
rpc CreateNasJob(CreateNasJobRequest) returns (NasJob) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/nasJobs"
body: "nas_job"
};
option (google.api.method_signature) = "parent,nas_job";
}

// Gets a NasJob
rpc GetNasJob(GetNasJobRequest) returns (NasJob) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/nasJobs/*}"
};
option (google.api.method_signature) = "name";
}

// Lists NasJobs in a Location.
rpc ListNasJobs(ListNasJobsRequest) returns (ListNasJobsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/nasJobs"
};
option (google.api.method_signature) = "parent";
}

// Deletes a NasJob.
rpc DeleteNasJob(DeleteNasJobRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/nasJobs/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "DeleteOperationMetadata"
};
}

// Cancels a NasJob.
// Starts asynchronous cancellation on the NasJob. The server
// makes a best effort to cancel the job, but success is not
// guaranteed. Clients can use
// [JobService.GetNasJob][google.cloud.aiplatform.v1.JobService.GetNasJob] or
// other methods to check whether the cancellation succeeded or whether the
// job completed despite cancellation. On successful cancellation,
// the NasJob is not deleted; instead it becomes a job with
// a [NasJob.error][google.cloud.aiplatform.v1.NasJob.error] value with a
// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
// `Code.CANCELLED`, and
// [NasJob.state][google.cloud.aiplatform.v1.NasJob.state] is set to
// `CANCELLED`.
rpc CancelNasJob(CancelNasJobRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/nasJobs/*}:cancel"
body: "*"
};
option (google.api.method_signature) = "name";
}

// Gets a NasTrialDetail.
rpc GetNasTrialDetail(GetNasTrialDetailRequest) returns (NasTrialDetail) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/nasJobs/*/nasTrialDetails/*}"
};
option (google.api.method_signature) = "name";
}

// List top NasTrialDetails of a NasJob.
rpc ListNasTrialDetails(ListNasTrialDetailsRequest)
returns (ListNasTrialDetailsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/nasJobs/*}/nasTrialDetails"
};
option (google.api.method_signature) = "parent";
}

// Creates a BatchPredictionJob. A BatchPredictionJob once created will
// right away be attempted to start.
rpc CreateBatchPredictionJob(CreateBatchPredictionJobRequest)
Expand Down Expand Up @@ -752,6 +829,180 @@ message CancelHyperparameterTuningJobRequest {
];
}

// Request message for
// [JobService.CreateNasJob][google.cloud.aiplatform.v1.JobService.CreateNasJob].
message CreateNasJobRequest {
// Required. The resource name of the Location to create the NasJob in.
// Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];

// Required. The NasJob to create.
NasJob nas_job = 2 [(google.api.field_behavior) = REQUIRED];
}

// Request message for
// [JobService.GetNasJob][google.cloud.aiplatform.v1.JobService.GetNasJob].
message GetNasJobRequest {
// Required. The name of the NasJob resource.
// Format:
// `projects/{project}/locations/{location}/nasJobs/{nas_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/NasJob"
}
];
}

// Request message for
// [JobService.ListNasJobs][google.cloud.aiplatform.v1.JobService.ListNasJobs].
message ListNasJobsRequest {
// Required. The resource name of the Location to list the NasJobs
// from. Format: `projects/{project}/locations/{location}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "locations.googleapis.com/Location"
}
];

// The standard list filter.
//
// Supported fields:
//
// * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
// * `state` supports `=`, `!=` comparisons.
// * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
// `create_time` must be in RFC 3339 format.
// * `labels` supports general map functions that is:
// `labels.key=value` - key:value equality
// `labels.key:* - key existence
//
// Some examples of using the filter are:
//
// * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
// * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
// * `NOT display_name="my_job"`
// * `create_time>"2021-05-18T00:00:00Z"`
// * `labels.keyA=valueA`
// * `labels.keyB:*`
string filter = 2;

// The standard list page size.
int32 page_size = 3;

// The standard list page token.
// Typically obtained via
// [ListNasJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListNasJobsResponse.next_page_token]
// of the previous
// [JobService.ListNasJobs][google.cloud.aiplatform.v1.JobService.ListNasJobs]
// call.
string page_token = 4;

// Mask specifying which fields to read.
google.protobuf.FieldMask read_mask = 5;
}

// Response message for
// [JobService.ListNasJobs][google.cloud.aiplatform.v1.JobService.ListNasJobs]
message ListNasJobsResponse {
// List of NasJobs in the requested page.
// [NasJob.nas_job_output][google.cloud.aiplatform.v1.NasJob.nas_job_output]
// of the jobs will not be returned.
repeated NasJob nas_jobs = 1;

// A token to retrieve the next page of results.
// Pass to
// [ListNasJobsRequest.page_token][google.cloud.aiplatform.v1.ListNasJobsRequest.page_token]
// to obtain that page.
string next_page_token = 2;
}

// Request message for
// [JobService.DeleteNasJob][google.cloud.aiplatform.v1.JobService.DeleteNasJob].
message DeleteNasJobRequest {
// Required. The name of the NasJob resource to be deleted.
// Format:
// `projects/{project}/locations/{location}/nasJobs/{nas_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/NasJob"
}
];
}

// Request message for
// [JobService.CancelNasJob][google.cloud.aiplatform.v1.JobService.CancelNasJob].
message CancelNasJobRequest {
// Required. The name of the NasJob to cancel.
// Format:
// `projects/{project}/locations/{location}/nasJobs/{nas_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/NasJob"
}
];
}

// Request message for
// [JobService.GetNasTrialDetail][google.cloud.aiplatform.v1.JobService.GetNasTrialDetail].
message GetNasTrialDetailRequest {
// Required. The name of the NasTrialDetail resource.
// Format:
// `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/NasTrialDetail"
}
];
}

// Request message for
// [JobService.ListNasTrialDetails][google.cloud.aiplatform.v1.JobService.ListNasTrialDetails].
message ListNasTrialDetailsRequest {
// Required. The name of the NasJob resource.
// Format:
// `projects/{project}/locations/{location}/nasJobs/{nas_job}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/NasJob"
}
];

// The standard list page size.
int32 page_size = 2;

// The standard list page token.
// Typically obtained via
// [ListNasTrialDetailsResponse.next_page_token][google.cloud.aiplatform.v1.ListNasTrialDetailsResponse.next_page_token]
// of the previous
// [JobService.ListNasTrialDetails][google.cloud.aiplatform.v1.JobService.ListNasTrialDetails]
// call.
string page_token = 3;
}

// Response message for
// [JobService.ListNasTrialDetails][google.cloud.aiplatform.v1.JobService.ListNasTrialDetails]
message ListNasTrialDetailsResponse {
// List of top NasTrials in the requested page.
repeated NasTrialDetail nas_trial_details = 1;

// A token to retrieve the next page of results.
// Pass to
// [ListNasTrialDetailsRequest.page_token][google.cloud.aiplatform.v1.ListNasTrialDetailsRequest.page_token]
// to obtain that page.
string next_page_token = 2;
}

// Request message for
// [JobService.CreateBatchPredictionJob][google.cloud.aiplatform.v1.JobService.CreateBatchPredictionJob].
message CreateBatchPredictionJobRequest {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,19 @@ message Model {
[(google.api.field_behavior) = OUTPUT_ONLY];
}

// Contains information about the original Model if this Model is a copy.
message OriginalModelInfo {
// Output only. The resource name of the Model this Model is a copy of,
// including the revision. Format:
// `projects/{project}/locations/{location}/models/{model_id}@{version_id}`
string model = 1 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
type: "aiplatform.googleapis.com/Model"
}
];
}

// Identifies a type of Model's prediction resources.
enum DeploymentResourcesType {
// Should not be used.
Expand Down Expand Up @@ -376,6 +389,11 @@ message Model {
ModelSourceInfo model_source_info = 38
[(google.api.field_behavior) = OUTPUT_ONLY];

// Output only. If this Model is a copy of another Model, this contains info
// about the original.
OriginalModelInfo original_model_info = 34
[(google.api.field_behavior) = OUTPUT_ONLY];

// Output only. The resource name of the Artifact that was created in
// MetadataStore when creating the Model. The Artifact resource name pattern
// is
Expand Down
Loading