Namespace Google.Apis.Aiplatform.v1
Classes
AiplatformBaseServiceRequest<TResponse>
A base abstract class for Aiplatform requests.
AiplatformService
The Aiplatform Service.
AiplatformService.Scope
Available OAuth 2.0 scopes for use with the Vertex AI API.
AiplatformService.ScopeConstants
Available OAuth 2.0 scope constants for use with the Vertex AI API.
DatasetsResource
The "datasets" collection of methods.
DatasetsResource.CreateRequest
Creates a Dataset.
DatasetsResource.DatasetVersionsResource
The "datasetVersions" collection of methods.
DatasetsResource.DatasetVersionsResource.CreateRequest
Create a version from a Dataset.
DatasetsResource.DatasetVersionsResource.DeleteRequest
Deletes a Dataset version.
DatasetsResource.DatasetVersionsResource.GetRequest
Gets a Dataset version.
DatasetsResource.DatasetVersionsResource.ListRequest
Lists DatasetVersions in a Dataset.
DatasetsResource.DatasetVersionsResource.PatchRequest
Updates a DatasetVersion.
DatasetsResource.DatasetVersionsResource.RestoreRequest
Restores a dataset version.
DatasetsResource.DeleteRequest
Deletes a Dataset.
DatasetsResource.GetRequest
Gets a Dataset.
DatasetsResource.ListRequest
Lists Datasets in a Location.
DatasetsResource.PatchRequest
Updates a Dataset.
EndpointsResource
The "endpoints" collection of methods.
EndpointsResource.ComputeTokensRequest
Return a list of tokens based on the input text.
EndpointsResource.CountTokensRequest
Perform a token counting.
EndpointsResource.GenerateContentRequest
Generate content with multimodal inputs.
EndpointsResource.StreamGenerateContentRequest
Generate content with multimodal inputs with streaming support.
ProjectsResource
The "projects" collection of methods.
ProjectsResource.LocationsResource
The "locations" collection of methods.
ProjectsResource.LocationsResource.BatchPredictionJobsResource
The "batchPredictionJobs" collection of methods.
ProjectsResource.LocationsResource.BatchPredictionJobsResource.CancelRequest
Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server
makes the best effort to cancel the job, but success is not guaranteed. Clients can use
JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or
whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob
is not deleted;instead its BatchPredictionJob.state is set to CANCELLED. Any files already
outputted by the job are not deleted.
ProjectsResource.LocationsResource.BatchPredictionJobsResource.CreateRequest
Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.
ProjectsResource.LocationsResource.BatchPredictionJobsResource.DeleteRequest
Deletes a BatchPredictionJob. Can only be called on jobs that already finished.
ProjectsResource.LocationsResource.BatchPredictionJobsResource.GetRequest
Gets a BatchPredictionJob
ProjectsResource.LocationsResource.BatchPredictionJobsResource.ListRequest
Lists BatchPredictionJobs in a Location.
ProjectsResource.LocationsResource.CustomJobsResource
The "customJobs" collection of methods.
ProjectsResource.LocationsResource.CustomJobsResource.CancelRequest
Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best
effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or
other methods to check whether the cancellation succeeded or whether the job completed despite
cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job
with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED,
and CustomJob.state is set to CANCELLED.
ProjectsResource.LocationsResource.CustomJobsResource.CreateRequest
Creates a CustomJob. A created CustomJob right away will be attempted to be run.
ProjectsResource.LocationsResource.CustomJobsResource.DeleteRequest
Deletes a CustomJob.
ProjectsResource.LocationsResource.CustomJobsResource.GetRequest
Gets a CustomJob.
ProjectsResource.LocationsResource.CustomJobsResource.ListRequest
Lists CustomJobs in a Location.
ProjectsResource.LocationsResource.CustomJobsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.CustomJobsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.CustomJobsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.CustomJobsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.CustomJobsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.CustomJobsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.DataLabelingJobsResource
The "dataLabelingJobs" collection of methods.
ProjectsResource.LocationsResource.DataLabelingJobsResource.CancelRequest
Cancels a DataLabelingJob. Success of cancellation is not guaranteed.
ProjectsResource.LocationsResource.DataLabelingJobsResource.CreateRequest
Creates a DataLabelingJob.
ProjectsResource.LocationsResource.DataLabelingJobsResource.DeleteRequest
Deletes a DataLabelingJob.
ProjectsResource.LocationsResource.DataLabelingJobsResource.GetRequest
Gets a DataLabelingJob.
ProjectsResource.LocationsResource.DataLabelingJobsResource.ListRequest
Lists DataLabelingJobs in a Location.
ProjectsResource.LocationsResource.DataLabelingJobsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.DataLabelingJobsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.DataLabelingJobsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.DataLabelingJobsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.DataLabelingJobsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.DataLabelingJobsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.DatasetsResource
The "datasets" collection of methods.
ProjectsResource.LocationsResource.DatasetsResource.AnnotationSpecsResource
The "annotationSpecs" collection of methods.
ProjectsResource.LocationsResource.DatasetsResource.AnnotationSpecsResource.GetRequest
Gets an AnnotationSpec.
ProjectsResource.LocationsResource.DatasetsResource.AnnotationSpecsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.DatasetsResource.AnnotationSpecsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort
to cancel the operation, but success is not guaranteed. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation
or other methods to check whether the cancellation succeeded or whether the operation
completed despite cancellation. On successful cancellation, the operation is not deleted;
instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code
of 1, corresponding to Code.CANCELLED.
ProjectsResource.LocationsResource.DatasetsResource.AnnotationSpecsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer
interested in the operation result. It does not cancel the operation. If the server doesn't
support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.DatasetsResource.AnnotationSpecsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.DatasetsResource.AnnotationSpecsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.DatasetsResource.AnnotationSpecsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified
timeout, returning the latest state. If the operation is already done, the latest state is
immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout,
the HTTP/RPC timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may
return the latest state before the specified timeout (including immediately), meaning even
an immediate response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.DatasetsResource.CreateRequest
Creates a Dataset.
ProjectsResource.LocationsResource.DatasetsResource.DataItemsResource
The "dataItems" collection of methods.
ProjectsResource.LocationsResource.DatasetsResource.DataItemsResource.AnnotationsResource
The "annotations" collection of methods.
ProjectsResource.LocationsResource.DatasetsResource.DataItemsResource.AnnotationsResource.ListRequest
Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.
ProjectsResource.LocationsResource.DatasetsResource.DataItemsResource.AnnotationsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.DatasetsResource.DataItemsResource.AnnotationsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best
effort to cancel the operation, but success is not guaranteed. If the server doesn't
support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use
Operations.GetOperation or other methods to check whether the cancellation succeeded or
whether the operation completed despite cancellation. On successful cancellation, the
operation is not deleted; instead, it becomes an operation with an Operation.error value
with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
ProjectsResource.LocationsResource.DatasetsResource.DataItemsResource.AnnotationsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer
interested in the operation result. It does not cancel the operation. If the server
doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.DatasetsResource.DataItemsResource.AnnotationsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.DatasetsResource.DataItemsResource.AnnotationsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.DatasetsResource.DataItemsResource.AnnotationsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified
timeout, returning the latest state. If the operation is already done, the latest state
is immediately returned. If the timeout specified is greater than the default HTTP/RPC
timeout, the HTTP/RPC timeout is used. If the server does not support this method, it
returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort
basis. It may return the latest state before the specified timeout (including
immediately), meaning even an immediate response is no guarantee that the operation is
done.
ProjectsResource.LocationsResource.DatasetsResource.DataItemsResource.ListRequest
Lists DataItems in a Dataset.
ProjectsResource.LocationsResource.DatasetsResource.DataItemsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.DatasetsResource.DataItemsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort
to cancel the operation, but success is not guaranteed. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation
or other methods to check whether the cancellation succeeded or whether the operation
completed despite cancellation. On successful cancellation, the operation is not deleted;
instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code
of 1, corresponding to Code.CANCELLED.
ProjectsResource.LocationsResource.DatasetsResource.DataItemsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer
interested in the operation result. It does not cancel the operation. If the server doesn't
support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.DatasetsResource.DataItemsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.DatasetsResource.DataItemsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.DatasetsResource.DataItemsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified
timeout, returning the latest state. If the operation is already done, the latest state is
immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout,
the HTTP/RPC timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may
return the latest state before the specified timeout (including immediately), meaning even
an immediate response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.DatasetsResource.DatasetVersionsResource
The "datasetVersions" collection of methods.
ProjectsResource.LocationsResource.DatasetsResource.DatasetVersionsResource.CreateRequest
Create a version from a Dataset.
ProjectsResource.LocationsResource.DatasetsResource.DatasetVersionsResource.DeleteRequest
Deletes a Dataset version.
ProjectsResource.LocationsResource.DatasetsResource.DatasetVersionsResource.GetRequest
Gets a Dataset version.
ProjectsResource.LocationsResource.DatasetsResource.DatasetVersionsResource.ListRequest
Lists DatasetVersions in a Dataset.
ProjectsResource.LocationsResource.DatasetsResource.DatasetVersionsResource.PatchRequest
Updates a DatasetVersion.
ProjectsResource.LocationsResource.DatasetsResource.DatasetVersionsResource.RestoreRequest
Restores a dataset version.
ProjectsResource.LocationsResource.DatasetsResource.DeleteRequest
Deletes a Dataset.
ProjectsResource.LocationsResource.DatasetsResource.ExportRequest
Exports data from a Dataset.
ProjectsResource.LocationsResource.DatasetsResource.GetRequest
Gets a Dataset.
ProjectsResource.LocationsResource.DatasetsResource.ImportRequest
Imports data into a Dataset.
ProjectsResource.LocationsResource.DatasetsResource.ListRequest
Lists Datasets in a Location.
ProjectsResource.LocationsResource.DatasetsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.DatasetsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.DatasetsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.DatasetsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.DatasetsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.DatasetsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.DatasetsResource.PatchRequest
Updates a Dataset.
ProjectsResource.LocationsResource.DatasetsResource.SavedQueriesResource
The "savedQueries" collection of methods.
ProjectsResource.LocationsResource.DatasetsResource.SavedQueriesResource.DeleteRequest
Deletes a SavedQuery.
ProjectsResource.LocationsResource.DatasetsResource.SavedQueriesResource.ListRequest
Lists SavedQueries in a Dataset.
ProjectsResource.LocationsResource.DatasetsResource.SavedQueriesResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.DatasetsResource.SavedQueriesResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort
to cancel the operation, but success is not guaranteed. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation
or other methods to check whether the cancellation succeeded or whether the operation
completed despite cancellation. On successful cancellation, the operation is not deleted;
instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code
of 1, corresponding to Code.CANCELLED.
ProjectsResource.LocationsResource.DatasetsResource.SavedQueriesResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer
interested in the operation result. It does not cancel the operation. If the server doesn't
support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.DatasetsResource.SavedQueriesResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.DatasetsResource.SavedQueriesResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.DatasetsResource.SavedQueriesResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified
timeout, returning the latest state. If the operation is already done, the latest state is
immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout,
the HTTP/RPC timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may
return the latest state before the specified timeout (including immediately), meaning even
an immediate response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.DatasetsResource.SearchDataItemsRequest
Searches DataItems in a Dataset.
ProjectsResource.LocationsResource.DeploymentResourcePoolsResource
The "deploymentResourcePools" collection of methods.
ProjectsResource.LocationsResource.DeploymentResourcePoolsResource.CreateRequest
Create a DeploymentResourcePool.
ProjectsResource.LocationsResource.DeploymentResourcePoolsResource.DeleteRequest
Delete a DeploymentResourcePool.
ProjectsResource.LocationsResource.DeploymentResourcePoolsResource.GetRequest
Get a DeploymentResourcePool.
ProjectsResource.LocationsResource.DeploymentResourcePoolsResource.ListRequest
List DeploymentResourcePools in a location.
ProjectsResource.LocationsResource.DeploymentResourcePoolsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.DeploymentResourcePoolsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.DeploymentResourcePoolsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.DeploymentResourcePoolsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.DeploymentResourcePoolsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.DeploymentResourcePoolsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.DeploymentResourcePoolsResource.PatchRequest
Update a DeploymentResourcePool.
ProjectsResource.LocationsResource.DeploymentResourcePoolsResource.QueryDeployedModelsRequest
List DeployedModels that have been deployed on this DeploymentResourcePool.
ProjectsResource.LocationsResource.EndpointsResource
The "endpoints" collection of methods.
ProjectsResource.LocationsResource.EndpointsResource.ChatResource
The "chat" collection of methods.
ProjectsResource.LocationsResource.EndpointsResource.ChatResource.CompletionsRequest
Exposes an OpenAI-compatible endpoint for chat completions.
ProjectsResource.LocationsResource.EndpointsResource.ComputeTokensRequest
Return a list of tokens based on the input text.
ProjectsResource.LocationsResource.EndpointsResource.CountTokensRequest
Perform a token counting.
ProjectsResource.LocationsResource.EndpointsResource.CreateRequest
Creates an Endpoint.
ProjectsResource.LocationsResource.EndpointsResource.DeleteRequest
Deletes an Endpoint.
ProjectsResource.LocationsResource.EndpointsResource.DeployModelRequest
Deploys a Model into this Endpoint, creating a DeployedModel within it.
ProjectsResource.LocationsResource.EndpointsResource.DirectPredictRequest
Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.
ProjectsResource.LocationsResource.EndpointsResource.DirectRawPredictRequest
Perform an unary online prediction request to a gRPC model server for custom containers.
ProjectsResource.LocationsResource.EndpointsResource.ExplainRequest
Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated.
ProjectsResource.LocationsResource.EndpointsResource.GenerateContentRequest
Generate content with multimodal inputs.
ProjectsResource.LocationsResource.EndpointsResource.GetRequest
Gets an Endpoint.
ProjectsResource.LocationsResource.EndpointsResource.ListRequest
Lists Endpoints in a Location.
ProjectsResource.LocationsResource.EndpointsResource.MutateDeployedModelRequest
Updates an existing deployed model. Updatable fields include min_replica_count,
max_replica_count, autoscaling_metric_specs, disable_container_logging (v1 only), and
enable_container_logging (v1beta1 only).
ProjectsResource.LocationsResource.EndpointsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.EndpointsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.EndpointsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.EndpointsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.EndpointsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.EndpointsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.EndpointsResource.PatchRequest
Updates an Endpoint.
ProjectsResource.LocationsResource.EndpointsResource.PredictRequest
Perform an online prediction.
ProjectsResource.LocationsResource.EndpointsResource.RawPredictRequest
Perform an online prediction with an arbitrary HTTP payload. The response includes the following
HTTP headers: * X-Vertex-AI-Endpoint-Id: ID of the Endpoint that served this prediction. *
X-Vertex-AI-Deployed-Model-Id: ID of the Endpoint's DeployedModel that served this prediction.
ProjectsResource.LocationsResource.EndpointsResource.ServerStreamingPredictRequest
Perform a server-side streaming online prediction request for Vertex LLM streaming.
ProjectsResource.LocationsResource.EndpointsResource.StreamGenerateContentRequest
Generate content with multimodal inputs with streaming support.
ProjectsResource.LocationsResource.EndpointsResource.StreamRawPredictRequest
Perform a streaming online prediction with an arbitrary HTTP payload.
ProjectsResource.LocationsResource.EndpointsResource.UndeployModelRequest
Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.
ProjectsResource.LocationsResource.EvaluateInstancesRequest
Evaluates instances based on a given metric.
ProjectsResource.LocationsResource.FeatureGroupsResource
The "featureGroups" collection of methods.
ProjectsResource.LocationsResource.FeatureGroupsResource.CreateRequest
Creates a new FeatureGroup in a given project and location.
ProjectsResource.LocationsResource.FeatureGroupsResource.DeleteRequest
Deletes a single FeatureGroup.
ProjectsResource.LocationsResource.FeatureGroupsResource.FeaturesResource
The "features" collection of methods.
ProjectsResource.LocationsResource.FeatureGroupsResource.FeaturesResource.BatchCreateRequest
Creates a batch of Features in a given FeatureGroup.
ProjectsResource.LocationsResource.FeatureGroupsResource.FeaturesResource.CreateRequest
Creates a new Feature in a given FeatureGroup.
ProjectsResource.LocationsResource.FeatureGroupsResource.FeaturesResource.DeleteRequest
Deletes a single Feature.
ProjectsResource.LocationsResource.FeatureGroupsResource.FeaturesResource.GetRequest
Gets details of a single Feature.
ProjectsResource.LocationsResource.FeatureGroupsResource.FeaturesResource.ListRequest
Lists Features in a given FeatureGroup.
ProjectsResource.LocationsResource.FeatureGroupsResource.FeaturesResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.FeatureGroupsResource.FeaturesResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer
interested in the operation result. It does not cancel the operation. If the server doesn't
support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.FeatureGroupsResource.FeaturesResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.FeatureGroupsResource.FeaturesResource.OperationsResource.ListWaitRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.FeatureGroupsResource.FeaturesResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified
timeout, returning the latest state. If the operation is already done, the latest state is
immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout,
the HTTP/RPC timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may
return the latest state before the specified timeout (including immediately), meaning even
an immediate response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.FeatureGroupsResource.FeaturesResource.PatchRequest
Updates the parameters of a single Feature.
ProjectsResource.LocationsResource.FeatureGroupsResource.GetRequest
Gets details of a single FeatureGroup.
ProjectsResource.LocationsResource.FeatureGroupsResource.ListRequest
Lists FeatureGroups in a given project and location.
ProjectsResource.LocationsResource.FeatureGroupsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.FeatureGroupsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.FeatureGroupsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.FeatureGroupsResource.OperationsResource.ListWaitRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.FeatureGroupsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.FeatureGroupsResource.PatchRequest
Updates the parameters of a single FeatureGroup.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource
The "featureOnlineStores" collection of methods.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.CreateRequest
Creates a new FeatureOnlineStore in a given project and location.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.DeleteRequest
Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource
The "featureViews" collection of methods.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.CreateRequest
Creates a new FeatureView in a given FeatureOnlineStore.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.DeleteRequest
Deletes a single FeatureView.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.FeatureViewSyncsResource
The "featureViewSyncs" collection of methods.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.FeatureViewSyncsResource.GetRequest
Gets details of a single FeatureViewSync.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.FeatureViewSyncsResource.ListRequest
Lists FeatureViewSyncs in a given FeatureView.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.FetchFeatureValuesRequest
Fetch feature values under a FeatureView.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.GetIamPolicyRequest
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.GetRequest
Gets details of a single FeatureView.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.ListRequest
Lists FeatureViews in a given FeatureOnlineStore.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer
interested in the operation result. It does not cancel the operation. If the server doesn't
support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.OperationsResource.ListWaitRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified
timeout, returning the latest state. If the operation is already done, the latest state is
immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout,
the HTTP/RPC timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may
return the latest state before the specified timeout (including immediately), meaning even
an immediate response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.PatchRequest
Updates the parameters of a single FeatureView.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.SearchNearestEntitiesRequest
Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.SetIamPolicyRequest
Sets the access control policy on the specified resource. Replaces any existing policy. Can
return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.SyncRequest
Triggers on-demand sync for the FeatureView.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.FeatureViewsResource.TestIamPermissionsRequest
Returns permissions that a caller has on the specified resource. If the resource does not exist,
this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is
designed to be used for building permission-aware UIs and command-line tools, not for
authorization checking. This operation may "fail open" without warning.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.GetIamPolicyRequest
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.GetRequest
Gets details of a single FeatureOnlineStore.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.ListRequest
Lists FeatureOnlineStores in a given project and location.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.OperationsResource.ListWaitRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.PatchRequest
Updates the parameters of a single FeatureOnlineStore.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.SetIamPolicyRequest
Sets the access control policy on the specified resource. Replaces any existing policy. Can return
NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectsResource.LocationsResource.FeatureOnlineStoresResource.TestIamPermissionsRequest
Returns permissions that a caller has on the specified resource. If the resource does not exist,
this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is
designed to be used for building permission-aware UIs and command-line tools, not for authorization
checking. This operation may "fail open" without warning.
ProjectsResource.LocationsResource.FeaturestoresResource
The "featurestores" collection of methods.
ProjectsResource.LocationsResource.FeaturestoresResource.BatchReadFeatureValuesRequest
Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.
ProjectsResource.LocationsResource.FeaturestoresResource.CreateRequest
Creates a new Featurestore in a given project and location.
ProjectsResource.LocationsResource.FeaturestoresResource.DeleteRequest
Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or force must be
set to true for the request to succeed.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource
The "entityTypes" collection of methods.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.CreateRequest
Creates a new EntityType in a given Featurestore.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.DeleteFeatureValuesRequest
Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.DeleteRequest
Deletes a single EntityType. The EntityType must not have any Features or force must be set to
true for the request to succeed.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.ExportFeatureValuesRequest
Exports Feature values from all the entities of a target EntityType.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.FeaturesResource
The "features" collection of methods.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.FeaturesResource.BatchCreateRequest
Creates a batch of Features in a given EntityType.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.FeaturesResource.CreateRequest
Creates a new Feature in a given EntityType.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.FeaturesResource.DeleteRequest
Deletes a single Feature.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.FeaturesResource.GetRequest
Gets details of a single Feature.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.FeaturesResource.ListRequest
Lists Features in a given EntityType.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.FeaturesResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.FeaturesResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best
effort to cancel the operation, but success is not guaranteed. If the server doesn't
support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use
Operations.GetOperation or other methods to check whether the cancellation succeeded or
whether the operation completed despite cancellation. On successful cancellation, the
operation is not deleted; instead, it becomes an operation with an Operation.error value
with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.FeaturesResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer
interested in the operation result. It does not cancel the operation. If the server
doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.FeaturesResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.FeaturesResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.FeaturesResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified
timeout, returning the latest state. If the operation is already done, the latest state
is immediately returned. If the timeout specified is greater than the default HTTP/RPC
timeout, the HTTP/RPC timeout is used. If the server does not support this method, it
returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort
basis. It may return the latest state before the specified timeout (including
immediately), meaning even an immediate response is no guarantee that the operation is
done.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.FeaturesResource.PatchRequest
Updates the parameters of a single Feature.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.GetIamPolicyRequest
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.GetRequest
Gets details of a single EntityType.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.ImportFeatureValuesRequest
Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.ListRequest
Lists EntityTypes in a given Featurestore.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort
to cancel the operation, but success is not guaranteed. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation
or other methods to check whether the cancellation succeeded or whether the operation
completed despite cancellation. On successful cancellation, the operation is not deleted;
instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code
of 1, corresponding to Code.CANCELLED.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer
interested in the operation result. It does not cancel the operation. If the server doesn't
support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified
timeout, returning the latest state. If the operation is already done, the latest state is
immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout,
the HTTP/RPC timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may
return the latest state before the specified timeout (including immediately), meaning even
an immediate response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.PatchRequest
Updates the parameters of a single EntityType.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.ReadFeatureValuesRequest
Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.SetIamPolicyRequest
Sets the access control policy on the specified resource. Replaces any existing policy. Can
return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.StreamingReadFeatureValuesRequest
Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.TestIamPermissionsRequest
Returns permissions that a caller has on the specified resource. If the resource does not exist,
this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is
designed to be used for building permission-aware UIs and command-line tools, not for
authorization checking. This operation may "fail open" without warning.
ProjectsResource.LocationsResource.FeaturestoresResource.EntityTypesResource.WriteFeatureValuesRequest
Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.
ProjectsResource.LocationsResource.FeaturestoresResource.GetIamPolicyRequest
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectsResource.LocationsResource.FeaturestoresResource.GetRequest
Gets details of a single Featurestore.
ProjectsResource.LocationsResource.FeaturestoresResource.ListRequest
Lists Featurestores in a given project and location.
ProjectsResource.LocationsResource.FeaturestoresResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.FeaturestoresResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.FeaturestoresResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.FeaturestoresResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.FeaturestoresResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.FeaturestoresResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.FeaturestoresResource.PatchRequest
Updates the parameters of a single Featurestore.
ProjectsResource.LocationsResource.FeaturestoresResource.SearchFeaturesRequest
Searches Features matching a query in a given project.
ProjectsResource.LocationsResource.FeaturestoresResource.SetIamPolicyRequest
Sets the access control policy on the specified resource. Replaces any existing policy. Can return
NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectsResource.LocationsResource.FeaturestoresResource.TestIamPermissionsRequest
Returns permissions that a caller has on the specified resource. If the resource does not exist,
this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is
designed to be used for building permission-aware UIs and command-line tools, not for authorization
checking. This operation may "fail open" without warning.
ProjectsResource.LocationsResource.GetRequest
Gets information about a location.
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource
The "hyperparameterTuningJobs" collection of methods.
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.CancelRequest
Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob.
The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use
JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded
or whether the job completed despite cancellation. On successful cancellation, the
HyperparameterTuningJob is not deleted; instead it becomes a job with a
HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED, and HyperparameterTuningJob.state is set to CANCELLED.
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.CreateRequest
Creates a HyperparameterTuningJob
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.DeleteRequest
Deletes a HyperparameterTuningJob.
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.GetRequest
Gets a HyperparameterTuningJob
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.ListRequest
Lists HyperparameterTuningJobs in a Location.
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.HyperparameterTuningJobsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.IndexEndpointsResource
The "indexEndpoints" collection of methods.
ProjectsResource.LocationsResource.IndexEndpointsResource.CreateRequest
Creates an IndexEndpoint.
ProjectsResource.LocationsResource.IndexEndpointsResource.DeleteRequest
Deletes an IndexEndpoint.
ProjectsResource.LocationsResource.IndexEndpointsResource.DeployIndexRequest
Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.
ProjectsResource.LocationsResource.IndexEndpointsResource.FindNeighborsRequest
Finds the nearest neighbors of each vector within the request.
ProjectsResource.LocationsResource.IndexEndpointsResource.GetRequest
Gets an IndexEndpoint.
ProjectsResource.LocationsResource.IndexEndpointsResource.ListRequest
Lists IndexEndpoints in a Location.
ProjectsResource.LocationsResource.IndexEndpointsResource.MutateDeployedIndexRequest
Update an existing DeployedIndex under an IndexEndpoint.
ProjectsResource.LocationsResource.IndexEndpointsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.IndexEndpointsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.IndexEndpointsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.IndexEndpointsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.IndexEndpointsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.IndexEndpointsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.IndexEndpointsResource.PatchRequest
Updates an IndexEndpoint.
ProjectsResource.LocationsResource.IndexEndpointsResource.ReadIndexDatapointsRequest
Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.
ProjectsResource.LocationsResource.IndexEndpointsResource.UndeployIndexRequest
Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.
ProjectsResource.LocationsResource.IndexesResource
The "indexes" collection of methods.
ProjectsResource.LocationsResource.IndexesResource.CreateRequest
Creates an Index.
ProjectsResource.LocationsResource.IndexesResource.DeleteRequest
Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.
ProjectsResource.LocationsResource.IndexesResource.GetRequest
Gets an Index.
ProjectsResource.LocationsResource.IndexesResource.ListRequest
Lists Indexes in a Location.
ProjectsResource.LocationsResource.IndexesResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.IndexesResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.IndexesResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.IndexesResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.IndexesResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.IndexesResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.IndexesResource.PatchRequest
Updates an Index.
ProjectsResource.LocationsResource.IndexesResource.RemoveDatapointsRequest
Remove Datapoints from an Index.
ProjectsResource.LocationsResource.IndexesResource.UpsertDatapointsRequest
Add/update Datapoints into an Index.
ProjectsResource.LocationsResource.ListRequest
Lists information about the supported locations for this service.
ProjectsResource.LocationsResource.MetadataStoresResource
The "metadataStores" collection of methods.
ProjectsResource.LocationsResource.MetadataStoresResource.ArtifactsResource
The "artifacts" collection of methods.
ProjectsResource.LocationsResource.MetadataStoresResource.ArtifactsResource.CreateRequest
Creates an Artifact associated with a MetadataStore.
ProjectsResource.LocationsResource.MetadataStoresResource.ArtifactsResource.DeleteRequest
Deletes an Artifact.
ProjectsResource.LocationsResource.MetadataStoresResource.ArtifactsResource.GetRequest
Retrieves a specific Artifact.
ProjectsResource.LocationsResource.MetadataStoresResource.ArtifactsResource.ListRequest
Lists Artifacts in the MetadataStore.
ProjectsResource.LocationsResource.MetadataStoresResource.ArtifactsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.MetadataStoresResource.ArtifactsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort
to cancel the operation, but success is not guaranteed. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation
or other methods to check whether the cancellation succeeded or whether the operation
completed despite cancellation. On successful cancellation, the operation is not deleted;
instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code
of 1, corresponding to Code.CANCELLED.
ProjectsResource.LocationsResource.MetadataStoresResource.ArtifactsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer
interested in the operation result. It does not cancel the operation. If the server doesn't
support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.MetadataStoresResource.ArtifactsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.MetadataStoresResource.ArtifactsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.MetadataStoresResource.ArtifactsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified
timeout, returning the latest state. If the operation is already done, the latest state is
immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout,
the HTTP/RPC timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may
return the latest state before the specified timeout (including immediately), meaning even
an immediate response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.MetadataStoresResource.ArtifactsResource.PatchRequest
Updates a stored Artifact.
ProjectsResource.LocationsResource.MetadataStoresResource.ArtifactsResource.PurgeRequest
Purges Artifacts.
ProjectsResource.LocationsResource.MetadataStoresResource.ArtifactsResource.QueryArtifactLineageSubgraphRequest
Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.
ProjectsResource.LocationsResource.MetadataStoresResource.ContextsResource
The "contexts" collection of methods.
ProjectsResource.LocationsResource.MetadataStoresResource.ContextsResource.AddContextArtifactsAndExecutionsRequest
Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.
ProjectsResource.LocationsResource.MetadataStoresResource.ContextsResource.AddContextChildrenRequest
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 an INVALID_ARGUMENT error.
ProjectsResource.LocationsResource.MetadataStoresResource.ContextsResource.CreateRequest
Creates a Context associated with a MetadataStore.
ProjectsResource.LocationsResource.MetadataStoresResource.ContextsResource.DeleteRequest
Deletes a stored Context.
ProjectsResource.LocationsResource.MetadataStoresResource.ContextsResource.GetRequest
Retrieves a specific Context.
ProjectsResource.LocationsResource.MetadataStoresResource.ContextsResource.ListRequest
Lists Contexts on the MetadataStore.
ProjectsResource.LocationsResource.MetadataStoresResource.ContextsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.MetadataStoresResource.ContextsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort
to cancel the operation, but success is not guaranteed. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation
or other methods to check whether the cancellation succeeded or whether the operation
completed despite cancellation. On successful cancellation, the operation is not deleted;
instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code
of 1, corresponding to Code.CANCELLED.
ProjectsResource.LocationsResource.MetadataStoresResource.ContextsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer
interested in the operation result. It does not cancel the operation. If the server doesn't
support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.MetadataStoresResource.ContextsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.MetadataStoresResource.ContextsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.MetadataStoresResource.ContextsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified
timeout, returning the latest state. If the operation is already done, the latest state is
immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout,
the HTTP/RPC timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may
return the latest state before the specified timeout (including immediately), meaning even
an immediate response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.MetadataStoresResource.ContextsResource.PatchRequest
Updates a stored Context.
ProjectsResource.LocationsResource.MetadataStoresResource.ContextsResource.PurgeRequest
Purges Contexts.
ProjectsResource.LocationsResource.MetadataStoresResource.ContextsResource.QueryContextLineageSubgraphRequest
Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.
ProjectsResource.LocationsResource.MetadataStoresResource.ContextsResource.RemoveContextChildrenRequest
Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.
ProjectsResource.LocationsResource.MetadataStoresResource.CreateRequest
Initializes a MetadataStore, including allocation of resources.
ProjectsResource.LocationsResource.MetadataStoresResource.DeleteRequest
Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).
ProjectsResource.LocationsResource.MetadataStoresResource.ExecutionsResource
The "executions" collection of methods.
ProjectsResource.LocationsResource.MetadataStoresResource.ExecutionsResource.AddExecutionEventsRequest
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.
ProjectsResource.LocationsResource.MetadataStoresResource.ExecutionsResource.CreateRequest
Creates an Execution associated with a MetadataStore.
ProjectsResource.LocationsResource.MetadataStoresResource.ExecutionsResource.DeleteRequest
Deletes an Execution.
ProjectsResource.LocationsResource.MetadataStoresResource.ExecutionsResource.GetRequest
Retrieves a specific Execution.
ProjectsResource.LocationsResource.MetadataStoresResource.ExecutionsResource.ListRequest
Lists Executions in the MetadataStore.
ProjectsResource.LocationsResource.MetadataStoresResource.ExecutionsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.MetadataStoresResource.ExecutionsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort
to cancel the operation, but success is not guaranteed. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation
or other methods to check whether the cancellation succeeded or whether the operation
completed despite cancellation. On successful cancellation, the operation is not deleted;
instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code
of 1, corresponding to Code.CANCELLED.
ProjectsResource.LocationsResource.MetadataStoresResource.ExecutionsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer
interested in the operation result. It does not cancel the operation. If the server doesn't
support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.MetadataStoresResource.ExecutionsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.MetadataStoresResource.ExecutionsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.MetadataStoresResource.ExecutionsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified
timeout, returning the latest state. If the operation is already done, the latest state is
immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout,
the HTTP/RPC timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may
return the latest state before the specified timeout (including immediately), meaning even
an immediate response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.MetadataStoresResource.ExecutionsResource.PatchRequest
Updates a stored Execution.
ProjectsResource.LocationsResource.MetadataStoresResource.ExecutionsResource.PurgeRequest
Purges Executions.
ProjectsResource.LocationsResource.MetadataStoresResource.ExecutionsResource.QueryExecutionInputsAndOutputsRequest
Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.
ProjectsResource.LocationsResource.MetadataStoresResource.GetRequest
Retrieves a specific MetadataStore.
ProjectsResource.LocationsResource.MetadataStoresResource.ListRequest
Lists MetadataStores for a Location.
ProjectsResource.LocationsResource.MetadataStoresResource.MetadataSchemasResource
The "metadataSchemas" collection of methods.
ProjectsResource.LocationsResource.MetadataStoresResource.MetadataSchemasResource.CreateRequest
Creates a MetadataSchema.
ProjectsResource.LocationsResource.MetadataStoresResource.MetadataSchemasResource.GetRequest
Retrieves a specific MetadataSchema.
ProjectsResource.LocationsResource.MetadataStoresResource.MetadataSchemasResource.ListRequest
Lists MetadataSchemas.
ProjectsResource.LocationsResource.MetadataStoresResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.MetadataStoresResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.MetadataStoresResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.MetadataStoresResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.MetadataStoresResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.MetadataStoresResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.MigratableResourcesResource
The "migratableResources" collection of methods.
ProjectsResource.LocationsResource.MigratableResourcesResource.BatchMigrateRequest
Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.
ProjectsResource.LocationsResource.MigratableResourcesResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.MigratableResourcesResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.MigratableResourcesResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.MigratableResourcesResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.MigratableResourcesResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.MigratableResourcesResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.MigratableResourcesResource.SearchRequest
Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.
ProjectsResource.LocationsResource.ModelDeploymentMonitoringJobsResource
The "modelDeploymentMonitoringJobs" collection of methods.
ProjectsResource.LocationsResource.ModelDeploymentMonitoringJobsResource.CreateRequest
Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.
ProjectsResource.LocationsResource.ModelDeploymentMonitoringJobsResource.DeleteRequest
Deletes a ModelDeploymentMonitoringJob.
ProjectsResource.LocationsResource.ModelDeploymentMonitoringJobsResource.GetRequest
Gets a ModelDeploymentMonitoringJob.
ProjectsResource.LocationsResource.ModelDeploymentMonitoringJobsResource.ListRequest
Lists ModelDeploymentMonitoringJobs in a Location.
ProjectsResource.LocationsResource.ModelDeploymentMonitoringJobsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.ModelDeploymentMonitoringJobsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.ModelDeploymentMonitoringJobsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.ModelDeploymentMonitoringJobsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.ModelDeploymentMonitoringJobsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.ModelDeploymentMonitoringJobsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.ModelDeploymentMonitoringJobsResource.PatchRequest
Updates a ModelDeploymentMonitoringJob.
ProjectsResource.LocationsResource.ModelDeploymentMonitoringJobsResource.PauseRequest
Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.
ProjectsResource.LocationsResource.ModelDeploymentMonitoringJobsResource.ResumeRequest
Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.
ProjectsResource.LocationsResource.ModelDeploymentMonitoringJobsResource.SearchModelDeploymentMonitoringStatsAnomaliesRequest
Searches Model Monitoring Statistics generated within a given time window.
ProjectsResource.LocationsResource.ModelsResource
The "models" collection of methods.
ProjectsResource.LocationsResource.ModelsResource.CopyRequest
Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.
ProjectsResource.LocationsResource.ModelsResource.DeleteRequest
Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field.
ProjectsResource.LocationsResource.ModelsResource.DeleteVersionRequest
Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead.
ProjectsResource.LocationsResource.ModelsResource.EvaluationsResource
The "evaluations" collection of methods.
ProjectsResource.LocationsResource.ModelsResource.EvaluationsResource.GetRequest
Gets a ModelEvaluation.
ProjectsResource.LocationsResource.ModelsResource.EvaluationsResource.ImportRequest
Imports an externally generated ModelEvaluation.
ProjectsResource.LocationsResource.ModelsResource.EvaluationsResource.ListRequest
Lists ModelEvaluations in a Model.
ProjectsResource.LocationsResource.ModelsResource.EvaluationsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.ModelsResource.EvaluationsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort
to cancel the operation, but success is not guaranteed. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation
or other methods to check whether the cancellation succeeded or whether the operation
completed despite cancellation. On successful cancellation, the operation is not deleted;
instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code
of 1, corresponding to Code.CANCELLED.
ProjectsResource.LocationsResource.ModelsResource.EvaluationsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer
interested in the operation result. It does not cancel the operation. If the server doesn't
support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.ModelsResource.EvaluationsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.ModelsResource.EvaluationsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.ModelsResource.EvaluationsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified
timeout, returning the latest state. If the operation is already done, the latest state is
immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout,
the HTTP/RPC timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may
return the latest state before the specified timeout (including immediately), meaning even
an immediate response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.ModelsResource.EvaluationsResource.SlicesResource
The "slices" collection of methods.
ProjectsResource.LocationsResource.ModelsResource.EvaluationsResource.SlicesResource.BatchImportRequest
Imports a list of externally generated EvaluatedAnnotations.
ProjectsResource.LocationsResource.ModelsResource.EvaluationsResource.SlicesResource.GetRequest
Gets a ModelEvaluationSlice.
ProjectsResource.LocationsResource.ModelsResource.EvaluationsResource.SlicesResource.ListRequest
Lists ModelEvaluationSlices in a ModelEvaluation.
ProjectsResource.LocationsResource.ModelsResource.ExportRequest
Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format.
ProjectsResource.LocationsResource.ModelsResource.GetIamPolicyRequest
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectsResource.LocationsResource.ModelsResource.GetRequest
Gets a Model.
ProjectsResource.LocationsResource.ModelsResource.ListRequest
Lists Models in a Location.
ProjectsResource.LocationsResource.ModelsResource.ListVersionsRequest
Lists versions of the specified model.
ProjectsResource.LocationsResource.ModelsResource.MergeVersionAliasesRequest
Merges a set of aliases for a Model version.
ProjectsResource.LocationsResource.ModelsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.ModelsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.ModelsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.ModelsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.ModelsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.ModelsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.ModelsResource.PatchRequest
Updates a Model.
ProjectsResource.LocationsResource.ModelsResource.SetIamPolicyRequest
Sets the access control policy on the specified resource. Replaces any existing policy. Can return
NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectsResource.LocationsResource.ModelsResource.TestIamPermissionsRequest
Returns permissions that a caller has on the specified resource. If the resource does not exist,
this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is
designed to be used for building permission-aware UIs and command-line tools, not for authorization
checking. This operation may "fail open" without warning.
ProjectsResource.LocationsResource.ModelsResource.UpdateExplanationDatasetRequest
Incrementally update the dataset used for an examples model.
ProjectsResource.LocationsResource.ModelsResource.UploadRequest
Uploads a Model artifact into Vertex AI.
ProjectsResource.LocationsResource.NasJobsResource
The "nasJobs" collection of methods.
ProjectsResource.LocationsResource.NasJobsResource.CancelRequest
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 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
value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and NasJob.state is set
to CANCELLED.
ProjectsResource.LocationsResource.NasJobsResource.CreateRequest
Creates a NasJob
ProjectsResource.LocationsResource.NasJobsResource.DeleteRequest
Deletes a NasJob.
ProjectsResource.LocationsResource.NasJobsResource.GetRequest
Gets a NasJob
ProjectsResource.LocationsResource.NasJobsResource.ListRequest
Lists NasJobs in a Location.
ProjectsResource.LocationsResource.NasJobsResource.NasTrialDetailsResource
The "nasTrialDetails" collection of methods.
ProjectsResource.LocationsResource.NasJobsResource.NasTrialDetailsResource.GetRequest
Gets a NasTrialDetail.
ProjectsResource.LocationsResource.NasJobsResource.NasTrialDetailsResource.ListRequest
List top NasTrialDetails of a NasJob.
ProjectsResource.LocationsResource.NotebookExecutionJobsResource
The "notebookExecutionJobs" collection of methods.
ProjectsResource.LocationsResource.NotebookExecutionJobsResource.CreateRequest
Creates a NotebookExecutionJob.
ProjectsResource.LocationsResource.NotebookExecutionJobsResource.DeleteRequest
Deletes a NotebookExecutionJob.
ProjectsResource.LocationsResource.NotebookExecutionJobsResource.GetRequest
Gets a NotebookExecutionJob.
ProjectsResource.LocationsResource.NotebookExecutionJobsResource.ListRequest
Lists NotebookExecutionJobs in a Location.
ProjectsResource.LocationsResource.NotebookExecutionJobsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.NotebookExecutionJobsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.NotebookExecutionJobsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.NotebookExecutionJobsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.NotebookExecutionJobsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.NotebookExecutionJobsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.NotebookRuntimeTemplatesResource
The "notebookRuntimeTemplates" collection of methods.
ProjectsResource.LocationsResource.NotebookRuntimeTemplatesResource.CreateRequest
Creates a NotebookRuntimeTemplate.
ProjectsResource.LocationsResource.NotebookRuntimeTemplatesResource.DeleteRequest
Deletes a NotebookRuntimeTemplate.
ProjectsResource.LocationsResource.NotebookRuntimeTemplatesResource.GetIamPolicyRequest
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectsResource.LocationsResource.NotebookRuntimeTemplatesResource.GetRequest
Gets a NotebookRuntimeTemplate.
ProjectsResource.LocationsResource.NotebookRuntimeTemplatesResource.ListRequest
Lists NotebookRuntimeTemplates in a Location.
ProjectsResource.LocationsResource.NotebookRuntimeTemplatesResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.NotebookRuntimeTemplatesResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.NotebookRuntimeTemplatesResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.NotebookRuntimeTemplatesResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.NotebookRuntimeTemplatesResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.NotebookRuntimeTemplatesResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.NotebookRuntimeTemplatesResource.PatchRequest
Updates a NotebookRuntimeTemplate.
ProjectsResource.LocationsResource.NotebookRuntimeTemplatesResource.SetIamPolicyRequest
Sets the access control policy on the specified resource. Replaces any existing policy. Can return
NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ProjectsResource.LocationsResource.NotebookRuntimeTemplatesResource.TestIamPermissionsRequest
Returns permissions that a caller has on the specified resource. If the resource does not exist,
this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is
designed to be used for building permission-aware UIs and command-line tools, not for authorization
checking. This operation may "fail open" without warning.
ProjectsResource.LocationsResource.NotebookRuntimesResource
The "notebookRuntimes" collection of methods.
ProjectsResource.LocationsResource.NotebookRuntimesResource.AssignRequest
Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.
ProjectsResource.LocationsResource.NotebookRuntimesResource.DeleteRequest
Deletes a NotebookRuntime.
ProjectsResource.LocationsResource.NotebookRuntimesResource.GetRequest
Gets a NotebookRuntime.
ProjectsResource.LocationsResource.NotebookRuntimesResource.ListRequest
Lists NotebookRuntimes in a Location.
ProjectsResource.LocationsResource.NotebookRuntimesResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.NotebookRuntimesResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.NotebookRuntimesResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.NotebookRuntimesResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.NotebookRuntimesResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.NotebookRuntimesResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.NotebookRuntimesResource.StartRequest
Starts a NotebookRuntime.
ProjectsResource.LocationsResource.NotebookRuntimesResource.UpgradeRequest
Upgrades a NotebookRuntime.
ProjectsResource.LocationsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method, it
returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to
check whether the cancellation succeeded or whether the operation completed despite cancellation. On
successful cancellation, the operation is not deleted; instead, it becomes an operation with an
Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
ProjectsResource.LocationsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested in
the operation result. It does not cancel the operation. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support this
method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the
latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.PersistentResourcesResource
The "persistentResources" collection of methods.
ProjectsResource.LocationsResource.PersistentResourcesResource.CreateRequest
Creates a PersistentResource.
ProjectsResource.LocationsResource.PersistentResourcesResource.DeleteRequest
Deletes a PersistentResource.
ProjectsResource.LocationsResource.PersistentResourcesResource.GetRequest
Gets a PersistentResource.
ProjectsResource.LocationsResource.PersistentResourcesResource.ListRequest
Lists PersistentResources in a Location.
ProjectsResource.LocationsResource.PersistentResourcesResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.PersistentResourcesResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.PersistentResourcesResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.PersistentResourcesResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.PersistentResourcesResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.PersistentResourcesResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.PersistentResourcesResource.PatchRequest
Updates a PersistentResource.
ProjectsResource.LocationsResource.PersistentResourcesResource.RebootRequest
Reboots a PersistentResource.
ProjectsResource.LocationsResource.PipelineJobsResource
The "pipelineJobs" collection of methods.
ProjectsResource.LocationsResource.PipelineJobsResource.BatchCancelRequest
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.
ProjectsResource.LocationsResource.PipelineJobsResource.BatchDeleteRequest
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.
ProjectsResource.LocationsResource.PipelineJobsResource.CancelRequest
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.
ProjectsResource.LocationsResource.PipelineJobsResource.CreateRequest
Creates a PipelineJob. A PipelineJob will run immediately when created.
ProjectsResource.LocationsResource.PipelineJobsResource.DeleteRequest
Deletes a PipelineJob.
ProjectsResource.LocationsResource.PipelineJobsResource.GetRequest
Gets a PipelineJob.
ProjectsResource.LocationsResource.PipelineJobsResource.ListRequest
Lists PipelineJobs in a Location.
ProjectsResource.LocationsResource.PipelineJobsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.PipelineJobsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.PipelineJobsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.PipelineJobsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.PipelineJobsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.PipelineJobsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.PublishersResource
The "publishers" collection of methods.
ProjectsResource.LocationsResource.PublishersResource.ModelsResource
The "models" collection of methods.
ProjectsResource.LocationsResource.PublishersResource.ModelsResource.ComputeTokensRequest
Return a list of tokens based on the input text.
ProjectsResource.LocationsResource.PublishersResource.ModelsResource.CountTokensRequest
Perform a token counting.
ProjectsResource.LocationsResource.PublishersResource.ModelsResource.GenerateContentRequest
Generate content with multimodal inputs.
ProjectsResource.LocationsResource.PublishersResource.ModelsResource.PredictRequest
Perform an online prediction.
ProjectsResource.LocationsResource.PublishersResource.ModelsResource.RawPredictRequest
Perform an online prediction with an arbitrary HTTP payload. The response includes the following
HTTP headers: * X-Vertex-AI-Endpoint-Id: ID of the Endpoint that served this prediction. *
X-Vertex-AI-Deployed-Model-Id: ID of the Endpoint's DeployedModel that served this prediction.
ProjectsResource.LocationsResource.PublishersResource.ModelsResource.ServerStreamingPredictRequest
Perform a server-side streaming online prediction request for Vertex LLM streaming.
ProjectsResource.LocationsResource.PublishersResource.ModelsResource.StreamGenerateContentRequest
Generate content with multimodal inputs with streaming support.
ProjectsResource.LocationsResource.PublishersResource.ModelsResource.StreamRawPredictRequest
Perform a streaming online prediction with an arbitrary HTTP payload.
ProjectsResource.LocationsResource.SchedulesResource
The "schedules" collection of methods.
ProjectsResource.LocationsResource.SchedulesResource.CreateRequest
Creates a Schedule.
ProjectsResource.LocationsResource.SchedulesResource.DeleteRequest
Deletes a Schedule.
ProjectsResource.LocationsResource.SchedulesResource.GetRequest
Gets a Schedule.
ProjectsResource.LocationsResource.SchedulesResource.ListRequest
Lists Schedules in a Location.
ProjectsResource.LocationsResource.SchedulesResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.SchedulesResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.SchedulesResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.SchedulesResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.SchedulesResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.SchedulesResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.SchedulesResource.PatchRequest
Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.
ProjectsResource.LocationsResource.SchedulesResource.PauseRequest
Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.
ProjectsResource.LocationsResource.SchedulesResource.ResumeRequest
Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catchUp is set up true, all missed runs will be scheduled for backfill first.
ProjectsResource.LocationsResource.SpecialistPoolsResource
The "specialistPools" collection of methods.
ProjectsResource.LocationsResource.SpecialistPoolsResource.CreateRequest
Creates a SpecialistPool.
ProjectsResource.LocationsResource.SpecialistPoolsResource.DeleteRequest
Deletes a SpecialistPool as well as all Specialists in the pool.
ProjectsResource.LocationsResource.SpecialistPoolsResource.GetRequest
Gets a SpecialistPool.
ProjectsResource.LocationsResource.SpecialistPoolsResource.ListRequest
Lists SpecialistPools in a Location.
ProjectsResource.LocationsResource.SpecialistPoolsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.SpecialistPoolsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.SpecialistPoolsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.SpecialistPoolsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.SpecialistPoolsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.SpecialistPoolsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.SpecialistPoolsResource.PatchRequest
Updates a SpecialistPool.
ProjectsResource.LocationsResource.StudiesResource
The "studies" collection of methods.
ProjectsResource.LocationsResource.StudiesResource.CreateRequest
Creates a Study. A resource name will be generated after creation of the Study.
ProjectsResource.LocationsResource.StudiesResource.DeleteRequest
Deletes a Study.
ProjectsResource.LocationsResource.StudiesResource.GetRequest
Gets a Study by name.
ProjectsResource.LocationsResource.StudiesResource.ListRequest
Lists all the studies in a region for an associated project.
ProjectsResource.LocationsResource.StudiesResource.LookupRequest
Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
ProjectsResource.LocationsResource.StudiesResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.StudiesResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.StudiesResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.StudiesResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.StudiesResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.StudiesResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.StudiesResource.TrialsResource
The "trials" collection of methods.
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.AddTrialMeasurementRequest
Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.CheckTrialEarlyStoppingStateRequest
Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.CompleteRequest
Marks a Trial as complete.
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.CreateRequest
Adds a user provided Trial to a Study.
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.DeleteRequest
Deletes a Trial.
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.GetRequest
Gets a Trial.
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.ListOptimalTrialsRequest
Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.ListRequest
Lists the Trials associated with a Study.
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort
to cancel the operation, but success is not guaranteed. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation
or other methods to check whether the cancellation succeeded or whether the operation
completed despite cancellation. On successful cancellation, the operation is not deleted;
instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code
of 1, corresponding to Code.CANCELLED.
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer
interested in the operation result. It does not cancel the operation. If the server doesn't
support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified
timeout, returning the latest state. If the operation is already done, the latest state is
immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout,
the HTTP/RPC timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may
return the latest state before the specified timeout (including immediately), meaning even
an immediate response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.StopRequest
Stops a Trial.
ProjectsResource.LocationsResource.StudiesResource.TrialsResource.SuggestRequest
Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.
ProjectsResource.LocationsResource.TensorboardsResource
The "tensorboards" collection of methods.
ProjectsResource.LocationsResource.TensorboardsResource.BatchReadRequest
Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.
ProjectsResource.LocationsResource.TensorboardsResource.CreateRequest
Creates a Tensorboard.
ProjectsResource.LocationsResource.TensorboardsResource.DeleteRequest
Deletes a Tensorboard.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource
The "experiments" collection of methods.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.BatchCreateRequest
Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.CreateRequest
Creates a TensorboardExperiment.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.DeleteRequest
Deletes a TensorboardExperiment.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.GetRequest
Gets a TensorboardExperiment.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.ListRequest
Lists TensorboardExperiments in a Location.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort
to cancel the operation, but success is not guaranteed. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation
or other methods to check whether the cancellation succeeded or whether the operation
completed despite cancellation. On successful cancellation, the operation is not deleted;
instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code
of 1, corresponding to Code.CANCELLED.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer
interested in the operation result. It does not cancel the operation. If the server doesn't
support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified
timeout, returning the latest state. If the operation is already done, the latest state is
immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout,
the HTTP/RPC timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may
return the latest state before the specified timeout (including immediately), meaning even
an immediate response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.PatchRequest
Updates a TensorboardExperiment.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource
The "runs" collection of methods.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.BatchCreateRequest
Batch create TensorboardRuns.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.CreateRequest
Creates a TensorboardRun.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.DeleteRequest
Deletes a TensorboardRun.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.GetRequest
Gets a TensorboardRun.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.ListRequest
Lists TensorboardRuns in a Location.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best
effort to cancel the operation, but success is not guaranteed. If the server doesn't
support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use
Operations.GetOperation or other methods to check whether the cancellation succeeded or
whether the operation completed despite cancellation. On successful cancellation, the
operation is not deleted; instead, it becomes an operation with an Operation.error value
with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer
interested in the operation result. It does not cancel the operation. If the server
doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't
support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified
timeout, returning the latest state. If the operation is already done, the latest state
is immediately returned. If the timeout specified is greater than the default HTTP/RPC
timeout, the HTTP/RPC timeout is used. If the server does not support this method, it
returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort
basis. It may return the latest state before the specified timeout (including
immediately), meaning even an immediate response is no guarantee that the operation is
done.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.PatchRequest
Updates a TensorboardRun.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.TimeSeriesResource
The "timeSeries" collection of methods.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.TimeSeriesResource.CreateRequest
Creates a TensorboardTimeSeries.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.TimeSeriesResource.DeleteRequest
Deletes a TensorboardTimeSeries.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.TimeSeriesResource.ExportTensorboardTimeSeriesRequest
Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.TimeSeriesResource.GetRequest
Gets a TensorboardTimeSeries.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.TimeSeriesResource.ListRequest
Lists TensorboardTimeSeries in a Location.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.TimeSeriesResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.TimeSeriesResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a
best effort to cancel the operation, but success is not guaranteed. If the server
doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can
use Operations.GetOperation or other methods to check whether the cancellation
succeeded or whether the operation completed despite cancellation. On successful
cancellation, the operation is not deleted; instead, it becomes an operation with an
Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.TimeSeriesResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer
interested in the operation result. It does not cancel the operation. If the server
doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.TimeSeriesResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.TimeSeriesResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server
doesn't support this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.TimeSeriesResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a
specified timeout, returning the latest state. If the operation is already done, the
latest state is immediately returned. If the timeout specified is greater than the
default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not
support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this
method is on a best-effort basis. It may return the latest state before the
specified timeout (including immediately), meaning even an immediate response is no
guarantee that the operation is done.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.TimeSeriesResource.PatchRequest
Updates a TensorboardTimeSeries.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.TimeSeriesResource.ReadBlobDataRequest
Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.TimeSeriesResource.ReadRequest
Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.RunsResource.WriteRequest
Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.
ProjectsResource.LocationsResource.TensorboardsResource.ExperimentsResource.WriteRequest
Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.
ProjectsResource.LocationsResource.TensorboardsResource.GetRequest
Gets a Tensorboard.
ProjectsResource.LocationsResource.TensorboardsResource.ListRequest
Lists Tensorboards in a Location.
ProjectsResource.LocationsResource.TensorboardsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.TensorboardsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.TensorboardsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.TensorboardsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.TensorboardsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.TensorboardsResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.TensorboardsResource.PatchRequest
Updates a Tensorboard.
ProjectsResource.LocationsResource.TensorboardsResource.ReadSizeRequest
Returns the storage size for a given TensorBoard instance.
ProjectsResource.LocationsResource.TensorboardsResource.ReadUsageRequest
Returns a list of monthly active users for a given TensorBoard instance.
ProjectsResource.LocationsResource.TrainingPipelinesResource
The "trainingPipelines" collection of methods.
ProjectsResource.LocationsResource.TrainingPipelinesResource.CancelRequest
Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server
makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use
PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or
whether the pipeline completed despite cancellation. On successful cancellation, the
TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value
with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and TrainingPipeline.state is
set to CANCELLED.
ProjectsResource.LocationsResource.TrainingPipelinesResource.CreateRequest
Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.
ProjectsResource.LocationsResource.TrainingPipelinesResource.DeleteRequest
Deletes a TrainingPipeline.
ProjectsResource.LocationsResource.TrainingPipelinesResource.GetRequest
Gets a TrainingPipeline.
ProjectsResource.LocationsResource.TrainingPipelinesResource.ListRequest
Lists TrainingPipelines in a Location.
ProjectsResource.LocationsResource.TrainingPipelinesResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.TrainingPipelinesResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.TrainingPipelinesResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.TrainingPipelinesResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.TrainingPipelinesResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.TrainingPipelinesResource.OperationsResource.WaitRequest
Waits until the specified long-running operation is done or reaches at most a specified timeout,
returning the latest state. If the operation is already done, the latest state is immediately
returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
timeout is used. If the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return
the latest state before the specified timeout (including immediately), meaning even an immediate
response is no guarantee that the operation is done.
ProjectsResource.LocationsResource.TuningJobsResource
The "tuningJobs" collection of methods.
ProjectsResource.LocationsResource.TuningJobsResource.CancelRequest
Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best
effort to cancel the job, but success is not guaranteed. Clients can use
GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or
whether the job completed despite cancellation. On successful cancellation, the TuningJob is not
deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED, and TuningJob.state is set to CANCELLED.
ProjectsResource.LocationsResource.TuningJobsResource.CreateRequest
Creates a TuningJob. A created TuningJob right away will be attempted to be run.
ProjectsResource.LocationsResource.TuningJobsResource.GetRequest
Gets a TuningJob.
ProjectsResource.LocationsResource.TuningJobsResource.ListRequest
Lists TuningJobs in a Location.
ProjectsResource.LocationsResource.TuningJobsResource.OperationsResource
The "operations" collection of methods.
ProjectsResource.LocationsResource.TuningJobsResource.OperationsResource.CancelRequest
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
Code.CANCELLED.
ProjectsResource.LocationsResource.TuningJobsResource.OperationsResource.DeleteRequest
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectsResource.LocationsResource.TuningJobsResource.OperationsResource.GetRequest
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectsResource.LocationsResource.TuningJobsResource.OperationsResource.ListRequest
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns UNIMPLEMENTED.
ProjectsResource.LocationsResource.TuningJobsResource.RebaseTunedModelRequest
Rebase a TunedModel.
PublishersResource
The "publishers" collection of methods.
PublishersResource.ModelsResource
The "models" collection of methods.
PublishersResource.ModelsResource.ComputeTokensRequest
Return a list of tokens based on the input text.
PublishersResource.ModelsResource.CountTokensRequest
Perform a token counting.
PublishersResource.ModelsResource.GenerateContentRequest
Generate content with multimodal inputs.
PublishersResource.ModelsResource.GetRequest
Gets a Model Garden publisher model.
PublishersResource.ModelsResource.StreamGenerateContentRequest
Generate content with multimodal inputs with streaming support.
Enums
AiplatformBaseServiceRequest<TResponse>.AltEnum
Data format for response.
AiplatformBaseServiceRequest<TResponse>.XgafvEnum
V1 error format.
ProjectsResource.LocationsResource.NotebookExecutionJobsResource.GetRequest.ViewEnum
Optional. The NotebookExecutionJob view. Defaults to BASIC.
ProjectsResource.LocationsResource.NotebookExecutionJobsResource.ListRequest.ViewEnum
Optional. The NotebookExecutionJob view. Defaults to BASIC.
PublishersResource.ModelsResource.GetRequest.ViewEnum
Optional. PublisherModel view specifying which fields to read.