Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::IndexEndpointService::Rest::ServiceStub.
REST service stub for the IndexEndpointService service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.
Inherits
- Object
Methods
#create_index_endpoint
def create_index_endpoint(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_index_endpoint REST call
- request_pb (::Google::Cloud::AIPlatform::V1::CreateIndexEndpointRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_index_endpoint
def delete_index_endpoint(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the delete_index_endpoint REST call
- request_pb (::Google::Cloud::AIPlatform::V1::DeleteIndexEndpointRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#deploy_index
def deploy_index(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the deploy_index REST call
- request_pb (::Google::Cloud::AIPlatform::V1::DeployIndexRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#endpoint
def endpoint() -> String
The effective endpoint
- (String)
#get_index_endpoint
def get_index_endpoint(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::IndexEndpoint
Baseline implementation for the get_index_endpoint REST call
- request_pb (::Google::Cloud::AIPlatform::V1::GetIndexEndpointRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::AIPlatform::V1::IndexEndpoint)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::AIPlatform::V1::IndexEndpoint) — A result object deserialized from the server's reply
- (::ArgumentError)
#initialize
def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
- (ServiceStub) — a new instance of ServiceStub
#list_index_endpoints
def list_index_endpoints(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::ListIndexEndpointsResponse
Baseline implementation for the list_index_endpoints REST call
- request_pb (::Google::Cloud::AIPlatform::V1::ListIndexEndpointsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::AIPlatform::V1::ListIndexEndpointsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::AIPlatform::V1::ListIndexEndpointsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#mutate_deployed_index
def mutate_deployed_index(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the mutate_deployed_index REST call
- request_pb (::Google::Cloud::AIPlatform::V1::MutateDeployedIndexRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#undeploy_index
def undeploy_index(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the undeploy_index REST call
- request_pb (::Google::Cloud::AIPlatform::V1::UndeployIndexRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_index_endpoint
def update_index_endpoint(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::AIPlatform::V1::IndexEndpoint
Baseline implementation for the update_index_endpoint REST call
- request_pb (::Google::Cloud::AIPlatform::V1::UpdateIndexEndpointRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::AIPlatform::V1::IndexEndpoint)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::AIPlatform::V1::IndexEndpoint) — A result object deserialized from the server's reply
- (::ArgumentError)