Class Eventarc.EventarcClient (1.1.0)

public class EventarcClient : ClientBase<Eventarc.EventarcClient>

Client for Eventarc

Inheritance

System.Object > ClientBase > ClientBase<Eventarc.EventarcClient> > Eventarc.EventarcClient

Namespace

Google.Cloud.Eventarc.V1

Assembly

Google.Cloud.Eventarc.V1.dll

Constructors

EventarcClient()

protected EventarcClient()

Protected parameterless constructor to allow creation of test doubles.

EventarcClient(CallInvoker)

public EventarcClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

EventarcClient(ChannelBase)

public EventarcClient(ChannelBase channel)

Creates a new client for Eventarc

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

EventarcClient(ClientBase.ClientBaseConfiguration)

protected EventarcClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

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

Returns
TypeDescription
Operations.OperationsClient

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

CreateTrigger(CreateTriggerRequest, CallOptions)

public virtual Operation CreateTrigger(CreateTriggerRequest request, CallOptions options)

Create a new trigger in a particular project and location.

Parameters
NameDescription
requestCreateTriggerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateTrigger(CreateTriggerRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Create a new trigger in a particular project and location.

Parameters
NameDescription
requestCreateTriggerRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateTriggerAsync(CreateTriggerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateTriggerAsync(CreateTriggerRequest request, CallOptions options)

Create a new trigger in a particular project and location.

Parameters
NameDescription
requestCreateTriggerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateTriggerAsync(CreateTriggerRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Create a new trigger in a particular project and location.

Parameters
NameDescription
requestCreateTriggerRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteTrigger(DeleteTriggerRequest, CallOptions)

public virtual Operation DeleteTrigger(DeleteTriggerRequest request, CallOptions options)

Delete a single trigger.

Parameters
NameDescription
requestDeleteTriggerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteTrigger(DeleteTriggerRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Delete a single trigger.

Parameters
NameDescription
requestDeleteTriggerRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteTriggerAsync(DeleteTriggerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteTriggerAsync(DeleteTriggerRequest request, CallOptions options)

Delete a single trigger.

Parameters
NameDescription
requestDeleteTriggerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteTriggerAsync(DeleteTriggerRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Delete a single trigger.

Parameters
NameDescription
requestDeleteTriggerRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

GetTrigger(GetTriggerRequest, CallOptions)

public virtual Trigger GetTrigger(GetTriggerRequest request, CallOptions options)

Get a single trigger.

Parameters
NameDescription
requestGetTriggerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Trigger

The response received from the server.

GetTrigger(GetTriggerRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Trigger GetTrigger(GetTriggerRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Get a single trigger.

Parameters
NameDescription
requestGetTriggerRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Trigger

The response received from the server.

GetTriggerAsync(GetTriggerRequest, CallOptions)

public virtual AsyncUnaryCall<Trigger> GetTriggerAsync(GetTriggerRequest request, CallOptions options)

Get a single trigger.

Parameters
NameDescription
requestGetTriggerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Trigger>

The call object.

GetTriggerAsync(GetTriggerRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Trigger> GetTriggerAsync(GetTriggerRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Get a single trigger.

Parameters
NameDescription
requestGetTriggerRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Trigger>

The call object.

ListTriggers(ListTriggersRequest, CallOptions)

public virtual ListTriggersResponse ListTriggers(ListTriggersRequest request, CallOptions options)

List triggers.

Parameters
NameDescription
requestListTriggersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListTriggersResponse

The response received from the server.

ListTriggers(ListTriggersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListTriggersResponse ListTriggers(ListTriggersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

List triggers.

Parameters
NameDescription
requestListTriggersRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListTriggersResponse

The response received from the server.

ListTriggersAsync(ListTriggersRequest, CallOptions)

public virtual AsyncUnaryCall<ListTriggersResponse> ListTriggersAsync(ListTriggersRequest request, CallOptions options)

List triggers.

Parameters
NameDescription
requestListTriggersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListTriggersResponse>

The call object.

ListTriggersAsync(ListTriggersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListTriggersResponse> ListTriggersAsync(ListTriggersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

List triggers.

Parameters
NameDescription
requestListTriggersRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListTriggersResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override Eventarc.EventarcClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
Eventarc.EventarcClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Eventarc.V1.Eventarc.EventarcClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateTrigger(UpdateTriggerRequest, CallOptions)

public virtual Operation UpdateTrigger(UpdateTriggerRequest request, CallOptions options)

Update a single trigger.

Parameters
NameDescription
requestUpdateTriggerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateTrigger(UpdateTriggerRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Update a single trigger.

Parameters
NameDescription
requestUpdateTriggerRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateTriggerAsync(UpdateTriggerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateTriggerAsync(UpdateTriggerRequest request, CallOptions options)

Update a single trigger.

Parameters
NameDescription
requestUpdateTriggerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateTriggerAsync(UpdateTriggerRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Update a single trigger.

Parameters
NameDescription
requestUpdateTriggerRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.