Vertex AI v1beta1 API - Class ExampleStoreServiceClientImpl (1.0.0-beta24) 

public sealed class ExampleStoreServiceClientImpl : ExampleStoreServiceClient

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

ExampleStoreService client wrapper implementation, for convenient use.

Inheritance

object > ExampleStoreServiceClient > ExampleStoreServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Remarks

A service for managing and retrieving few-shot examples.

Constructors

ExampleStoreServiceClientImpl(ExampleStoreServiceClient, ExampleStoreServiceSettings, ILogger)

public ExampleStoreServiceClientImpl(ExampleStoreService.ExampleStoreServiceClient grpcClient, ExampleStoreServiceSettings settings, ILogger logger)

Constructs a client wrapper for the ExampleStoreService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient ExampleStoreServiceExampleStoreServiceClient

The underlying gRPC client.
settings ExampleStoreServiceSettings

The base ExampleStoreServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateExampleStoreOperationsClient

public override OperationsClient CreateExampleStoreOperationsClient { get; }

The long-running operations client for CreateExampleStore.

Property Value
Type Description
OperationsClient
Overrides

DeleteExampleStoreOperationsClient

public override OperationsClient DeleteExampleStoreOperationsClient { get; }

The long-running operations client for DeleteExampleStore.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override ExampleStoreService.ExampleStoreServiceClient GrpcClient { get; }

The underlying gRPC ExampleStoreService client

Property Value
Type Description
ExampleStoreServiceExampleStoreServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

UpdateExampleStoreOperationsClient

public override OperationsClient UpdateExampleStoreOperationsClient { get; }

The long-running operations client for UpdateExampleStore.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateExampleStore(CreateExampleStoreRequest, CallSettings)

public override Operation<ExampleStore, CreateExampleStoreOperationMetadata> CreateExampleStore(CreateExampleStoreRequest request, CallSettings callSettings = null)

Create an ExampleStore.

Parameters
Name Description
request CreateExampleStoreRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationExampleStoreCreateExampleStoreOperationMetadata

The RPC response.
Overrides

CreateExampleStoreAsync(CreateExampleStoreRequest, CallSettings)

public override Task<Operation<ExampleStore, CreateExampleStoreOperationMetadata>> CreateExampleStoreAsync(CreateExampleStoreRequest request, CallSettings callSettings = null)

Create an ExampleStore.

Parameters
Name Description
request CreateExampleStoreRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationExampleStoreCreateExampleStoreOperationMetadata

A Task containing the RPC response.
Overrides

DeleteExampleStore(DeleteExampleStoreRequest, CallSettings)

public override Operation<Empty, DeleteExampleStoreOperationMetadata> DeleteExampleStore(DeleteExampleStoreRequest request, CallSettings callSettings = null)

Delete an ExampleStore.

Parameters
Name Description
request DeleteExampleStoreRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteExampleStoreOperationMetadata

The RPC response.
Overrides

DeleteExampleStoreAsync(DeleteExampleStoreRequest, CallSettings)

public override Task<Operation<Empty, DeleteExampleStoreOperationMetadata>> DeleteExampleStoreAsync(DeleteExampleStoreRequest request, CallSettings callSettings = null)

Delete an ExampleStore.

Parameters
Name Description
request DeleteExampleStoreRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteExampleStoreOperationMetadata

A Task containing the RPC response.
Overrides

FetchExamples(FetchExamplesRequest, CallSettings)

public override PagedEnumerable<FetchExamplesResponse, Example> FetchExamples(FetchExamplesRequest request, CallSettings callSettings = null)

Get Examples from the Example Store.

Parameters
Name Description
request FetchExamplesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableFetchExamplesResponseExample

A pageable sequence of Example resources.
Overrides

FetchExamplesAsync(FetchExamplesRequest, CallSettings)

public override PagedAsyncEnumerable<FetchExamplesResponse, Example> FetchExamplesAsync(FetchExamplesRequest request, CallSettings callSettings = null)

Get Examples from the Example Store.

Parameters
Name Description
request FetchExamplesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableFetchExamplesResponseExample

A pageable asynchronous sequence of Example resources.
Overrides

GetExampleStore(GetExampleStoreRequest, CallSettings)

public override ExampleStore GetExampleStore(GetExampleStoreRequest request, CallSettings callSettings = null)

Get an ExampleStore.

Parameters
Name Description
request GetExampleStoreRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ExampleStore

The RPC response.
Overrides

GetExampleStoreAsync(GetExampleStoreRequest, CallSettings)

public override Task<ExampleStore> GetExampleStoreAsync(GetExampleStoreRequest request, CallSettings callSettings = null)

Get an ExampleStore.

Parameters
Name Description
request GetExampleStoreRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskExampleStore

A Task containing the RPC response.
Overrides

ListExampleStores(ListExampleStoresRequest, CallSettings)

public override PagedEnumerable<ListExampleStoresResponse, ExampleStore> ListExampleStores(ListExampleStoresRequest request, CallSettings callSettings = null)

List ExampleStores in a Location.

Parameters
Name Description
request ListExampleStoresRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListExampleStoresResponseExampleStore

A pageable sequence of ExampleStore resources.
Overrides

ListExampleStoresAsync(ListExampleStoresRequest, CallSettings)

public override PagedAsyncEnumerable<ListExampleStoresResponse, ExampleStore> ListExampleStoresAsync(ListExampleStoresRequest request, CallSettings callSettings = null)

List ExampleStores in a Location.

Parameters
Name Description
request ListExampleStoresRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListExampleStoresResponseExampleStore

A pageable asynchronous sequence of ExampleStore resources.
Overrides

RemoveExamples(RemoveExamplesRequest, CallSettings)

public override RemoveExamplesResponse RemoveExamples(RemoveExamplesRequest request, CallSettings callSettings = null)

Remove Examples from the Example Store.

Parameters
Name Description
request RemoveExamplesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
RemoveExamplesResponse

The RPC response.
Overrides

RemoveExamplesAsync(RemoveExamplesRequest, CallSettings)

public override Task<RemoveExamplesResponse> RemoveExamplesAsync(RemoveExamplesRequest request, CallSettings callSettings = null)

Remove Examples from the Example Store.

Parameters
Name Description
request RemoveExamplesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRemoveExamplesResponse

A Task containing the RPC response.
Overrides

SearchExamples(SearchExamplesRequest, CallSettings)

public override SearchExamplesResponse SearchExamples(SearchExamplesRequest request, CallSettings callSettings = null)

Search for similar Examples for given selection criteria.

Parameters
Name Description
request SearchExamplesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
SearchExamplesResponse

The RPC response.
Overrides

SearchExamplesAsync(SearchExamplesRequest, CallSettings)

public override Task<SearchExamplesResponse> SearchExamplesAsync(SearchExamplesRequest request, CallSettings callSettings = null)

Search for similar Examples for given selection criteria.

Parameters
Name Description
request SearchExamplesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSearchExamplesResponse

A Task containing the RPC response.
Overrides

UpdateExampleStore(UpdateExampleStoreRequest, CallSettings)

public override Operation<ExampleStore, UpdateExampleStoreOperationMetadata> UpdateExampleStore(UpdateExampleStoreRequest request, CallSettings callSettings = null)

Update an ExampleStore.

Parameters
Name Description
request UpdateExampleStoreRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationExampleStoreUpdateExampleStoreOperationMetadata

The RPC response.
Overrides

UpdateExampleStoreAsync(UpdateExampleStoreRequest, CallSettings)

public override Task<Operation<ExampleStore, UpdateExampleStoreOperationMetadata>> UpdateExampleStoreAsync(UpdateExampleStoreRequest request, CallSettings callSettings = null)

Update an ExampleStore.

Parameters
Name Description
request UpdateExampleStoreRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationExampleStoreUpdateExampleStoreOperationMetadata

A Task containing the RPC response.
Overrides

UpsertExamples(UpsertExamplesRequest, CallSettings)

public override UpsertExamplesResponse UpsertExamples(UpsertExamplesRequest request, CallSettings callSettings = null)

Create or update Examples in the Example Store.

Parameters
Name Description
request UpsertExamplesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
UpsertExamplesResponse

The RPC response.
Overrides

UpsertExamplesAsync(UpsertExamplesRequest, CallSettings)

public override Task<UpsertExamplesResponse> UpsertExamplesAsync(UpsertExamplesRequest request, CallSettings callSettings = null)

Create or update Examples in the Example Store.

Parameters
Name Description
request UpsertExamplesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskUpsertExamplesResponse

A Task containing the RPC response.
Overrides