Vertex AI v1beta1 API - Class ExampleStoreService.ExampleStoreServiceClient (1.0.0-beta24) 

public class ExampleStoreService.ExampleStoreServiceClient : ClientBase<ExampleStoreService.ExampleStoreServiceClient>

Reference documentation and code samples for the Vertex AI v1beta1 API class ExampleStoreService.ExampleStoreServiceClient.

Client for ExampleStoreService

Inheritance

object > ClientBase > ClientBaseExampleStoreServiceExampleStoreServiceClient > ExampleStoreService.ExampleStoreServiceClient

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

ExampleStoreServiceClient()

protected ExampleStoreServiceClient()

Protected parameterless constructor to allow creation of test doubles.

ExampleStoreServiceClient(CallInvoker)

public ExampleStoreServiceClient(CallInvoker callInvoker)

Creates a new client for ExampleStoreService that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

ExampleStoreServiceClient(ChannelBase)

public ExampleStoreServiceClient(ChannelBase channel)

Creates a new client for ExampleStoreService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

ExampleStoreServiceClient(ClientBaseConfiguration)

protected ExampleStoreServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateExampleStore(CreateExampleStoreRequest, CallOptions)

public virtual Operation CreateExampleStore(CreateExampleStoreRequest request, CallOptions options)

Create an ExampleStore.

Parameters
Name Description
request CreateExampleStoreRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

CreateExampleStore(CreateExampleStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateExampleStore(CreateExampleStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create an ExampleStore.

Parameters
Name Description
request CreateExampleStoreRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

CreateExampleStoreAsync(CreateExampleStoreRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateExampleStoreAsync(CreateExampleStoreRequest request, CallOptions options)

Create an ExampleStore.

Parameters
Name Description
request CreateExampleStoreRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateExampleStoreAsync(CreateExampleStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateExampleStoreAsync(CreateExampleStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create an ExampleStore.

Parameters
Name Description
request CreateExampleStoreRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type Description
IAMPolicyIAMPolicyClient

A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

DeleteExampleStore(DeleteExampleStoreRequest, CallOptions)

public virtual Operation DeleteExampleStore(DeleteExampleStoreRequest request, CallOptions options)

Delete an ExampleStore.

Parameters
Name Description
request DeleteExampleStoreRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeleteExampleStore(DeleteExampleStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteExampleStore(DeleteExampleStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Delete an ExampleStore.

Parameters
Name Description
request DeleteExampleStoreRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

DeleteExampleStoreAsync(DeleteExampleStoreRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteExampleStoreAsync(DeleteExampleStoreRequest request, CallOptions options)

Delete an ExampleStore.

Parameters
Name Description
request DeleteExampleStoreRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteExampleStoreAsync(DeleteExampleStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteExampleStoreAsync(DeleteExampleStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Delete an ExampleStore.

Parameters
Name Description
request DeleteExampleStoreRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

FetchExamples(FetchExamplesRequest, CallOptions)

public virtual FetchExamplesResponse FetchExamples(FetchExamplesRequest request, CallOptions options)

Get Examples from the Example Store.

Parameters
Name Description
request FetchExamplesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
FetchExamplesResponse

The response received from the server.

FetchExamples(FetchExamplesRequest, Metadata, DateTime?, CancellationToken)

public virtual FetchExamplesResponse FetchExamples(FetchExamplesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get Examples from the Example Store.

Parameters
Name Description
request FetchExamplesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
FetchExamplesResponse

The response received from the server.

FetchExamplesAsync(FetchExamplesRequest, CallOptions)

public virtual AsyncUnaryCall<FetchExamplesResponse> FetchExamplesAsync(FetchExamplesRequest request, CallOptions options)

Get Examples from the Example Store.

Parameters
Name Description
request FetchExamplesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallFetchExamplesResponse

The call object.

FetchExamplesAsync(FetchExamplesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<FetchExamplesResponse> FetchExamplesAsync(FetchExamplesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get Examples from the Example Store.

Parameters
Name Description
request FetchExamplesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallFetchExamplesResponse

The call object.

GetExampleStore(GetExampleStoreRequest, CallOptions)

public virtual ExampleStore GetExampleStore(GetExampleStoreRequest request, CallOptions options)

Get an ExampleStore.

Parameters
Name Description
request GetExampleStoreRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ExampleStore

The response received from the server.

GetExampleStore(GetExampleStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual ExampleStore GetExampleStore(GetExampleStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get an ExampleStore.

Parameters
Name Description
request GetExampleStoreRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ExampleStore

The response received from the server.

GetExampleStoreAsync(GetExampleStoreRequest, CallOptions)

public virtual AsyncUnaryCall<ExampleStore> GetExampleStoreAsync(GetExampleStoreRequest request, CallOptions options)

Get an ExampleStore.

Parameters
Name Description
request GetExampleStoreRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallExampleStore

The call object.

GetExampleStoreAsync(GetExampleStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ExampleStore> GetExampleStoreAsync(GetExampleStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get an ExampleStore.

Parameters
Name Description
request GetExampleStoreRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallExampleStore

The call object.

ListExampleStores(ListExampleStoresRequest, CallOptions)

public virtual ListExampleStoresResponse ListExampleStores(ListExampleStoresRequest request, CallOptions options)

List ExampleStores in a Location.

Parameters
Name Description
request ListExampleStoresRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListExampleStoresResponse

The response received from the server.

ListExampleStores(ListExampleStoresRequest, Metadata, DateTime?, CancellationToken)

public virtual ListExampleStoresResponse ListExampleStores(ListExampleStoresRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List ExampleStores in a Location.

Parameters
Name Description
request ListExampleStoresRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListExampleStoresResponse

The response received from the server.

ListExampleStoresAsync(ListExampleStoresRequest, CallOptions)

public virtual AsyncUnaryCall<ListExampleStoresResponse> ListExampleStoresAsync(ListExampleStoresRequest request, CallOptions options)

List ExampleStores in a Location.

Parameters
Name Description
request ListExampleStoresRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListExampleStoresResponse

The call object.

ListExampleStoresAsync(ListExampleStoresRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListExampleStoresResponse> ListExampleStoresAsync(ListExampleStoresRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List ExampleStores in a Location.

Parameters
Name Description
request ListExampleStoresRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListExampleStoresResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override ExampleStoreService.ExampleStoreServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
ExampleStoreServiceExampleStoreServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.AIPlatform.V1Beta1.ExampleStoreService.ExampleStoreServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

RemoveExamples(RemoveExamplesRequest, CallOptions)

public virtual RemoveExamplesResponse RemoveExamples(RemoveExamplesRequest request, CallOptions options)

Remove Examples from the Example Store.

Parameters
Name Description
request RemoveExamplesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
RemoveExamplesResponse

The response received from the server.

RemoveExamples(RemoveExamplesRequest, Metadata, DateTime?, CancellationToken)

public virtual RemoveExamplesResponse RemoveExamples(RemoveExamplesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Remove Examples from the Example Store.

Parameters
Name Description
request RemoveExamplesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
RemoveExamplesResponse

The response received from the server.

RemoveExamplesAsync(RemoveExamplesRequest, CallOptions)

public virtual AsyncUnaryCall<RemoveExamplesResponse> RemoveExamplesAsync(RemoveExamplesRequest request, CallOptions options)

Remove Examples from the Example Store.

Parameters
Name Description
request RemoveExamplesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallRemoveExamplesResponse

The call object.

RemoveExamplesAsync(RemoveExamplesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RemoveExamplesResponse> RemoveExamplesAsync(RemoveExamplesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Remove Examples from the Example Store.

Parameters
Name Description
request RemoveExamplesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallRemoveExamplesResponse

The call object.

SearchExamples(SearchExamplesRequest, CallOptions)

public virtual SearchExamplesResponse SearchExamples(SearchExamplesRequest request, CallOptions options)

Search for similar Examples for given selection criteria.

Parameters
Name Description
request SearchExamplesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
SearchExamplesResponse

The response received from the server.

SearchExamples(SearchExamplesRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchExamplesResponse SearchExamples(SearchExamplesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Search for similar Examples for given selection criteria.

Parameters
Name Description
request SearchExamplesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
SearchExamplesResponse

The response received from the server.

SearchExamplesAsync(SearchExamplesRequest, CallOptions)

public virtual AsyncUnaryCall<SearchExamplesResponse> SearchExamplesAsync(SearchExamplesRequest request, CallOptions options)

Search for similar Examples for given selection criteria.

Parameters
Name Description
request SearchExamplesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallSearchExamplesResponse

The call object.

SearchExamplesAsync(SearchExamplesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchExamplesResponse> SearchExamplesAsync(SearchExamplesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Search for similar Examples for given selection criteria.

Parameters
Name Description
request SearchExamplesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallSearchExamplesResponse

The call object.

UpdateExampleStore(UpdateExampleStoreRequest, CallOptions)

public virtual Operation UpdateExampleStore(UpdateExampleStoreRequest request, CallOptions options)

Update an ExampleStore.

Parameters
Name Description
request UpdateExampleStoreRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

UpdateExampleStore(UpdateExampleStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateExampleStore(UpdateExampleStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update an ExampleStore.

Parameters
Name Description
request UpdateExampleStoreRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

UpdateExampleStoreAsync(UpdateExampleStoreRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateExampleStoreAsync(UpdateExampleStoreRequest request, CallOptions options)

Update an ExampleStore.

Parameters
Name Description
request UpdateExampleStoreRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateExampleStoreAsync(UpdateExampleStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateExampleStoreAsync(UpdateExampleStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update an ExampleStore.

Parameters
Name Description
request UpdateExampleStoreRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpsertExamples(UpsertExamplesRequest, CallOptions)

public virtual UpsertExamplesResponse UpsertExamples(UpsertExamplesRequest request, CallOptions options)

Create or update Examples in the Example Store.

Parameters
Name Description
request UpsertExamplesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
UpsertExamplesResponse

The response received from the server.

UpsertExamples(UpsertExamplesRequest, Metadata, DateTime?, CancellationToken)

public virtual UpsertExamplesResponse UpsertExamples(UpsertExamplesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create or update Examples in the Example Store.

Parameters
Name Description
request UpsertExamplesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
UpsertExamplesResponse

The response received from the server.

UpsertExamplesAsync(UpsertExamplesRequest, CallOptions)

public virtual AsyncUnaryCall<UpsertExamplesResponse> UpsertExamplesAsync(UpsertExamplesRequest request, CallOptions options)

Create or update Examples in the Example Store.

Parameters
Name Description
request UpsertExamplesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallUpsertExamplesResponse

The call object.

UpsertExamplesAsync(UpsertExamplesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<UpsertExamplesResponse> UpsertExamplesAsync(UpsertExamplesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create or update Examples in the Example Store.

Parameters
Name Description
request UpsertExamplesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallUpsertExamplesResponse

The call object.