feat(aiplatform): update the api

#### aiplatform:v1 The following keys were added: - resources.projects.resources.locations.resources.pipelineJobs.methods.batchCancel (Total Keys: 12) - resources.projects.resources.locations.resources.pipelineJobs.methods.batchDelete (Total Keys: 12) - schemas.GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest (Total Keys: 4) - schemas.GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest (Total Keys: 4) - schemas.GoogleCloudAiplatformV1DatasetVersion.properties.metadata.readOnly (Total Keys: 1) - schemas.GoogleCloudAiplatformV1GenieSource (Total Keys: 3) - schemas.GoogleCloudAiplatformV1Model.properties.baseModelSource.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1ModelBaseModelSource (Total Keys: 4) - schemas.GoogleCloudAiplatformV1ModelGardenSource (Total Keys: 3) #### aiplatform:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.featureOnlineStores.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.locations.resources.featureOnlineStores.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.featureOnlineStores.methods.testIamPermissions (Total Keys: 14) - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.testIamPermissions (Total Keys: 14) - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.cancel (Total Keys: 11) - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.ragCorpora.resources.operations.methods.wait (Total Keys: 14) - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.cancel (Total Keys: 11) - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait (Total Keys: 14) - schemas.CloudAiNlLlmProtoServicePart.properties.documentMetadata.$ref (Total Keys: 1) - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata (Total Keys: 3) - schemas.CloudAiNlLlmProtoServiceRaiSignal.properties.influentialTerms (Total Keys: 2) - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm (Total Keys: 8) - schemas.GoogleCloudAiplatformV1beta1DatasetVersion.properties.metadata.readOnly (Total Keys: 1)
googleapis · Mar 12, 2024 · 8d0fe81 · 8d0fe81
1 parent 052d5fc
commit 8d0fe81
Show file tree

Hide file tree

Showing 17 changed files with 1,906 additions and 37 deletions.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html b/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html
@@ -115,7 +115,7 @@ <h3>Method Details</h3>
   &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DatasetVersion was created.
   &quot;displayName&quot;: &quot;A String&quot;, # The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters.
   &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
-  &quot;metadata&quot;: &quot;&quot;, # Required. Additional information about the DatasetVersion.
+  &quot;metadata&quot;: &quot;&quot;, # Required. Output only. Additional information about the DatasetVersion.
   &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the DatasetVersion.
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DatasetVersion was last updated.
 }
@@ -204,7 +204,7 @@ <h3>Method Details</h3>
   &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DatasetVersion was created.
   &quot;displayName&quot;: &quot;A String&quot;, # The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters.
   &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
-  &quot;metadata&quot;: &quot;&quot;, # Required. Additional information about the DatasetVersion.
+  &quot;metadata&quot;: &quot;&quot;, # Required. Output only. Additional information about the DatasetVersion.
   &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the DatasetVersion.
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DatasetVersion was last updated.
 }</pre>
@@ -236,7 +236,7 @@ <h3>Method Details</h3>
       &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DatasetVersion was created.
       &quot;displayName&quot;: &quot;A String&quot;, # The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters.
       &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
-      &quot;metadata&quot;: &quot;&quot;, # Required. Additional information about the DatasetVersion.
+      &quot;metadata&quot;: &quot;&quot;, # Required. Output only. Additional information about the DatasetVersion.
       &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the DatasetVersion.
       &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DatasetVersion was last updated.
     },

diff --git a/docs/dyn/aiplatform_v1.projects.locations.models.html b/docs/dyn/aiplatform_v1.projects.locations.models.html
diff --git a/docs/dyn/aiplatform_v1.projects.locations.pipelineJobs.html b/docs/dyn/aiplatform_v1.projects.locations.pipelineJobs.html
@@ -79,6 +79,12 @@ <h2>Instance Methods</h2>
 </p>
 <p class="firstline">Returns the operations Resource.</p>
 
+<p class="toc_element">
+  <code><a href="#batchCancel">batchCancel(parent, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.</p>
+<p class="toc_element">
+  <code><a href="#batchDelete">batchDelete(parent, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.</p>
 <p class="toc_element">
   <code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`.</p>
@@ -101,6 +107,94 @@ <h2>Instance Methods</h2>
   <code><a href="#list_next">list_next()</a></code></p>
 <p class="firstline">Retrieves the next page of results.</p>
 <h3>Method Details</h3>
+<div class="method">
+    <code class="details" id="batchCancel">batchCancel(parent, body=None, x__xgafv=None)</code>
+  <pre>Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.
+
+Args:
+  parent: string, Required. The name of the PipelineJobs&#x27; parent resource. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for PipelineService.BatchCancelPipelineJobs.
+  &quot;names&quot;: [ # Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}`
+    &quot;A String&quot;,
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
+    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+  },
+  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+  },
+}</pre>
+</div>
+
+<div class="method">
+    <code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code>
+  <pre>Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.
+
+Args:
+  parent: string, Required. The name of the PipelineJobs&#x27; parent resource. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for PipelineService.BatchDeletePipelineJobs.
+  &quot;names&quot;: [ # Required. The names of the PipelineJobs to delete. A maximum of 32 PipelineJobs can be deleted in a batch. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}`
+    &quot;A String&quot;,
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
+    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+  },
+  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+  },
+}</pre>
+</div>
+
 <div class="method">
     <code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
   <pre>Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`.