Skip to content

Commit

Permalink
docs: removes tinyurl links (#138)
Browse files Browse the repository at this point in the history
* docs: removes tinyurl links

PiperOrigin-RevId: 375484379

Source-Link: googleapis/googleapis@f465a6d

Source-Link: googleapis/googleapis-gen@43c4425

* 🦉 Updates from OwlBot

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] authored May 24, 2021
1 parent 1beedfd commit e3b6b7f
Show file tree
Hide file tree
Showing 107 changed files with 5,115 additions and 865 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -40,8 +40,8 @@ message Annotation {
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

// Required. Google Cloud Storage URI points to a YAML file describing [payload][google.cloud.aiplatform.v1.Annotation.payload]. The
// schema is defined as an
// [OpenAPI 3.0.2 Schema Object](https://tinyurl.com/y538mdwt).
// schema is defined as an [OpenAPI 3.0.2 Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
// The schema files that can be used here are found in
// gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the
// chosen schema must be consistent with the parent Dataset's
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -96,8 +96,8 @@ message BatchPredictionJob {
// containing only `code` and `message` fields.
GcsDestination gcs_destination = 2;

// The BigQuery project location where the output is to be written to.
// In the given project a new dataset is created with name
// The BigQuery project or dataset location where the output is to be
// written to. If project is provided, a new dataset is created with name
// `prediction_<model-display-name>_<job-create-time>`
// where <model-display-name> is made
// BigQuery-dataset-name compatible (for example, most special characters
Expand All @@ -117,9 +117,8 @@ message BatchPredictionJob {
BigQueryDestination bigquery_destination = 3;
}

// Required. The format in which AI Platform gives the predictions, must be one of the
// Required. The format in which Vertex AI gives the predictions, must be one of the
// [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
//
// [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats].
string predictions_format = 1 [(google.api.field_behavior) = REQUIRED];
}
Expand Down Expand Up @@ -188,7 +187,7 @@ message BatchPredictionJob {
BatchDedicatedResources dedicated_resources = 7;

// Immutable. Parameters configuring the batch behavior. Currently only applicable when
// [dedicated_resources][google.cloud.aiplatform.v1.BatchPredictionJob.dedicated_resources] are used (in other cases AI Platform does
// [dedicated_resources][google.cloud.aiplatform.v1.BatchPredictionJob.dedicated_resources] are used (in other cases Vertex AI does
// the tuning itself).
ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(google.api.field_behavior) = IMMUTABLE];

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -93,15 +93,18 @@ message CustomJob {
// Represents the spec of a CustomJob.
message CustomJobSpec {
// Required. The spec of the worker pools including machine type and Docker image.
// All worker pools except the first one are optional and can be skipped by
// providing an empty value.
repeated WorkerPoolSpec worker_pool_specs = 1 [(google.api.field_behavior) = REQUIRED];

// Scheduling options for a CustomJob.
Scheduling scheduling = 3;

// Specifies the service account for workload run-as account.
// Users submitting jobs must have act-as permission on this run-as account.
// If unspecified, the AI Platform Custom Code Service Agent for the
// CustomJob's project is used.
// If unspecified, the [AI Platform Custom Code Service
// Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
// for the CustomJob's project is used.
string service_account = 4;

// The full name of the Compute Engine
Expand All @@ -123,7 +126,7 @@ message CustomJobSpec {
// [id][google.cloud.aiplatform.v1.Trial.id] under its parent HyperparameterTuningJob's
// baseOutputDirectory.
//
// The following AI Platform environment variables will be passed to
// The following Vertex AI environment variables will be passed to
// containers or python modules when this field is set:
//
// For CustomJob:
Expand Down Expand Up @@ -183,10 +186,12 @@ message ContainerSpec {

// The spec of a Python packaged code.
message PythonPackageSpec {
// Required. The URI of a container image in the Container Registry that will run the
// provided python package. AI Platform provides wide range of executor images
// with pre-installed packages to meet users' various use cases. Only one of
// the provided images can be set here.
// Required. The URI of a container image in Artifact Registry that will run the
// provided Python package. Vertex AI provides a wide range of executor
// images with pre-installed packages to meet users' various use cases. See
// the list of [pre-built containers for
// training](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers).
// You must use an image from this list.
string executor_image_uri = 1 [(google.api.field_behavior) = REQUIRED];

// Required. The Google Cloud Storage location of the Python package files which are
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -134,9 +134,9 @@ message DataLabelingJob {
// the EncryptionSpec of the Dataset they are exported to.
EncryptionSpec encryption_spec = 20;

// Parameters that configure the active learning pipeline. Active learning will
// label the data incrementally via several iterations. For every iteration,
// it will select a batch of data based on the sampling strategy.
// Parameters that configure the active learning pipeline. Active learning
// will label the data incrementally via several iterations. For every
// iteration, it will select a batch of data based on the sampling strategy.
ActiveLearningConfig active_learning_config = 21;
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -109,7 +109,8 @@ message ImportDataConfig {

// Required. Points to a YAML file stored on Google Cloud Storage describing the import
// format. Validation will be done against the schema. The schema is defined
// as an [OpenAPI 3.0.2 Schema Object](https://tinyurl.com/y538mdwt).
// as an [OpenAPI 3.0.2 Schema
// Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
string import_schema_uri = 4 [(google.api.field_behavior) = REQUIRED];
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -180,8 +180,7 @@ message UpdateDatasetRequest {
Dataset dataset = 1 [(google.api.field_behavior) = REQUIRED];

// Required. The update mask applies to the resource.
// For the `FieldMask` definition, see
// [FieldMask](https://tinyurl.com/protobufs/google.protobuf#fieldmask).
// For the `FieldMask` definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask].
// Updatable fields:
//
// * `display_name`
Expand Down Expand Up @@ -358,7 +357,6 @@ message ListDataItemsResponse {
message GetAnnotationSpecRequest {
// Required. The name of the AnnotationSpec resource.
// Format:
//
// `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
Expand All @@ -375,7 +373,6 @@ message GetAnnotationSpecRequest {
message ListAnnotationsRequest {
// Required. The resource name of the DataItem to list Annotations from.
// Format:
//
// `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -212,9 +212,7 @@ message UpdateEndpointRequest {
// Required. The Endpoint which replaces the resource on the server.
Endpoint endpoint = 1 [(google.api.field_behavior) = REQUIRED];

// Required. The update mask applies to the resource.
// See
// [FieldMask](https://tinyurl.com/protobufs/google.protobuf#fieldmask).
// Required. The update mask applies to the resource. See [google.protobuf.FieldMask][google.protobuf.FieldMask].
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -60,7 +60,7 @@ message HyperparameterTuningJob {
// The number of failed Trials that need to be seen before failing
// the HyperparameterTuningJob.
//
// If set to 0, AI Platform decides how many Trials must fail
// If set to 0, Vertex AI decides how many Trials must fail
// before the whole job fails.
int32 max_failed_trial_count = 7;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -53,9 +53,9 @@ message BigQuerySource {
message BigQueryDestination {
// Required. BigQuery URI to a project or table, up to 2000 characters long.
//
// When only the project is specified, the Dataset and Table are created.
// When the full table reference is specified, the Dataset must exist and table must
// not exist.
// When only the project is specified, the Dataset and Table is created.
// When the full table reference is specified, the Dataset must exist and
// table must not exist.
//
// Accepted forms:
//
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -35,7 +35,7 @@ option java_multiple_files = true;
option java_outer_classname = "JobServiceProto";
option java_package = "com.google.cloud.aiplatform.v1";

// A service for creating and managing AI Platform's jobs.
// A service for creating and managing Vertex AI's jobs.
service JobService {
option (google.api.default_host) = "aiplatform.googleapis.com";
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
Expand Down Expand Up @@ -362,7 +362,7 @@ message CancelCustomJobRequest {
];
}

// Request message for [DataLabelingJobService.CreateDataLabelingJob][].
// Request message for [JobService.CreateDataLabelingJob][google.cloud.aiplatform.v1.JobService.CreateDataLabelingJob].
message CreateDataLabelingJobRequest {
// Required. The parent of the DataLabelingJob.
// Format: `projects/{project}/locations/{location}`
Expand All @@ -377,11 +377,10 @@ message CreateDataLabelingJobRequest {
DataLabelingJob data_labeling_job = 2 [(google.api.field_behavior) = REQUIRED];
}

// Request message for [DataLabelingJobService.GetDataLabelingJob][].
// Request message for [JobService.GetDataLabelingJob][google.cloud.aiplatform.v1.JobService.GetDataLabelingJob].
message GetDataLabelingJobRequest {
// Required. The name of the DataLabelingJob.
// Format:
//
// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
Expand All @@ -391,7 +390,7 @@ message GetDataLabelingJobRequest {
];
}

// Request message for [DataLabelingJobService.ListDataLabelingJobs][].
// Request message for [JobService.ListDataLabelingJobs][google.cloud.aiplatform.v1.JobService.ListDataLabelingJobs].
message ListDataLabelingJobsRequest {
// Required. The parent of the DataLabelingJob.
// Format: `projects/{project}/locations/{location}`
Expand Down Expand Up @@ -453,7 +452,6 @@ message ListDataLabelingJobsResponse {
message DeleteDataLabelingJobRequest {
// Required. The name of the DataLabelingJob to be deleted.
// Format:
//
// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
Expand All @@ -463,11 +461,10 @@ message DeleteDataLabelingJobRequest {
];
}

// Request message for [DataLabelingJobService.CancelDataLabelingJob][].
// Request message for [JobService.CancelDataLabelingJob][google.cloud.aiplatform.v1.JobService.CancelDataLabelingJob].
message CancelDataLabelingJobRequest {
// Required. The name of the DataLabelingJob.
// Format:
//
// `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
Expand Down Expand Up @@ -496,7 +493,6 @@ message CreateHyperparameterTuningJobRequest {
message GetHyperparameterTuningJobRequest {
// Required. The name of the HyperparameterTuningJob resource.
// Format:
//
// `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
Expand Down Expand Up @@ -565,7 +561,6 @@ message ListHyperparameterTuningJobsResponse {
message DeleteHyperparameterTuningJobRequest {
// Required. The name of the HyperparameterTuningJob resource to be deleted.
// Format:
//
// `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
Expand All @@ -579,7 +574,6 @@ message DeleteHyperparameterTuningJobRequest {
message CancelHyperparameterTuningJobRequest {
// Required. The name of the HyperparameterTuningJob to cancel.
// Format:
//
// `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
Expand Down Expand Up @@ -608,7 +602,6 @@ message CreateBatchPredictionJobRequest {
message GetBatchPredictionJobRequest {
// Required. The name of the BatchPredictionJob resource.
// Format:
//
// `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
Expand Down Expand Up @@ -637,6 +630,8 @@ message ListBatchPredictionJobsRequest {
//
// * `state` supports = and !=.
//
// * `model_display_name` supports = and !=
//
// Some examples of using the filter are:
//
// * `state="JOB_STATE_SUCCEEDED" AND display_name="my_job"`
Expand Down Expand Up @@ -676,7 +671,6 @@ message ListBatchPredictionJobsResponse {
message DeleteBatchPredictionJobRequest {
// Required. The name of the BatchPredictionJob resource to be deleted.
// Format:
//
// `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
Expand All @@ -690,7 +684,6 @@ message DeleteBatchPredictionJobRequest {
message CancelBatchPredictionJobRequest {
// Required. The name of the BatchPredictionJob to cancel.
// Format:
//
// `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020 Google LLC
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
Loading

0 comments on commit e3b6b7f

Please sign in to comment.