docs: changes product name to 'Vertex AI' (#367)

This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/bf4eab41-3a8d-48be-9ae4-3bdcbb6db9aa/targets - [ ] To automatically regenerate this PR, check this box. (May take up to 24 hours.) PiperOrigin-RevId: 374890837 Source-Link: googleapis/googleapis@77da865 docs: correct link to fieldmask
googleapis · Jun 1, 2021 · 0141e15 · 0141e15
1 parent 22c0ae9
commit 0141e15
Show file tree

Hide file tree

Showing 117 changed files with 2,224 additions and 1,851 deletions.
diff --git a/...platform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeaturestoreServiceClient.java b/...platform/src/main/java/com/google/cloud/aiplatform/v1beta1/FeaturestoreServiceClient.java
@@ -579,8 +579,7 @@ public final ListFeaturestoresPagedResponse listFeaturestores(ListFeaturestoresR
    *     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 `&#42;` to override all fields.
    *     <p>Updatable fields:
-   *     <p>&#42; `display_name` &#42; `labels` &#42; `online_serving_config.fixed_node_count` &#42;
-   *     `retention_policy.online_storage_ttl_days`
+   *     <p>&#42; `labels` &#42; `online_serving_config.fixed_node_count`
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
   public final OperationFuture<Featurestore, UpdateFeaturestoreOperationMetadata>

diff --git a/...latform/src/main/java/com/google/cloud/aiplatform/v1beta1/IndexEndpointServiceClient.java b/...latform/src/main/java/com/google/cloud/aiplatform/v1beta1/IndexEndpointServiceClient.java
@@ -42,7 +42,7 @@
 
 // AUTO-GENERATED DOCUMENTATION AND CLASS.
 /**
- * Service Description: A service for managing AI Platform's IndexEndpoints.
+ * Service Description: A service for managing Vertex AI's IndexEndpoints.
  *
  * <p>This class provides the ability to make remote calls to the backing service through method
  * calls that map to API methods. Sample code to get started:

diff --git a/...loud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/IndexServiceClient.java b/...loud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/IndexServiceClient.java
@@ -42,7 +42,7 @@
 
 // AUTO-GENERATED DOCUMENTATION AND CLASS.
 /**
- * Service Description: A service for creating and managing AI Platform's Index resources.
+ * Service Description: A service for creating and managing Vertex AI's Index resources.
  *
  * <p>This class provides the ability to make remote calls to the backing service through method
  * calls that map to API methods. Sample code to get started:
@@ -542,7 +542,7 @@ public final UnaryCallable<ListIndexesRequest, ListIndexesResponse> listIndexesC
    *
    * @param index Required. The Index which updates the resource on the server.
    * @param updateMask The update mask applies to the resource. For the `FieldMask` definition, see
-   *     [FieldMask](https://tinyurl.com/protobufs#google.protobuf.FieldMask).
+   *     [FieldMask](https://tinyurl.com/protobufs/google.protobuf#fieldmask).
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
   public final OperationFuture<Index, UpdateIndexOperationMetadata> updateIndexAsync(

diff --git a/...-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/JobServiceClient.java b/...-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/JobServiceClient.java
@@ -42,7 +42,7 @@
 
 // AUTO-GENERATED DOCUMENTATION AND CLASS.
 /**
- * Service Description: A service for creating and managing AI Platform's jobs.
+ * Service Description: A service for creating and managing Vertex AI's jobs.
  *
  * <p>This class provides the ability to make remote calls to the backing service through method
  * calls that map to API methods. Sample code to get started:

diff --git a/...d-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/MetadataServiceClient.java b/...d-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/MetadataServiceClient.java
@@ -1162,7 +1162,7 @@ public final UnaryCallable<UpdateArtifactRequest, Artifact> updateArtifactCallab
    *     created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}
    * @param context Required. The Context to create.
    * @param contextId The {context} portion of the resource name with the format:
-   *     projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}
+   *     projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}.
    *     If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128
    *     characters in length. Valid characters are /[a-z][0-9]-/. Must be unique across all
    *     Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS,
@@ -1199,7 +1199,7 @@ public final Context createContext(MetadataStoreName parent, Context context, St
    *     created. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}
    * @param context Required. The Context to create.
    * @param contextId The {context} portion of the resource name with the format:
-   *     projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}
+   *     projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}.
    *     If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128
    *     characters in length. Valid characters are /[a-z][0-9]-/. Must be unique across all
    *     Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS,
@@ -1737,7 +1737,11 @@ public final UnaryCallable<DeleteContextRequest, Operation> deleteContextCallabl
    *     belong to. Format:
    *     projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}
    * @param artifacts The resource names of the Artifacts to attribute to the Context.
+   *     <p>Format:
+   *     projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}
    * @param executions The resource names of the Executions to associate with the Context.
+   *     <p>Format:
+   *     projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
   public final AddContextArtifactsAndExecutionsResponse addContextArtifactsAndExecutions(
@@ -1773,7 +1777,11 @@ public final AddContextArtifactsAndExecutionsResponse addContextArtifactsAndExec
    *     belong to. Format:
    *     projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}
    * @param artifacts The resource names of the Artifacts to attribute to the Context.
+   *     <p>Format:
+   *     projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}
    * @param executions The resource names of the Executions to associate with the Context.
+   *     <p>Format:
+   *     projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
   public final AddContextArtifactsAndExecutionsResponse addContextArtifactsAndExecutions(
@@ -1851,7 +1859,7 @@ public final AddContextArtifactsAndExecutionsResponse addContextArtifactsAndExec
   /**
    * Adds a set of Contexts as children to a parent Context. If any of the child Contexts have
    * already been added to the parent Context, they are simply skipped. If this call would create a
-   * cycle or cause any Context to have more than 10 parents, the request will fail with
+   * cycle or cause any Context to have more than 10 parents, the request will fail with an
    * INVALID_ARGUMENT error.
    *
    * <p>Sample code:
@@ -1866,7 +1874,8 @@ public final AddContextArtifactsAndExecutionsResponse addContextArtifactsAndExec
    * }
    * }</pre>
    *
-   * @param context Required. The resource name of the parent Context. Format:
+   * @param context Required. The resource name of the parent Context.
+   *     <p>Format:
    *     projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}
    * @param childContexts The resource names of the child Contexts.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -1885,7 +1894,7 @@ public final AddContextChildrenResponse addContextChildren(
   /**
    * Adds a set of Contexts as children to a parent Context. If any of the child Contexts have
    * already been added to the parent Context, they are simply skipped. If this call would create a
-   * cycle or cause any Context to have more than 10 parents, the request will fail with
+   * cycle or cause any Context to have more than 10 parents, the request will fail with an
    * INVALID_ARGUMENT error.
    *
    * <p>Sample code:
@@ -1900,7 +1909,8 @@ public final AddContextChildrenResponse addContextChildren(
    * }
    * }</pre>
    *
-   * @param context Required. The resource name of the parent Context. Format:
+   * @param context Required. The resource name of the parent Context.
+   *     <p>Format:
    *     projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}
    * @param childContexts The resource names of the child Contexts.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -1919,7 +1929,7 @@ public final AddContextChildrenResponse addContextChildren(
   /**
    * Adds a set of Contexts as children to a parent Context. If any of the child Contexts have
    * already been added to the parent Context, they are simply skipped. If this call would create a
-   * cycle or cause any Context to have more than 10 parents, the request will fail with
+   * cycle or cause any Context to have more than 10 parents, the request will fail with an
    * INVALID_ARGUMENT error.
    *
    * <p>Sample code:
@@ -1948,7 +1958,7 @@ public final AddContextChildrenResponse addContextChildren(AddContextChildrenReq
   /**
    * Adds a set of Contexts as children to a parent Context. If any of the child Contexts have
    * already been added to the parent Context, they are simply skipped. If this call would create a
-   * cycle or cause any Context to have more than 10 parents, the request will fail with
+   * cycle or cause any Context to have more than 10 parents, the request will fail with an
    * INVALID_ARGUMENT error.
    *
    * <p>Sample code:
@@ -2544,9 +2554,9 @@ public final UnaryCallable<UpdateExecutionRequest, Execution> updateExecutionCal
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Adds Events for denoting whether each Artifact was an input or output for a given Execution. If
-   * any Events already exist between the Execution and any of the specified Artifacts they are
-   * simply skipped.
+   * Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an
+   * input or output for an Execution. If an Event already exists between the Execution and the
+   * Artifact, the Event is skipped.
    *
    * <p>Sample code:
    *
@@ -2578,9 +2588,9 @@ public final AddExecutionEventsResponse addExecutionEvents(
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Adds Events for denoting whether each Artifact was an input or output for a given Execution. If
-   * any Events already exist between the Execution and any of the specified Artifacts they are
-   * simply skipped.
+   * Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an
+   * input or output for an Execution. If an Event already exists between the Execution and the
+   * Artifact, the Event is skipped.
    *
    * <p>Sample code:
    *
@@ -2608,9 +2618,9 @@ public final AddExecutionEventsResponse addExecutionEvents(String execution, Lis
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Adds Events for denoting whether each Artifact was an input or output for a given Execution. If
-   * any Events already exist between the Execution and any of the specified Artifacts they are
-   * simply skipped.
+   * Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an
+   * input or output for an Execution. If an Event already exists between the Execution and the
+   * Artifact, the Event is skipped.
    *
    * <p>Sample code:
    *
@@ -2636,9 +2646,9 @@ public final AddExecutionEventsResponse addExecutionEvents(AddExecutionEventsReq
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Adds Events for denoting whether each Artifact was an input or output for a given Execution. If
-   * any Events already exist between the Execution and any of the specified Artifacts they are
-   * simply skipped.
+   * Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an
+   * input or output for an Execution. If an Event already exists between the Execution and the
+   * Artifact, the Event is skipped.
    *
    * <p>Sample code:
    *
@@ -2773,7 +2783,7 @@ public final LineageSubgraph queryExecutionInputsAndOutputs(
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Creates an MetadataSchema.
+   * Creates a MetadataSchema.
    *
    * <p>Sample code:
    *
@@ -2813,7 +2823,7 @@ public final MetadataSchema createMetadataSchema(
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Creates an MetadataSchema.
+   * Creates a MetadataSchema.
    *
    * <p>Sample code:
    *
@@ -2853,7 +2863,7 @@ public final MetadataSchema createMetadataSchema(
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Creates an MetadataSchema.
+   * Creates a MetadataSchema.
    *
    * <p>Sample code:
    *
@@ -2879,7 +2889,7 @@ public final MetadataSchema createMetadataSchema(CreateMetadataSchemaRequest req
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Creates an MetadataSchema.
+   * Creates a MetadataSchema.
    *
    * <p>Sample code:
    *

diff --git a/...-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/MigrationServiceClient.java b/...-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/MigrationServiceClient.java
@@ -41,7 +41,7 @@
 // AUTO-GENERATED DOCUMENTATION AND CLASS.
 /**
  * Service Description: A service that migrates resources from automl.googleapis.com,
- * datalabeling.googleapis.com and ml.googleapis.com to AI Platform.
+ * datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.
  *
  * <p>This class provides the ability to make remote calls to the backing service through method
  * calls that map to API methods. Sample code to get started:
@@ -173,7 +173,7 @@ public final OperationsClient getOperationsClient() {
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
    * Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and
-   * ml.googleapis.com that can be migrated to AI Platform's given location.
+   * ml.googleapis.com that can be migrated to Vertex AI's given location.
    *
    * <p>Sample code:
    *
@@ -188,7 +188,7 @@ public final OperationsClient getOperationsClient() {
    * }</pre>
    *
    * @param parent Required. The location that the migratable resources should be searched from.
-   *     It's the AI Platform location that the resources can be migrated to, not the resources'
+   *     It's the Vertex AI location that the resources can be migrated to, not the resources'
    *     original location. Format: `projects/{project}/locations/{location}`
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
@@ -204,7 +204,7 @@ public final SearchMigratableResourcesPagedResponse searchMigratableResources(
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
    * Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and
-   * ml.googleapis.com that can be migrated to AI Platform's given location.
+   * ml.googleapis.com that can be migrated to Vertex AI's given location.
    *
    * <p>Sample code:
    *
@@ -219,7 +219,7 @@ public final SearchMigratableResourcesPagedResponse searchMigratableResources(
    * }</pre>
    *
    * @param parent Required. The location that the migratable resources should be searched from.
-   *     It's the AI Platform location that the resources can be migrated to, not the resources'
+   *     It's the Vertex AI location that the resources can be migrated to, not the resources'
    *     original location. Format: `projects/{project}/locations/{location}`
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
@@ -232,7 +232,7 @@ public final SearchMigratableResourcesPagedResponse searchMigratableResources(St
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
    * Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and
-   * ml.googleapis.com that can be migrated to AI Platform's given location.
+   * ml.googleapis.com that can be migrated to Vertex AI's given location.
    *
    * <p>Sample code:
    *
@@ -263,7 +263,7 @@ public final SearchMigratableResourcesPagedResponse searchMigratableResources(
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
    * Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and
-   * ml.googleapis.com that can be migrated to AI Platform's given location.
+   * ml.googleapis.com that can be migrated to Vertex AI's given location.
    *
    * <p>Sample code:
    *
@@ -294,7 +294,7 @@ public final SearchMigratableResourcesPagedResponse searchMigratableResources(
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
    * Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and
-   * ml.googleapis.com that can be migrated to AI Platform's given location.
+   * ml.googleapis.com that can be migrated to Vertex AI's given location.
    *
    * <p>Sample code:
    *
@@ -331,7 +331,7 @@ public final SearchMigratableResourcesPagedResponse searchMigratableResources(
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
    * Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and
-   * datalabeling.googleapis.com to AI Platform (Unified).
+   * datalabeling.googleapis.com to Vertex AI.
    *
    * <p>Sample code:
    *
@@ -366,7 +366,7 @@ public final SearchMigratableResourcesPagedResponse searchMigratableResources(
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
    * Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and
-   * datalabeling.googleapis.com to AI Platform (Unified).
+   * datalabeling.googleapis.com to Vertex AI.
    *
    * <p>Sample code:
    *
@@ -401,7 +401,7 @@ public final SearchMigratableResourcesPagedResponse searchMigratableResources(
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
    * Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and
-   * datalabeling.googleapis.com to AI Platform (Unified).
+   * datalabeling.googleapis.com to Vertex AI.
    *
    * <p>Sample code:
    *
@@ -429,7 +429,7 @@ public final SearchMigratableResourcesPagedResponse searchMigratableResources(
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
    * Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and
-   * datalabeling.googleapis.com to AI Platform (Unified).
+   * datalabeling.googleapis.com to Vertex AI.
    *
    * <p>Sample code:
    *
@@ -459,7 +459,7 @@ public final SearchMigratableResourcesPagedResponse searchMigratableResources(
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
    * Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and
-   * datalabeling.googleapis.com to AI Platform (Unified).
+   * datalabeling.googleapis.com to Vertex AI.
    *
    * <p>Sample code:
    *