Data Analytics API with Gemini v1beta API - Class DataAgentService.DataAgentServiceClient (1.0.0-beta01)

public class DataAgentService.DataAgentServiceClient : ClientBase<DataAgentService.DataAgentServiceClient>

Reference documentation and code samples for the Data Analytics API with Gemini v1beta API class DataAgentService.DataAgentServiceClient.

Client for DataAgentService

Inheritance

object > ClientBase > ClientBaseDataAgentServiceDataAgentServiceClient > DataAgentService.DataAgentServiceClient

Namespace

Google.Cloud.GeminiDataAnalytics.V1Beta

Assembly

Google.Cloud.GeminiDataAnalytics.V1Beta.dll

Constructors

DataAgentServiceClient()

protected DataAgentServiceClient()

Protected parameterless constructor to allow creation of test doubles.

DataAgentServiceClient(CallInvoker)

public DataAgentServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

DataAgentServiceClient(ChannelBase)

public DataAgentServiceClient(ChannelBase channel)

Creates a new client for DataAgentService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

DataAgentServiceClient(ClientBaseConfiguration)

protected DataAgentServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateDataAgent(CreateDataAgentRequest, CallOptions)

public virtual Operation CreateDataAgent(CreateDataAgentRequest request, CallOptions options)

Creates a new DataAgent in a given project and location.

Parameters
Name Description
request CreateDataAgentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateDataAgent(CreateDataAgentRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new DataAgent in a given project and location.

Parameters
Name Description
request CreateDataAgentRequest

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.

CreateDataAgentAsync(CreateDataAgentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateDataAgentAsync(CreateDataAgentRequest request, CallOptions options)

Creates a new DataAgent in a given project and location.

Parameters
Name Description
request CreateDataAgentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateDataAgentAsync(CreateDataAgentRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new DataAgent in a given project and location.

Parameters
Name Description
request CreateDataAgentRequest

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.

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.

DeleteDataAgent(DeleteDataAgentRequest, CallOptions)

public virtual Operation DeleteDataAgent(DeleteDataAgentRequest request, CallOptions options)

Deletes a single DataAgent.

Parameters
Name Description
request DeleteDataAgentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteDataAgent(DeleteDataAgentRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single DataAgent.

Parameters
Name Description
request DeleteDataAgentRequest

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.

DeleteDataAgentAsync(DeleteDataAgentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteDataAgentAsync(DeleteDataAgentRequest request, CallOptions options)

Deletes a single DataAgent.

Parameters
Name Description
request DeleteDataAgentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteDataAgentAsync(DeleteDataAgentRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single DataAgent.

Parameters
Name Description
request DeleteDataAgentRequest

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.

GetDataAgent(GetDataAgentRequest, CallOptions)

public virtual DataAgent GetDataAgent(GetDataAgentRequest request, CallOptions options)

Gets details of a single DataAgent.

Parameters
Name Description
request GetDataAgentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
DataAgent

The response received from the server.

GetDataAgent(GetDataAgentRequest, Metadata, DateTime?, CancellationToken)

public virtual DataAgent GetDataAgent(GetDataAgentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single DataAgent.

Parameters
Name Description
request GetDataAgentRequest

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
DataAgent

The response received from the server.

GetDataAgentAsync(GetDataAgentRequest, CallOptions)

public virtual AsyncUnaryCall<DataAgent> GetDataAgentAsync(GetDataAgentRequest request, CallOptions options)

Gets details of a single DataAgent.

Parameters
Name Description
request GetDataAgentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallDataAgent

The call object.

GetDataAgentAsync(GetDataAgentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DataAgent> GetDataAgentAsync(GetDataAgentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single DataAgent.

Parameters
Name Description
request GetDataAgentRequest

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
AsyncUnaryCallDataAgent

The call object.

GetIamPolicy(GetIamPolicyRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallOptions options)

Gets the IAM policy for DataAgent

Parameters
Name Description
request GetIamPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Policy

The response received from the server.

GetIamPolicy(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the IAM policy for DataAgent

Parameters
Name Description
request GetIamPolicyRequest

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
Policy

The response received from the server.

GetIamPolicyAsync(GetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallOptions options)

Gets the IAM policy for DataAgent

Parameters
Name Description
request GetIamPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPolicy

The call object.

GetIamPolicyAsync(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the IAM policy for DataAgent

Parameters
Name Description
request GetIamPolicyRequest

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
AsyncUnaryCallPolicy

The call object.

ListAccessibleDataAgents(ListAccessibleDataAgentsRequest, CallOptions)

public virtual ListAccessibleDataAgentsResponse ListAccessibleDataAgents(ListAccessibleDataAgentsRequest request, CallOptions options)

Lists DataAgents that are accessible to the caller in a given project and location.

Parameters
Name Description
request ListAccessibleDataAgentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListAccessibleDataAgentsResponse

The response received from the server.

ListAccessibleDataAgents(ListAccessibleDataAgentsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListAccessibleDataAgentsResponse ListAccessibleDataAgents(ListAccessibleDataAgentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists DataAgents that are accessible to the caller in a given project and location.

Parameters
Name Description
request ListAccessibleDataAgentsRequest

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
ListAccessibleDataAgentsResponse

The response received from the server.

ListAccessibleDataAgentsAsync(ListAccessibleDataAgentsRequest, CallOptions)

public virtual AsyncUnaryCall<ListAccessibleDataAgentsResponse> ListAccessibleDataAgentsAsync(ListAccessibleDataAgentsRequest request, CallOptions options)

Lists DataAgents that are accessible to the caller in a given project and location.

Parameters
Name Description
request ListAccessibleDataAgentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListAccessibleDataAgentsResponse

The call object.

ListAccessibleDataAgentsAsync(ListAccessibleDataAgentsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListAccessibleDataAgentsResponse> ListAccessibleDataAgentsAsync(ListAccessibleDataAgentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists DataAgents that are accessible to the caller in a given project and location.

Parameters
Name Description
request ListAccessibleDataAgentsRequest

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
AsyncUnaryCallListAccessibleDataAgentsResponse

The call object.

ListDataAgents(ListDataAgentsRequest, CallOptions)

public virtual ListDataAgentsResponse ListDataAgents(ListDataAgentsRequest request, CallOptions options)

Lists DataAgents in a given project and location.

Parameters
Name Description
request ListDataAgentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListDataAgentsResponse

The response received from the server.

ListDataAgents(ListDataAgentsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDataAgentsResponse ListDataAgents(ListDataAgentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists DataAgents in a given project and location.

Parameters
Name Description
request ListDataAgentsRequest

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
ListDataAgentsResponse

The response received from the server.

ListDataAgentsAsync(ListDataAgentsRequest, CallOptions)

public virtual AsyncUnaryCall<ListDataAgentsResponse> ListDataAgentsAsync(ListDataAgentsRequest request, CallOptions options)

Lists DataAgents in a given project and location.

Parameters
Name Description
request ListDataAgentsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListDataAgentsResponse

The call object.

ListDataAgentsAsync(ListDataAgentsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDataAgentsResponse> ListDataAgentsAsync(ListDataAgentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists DataAgents in a given project and location.

Parameters
Name Description
request ListDataAgentsRequest

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
AsyncUnaryCallListDataAgentsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override DataAgentService.DataAgentServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
DataAgentServiceDataAgentServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.GeminiDataAnalytics.V1Beta.DataAgentService.DataAgentServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

SetIamPolicy(SetIamPolicyRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallOptions options)

Sets the IAM policy for a DataAgent.

Parameters
Name Description
request SetIamPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Policy

The response received from the server.

SetIamPolicy(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the IAM policy for a DataAgent.

Parameters
Name Description
request SetIamPolicyRequest

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
Policy

The response received from the server.

SetIamPolicyAsync(SetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallOptions options)

Sets the IAM policy for a DataAgent.

Parameters
Name Description
request SetIamPolicyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPolicy

The call object.

SetIamPolicyAsync(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the IAM policy for a DataAgent.

Parameters
Name Description
request SetIamPolicyRequest

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
AsyncUnaryCallPolicy

The call object.

UpdateDataAgent(UpdateDataAgentRequest, CallOptions)

public virtual Operation UpdateDataAgent(UpdateDataAgentRequest request, CallOptions options)

Updates the parameters of a single DataAgent.

Parameters
Name Description
request UpdateDataAgentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpdateDataAgent(UpdateDataAgentRequest, Metadata, DateTime?, CancellationToken)

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

Updates the parameters of a single DataAgent.

Parameters
Name Description
request UpdateDataAgentRequest

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.

UpdateDataAgentAsync(UpdateDataAgentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateDataAgentAsync(UpdateDataAgentRequest request, CallOptions options)

Updates the parameters of a single DataAgent.

Parameters
Name Description
request UpdateDataAgentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateDataAgentAsync(UpdateDataAgentRequest, Metadata, DateTime?, CancellationToken)

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

Updates the parameters of a single DataAgent.

Parameters
Name Description
request UpdateDataAgentRequest

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.