Eventarc Publishing v1 API - Class Publisher.PublisherClient (2.0.0-beta07)

public class Publisher.PublisherClient : ClientBase<Publisher.PublisherClient>

Reference documentation and code samples for the Eventarc Publishing v1 API class Publisher.PublisherClient.

Client for Publisher

Inheritance

object > ClientBase > ClientBasePublisherPublisherClient > Publisher.PublisherClient

Namespace

Google.Cloud.Eventarc.Publishing.V1

Assembly

Google.Cloud.Eventarc.Publishing.V1.dll

Constructors

PublisherClient()

protected PublisherClient()

Protected parameterless constructor to allow creation of test doubles.

PublisherClient(CallInvoker)

public PublisherClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

PublisherClient(ChannelBase)

public PublisherClient(ChannelBase channel)

Creates a new client for Publisher

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

PublisherClient(ClientBaseConfiguration)

protected PublisherClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

NewInstance(ClientBaseConfiguration)

protected override Publisher.PublisherClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
PublisherPublisherClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Eventarc.Publishing.V1.Publisher.PublisherClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Publish(PublishRequest, CallOptions)

public virtual PublishResponse Publish(PublishRequest request, CallOptions options)

Publish events to a message bus.

Parameters
Name Description
request PublishRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
PublishResponse

The response received from the server.

Publish(PublishRequest, Metadata, DateTime?, CancellationToken)

public virtual PublishResponse Publish(PublishRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Publish events to a message bus.

Parameters
Name Description
request PublishRequest

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
PublishResponse

The response received from the server.

PublishAsync(PublishRequest, CallOptions)

public virtual AsyncUnaryCall<PublishResponse> PublishAsync(PublishRequest request, CallOptions options)

Publish events to a message bus.

Parameters
Name Description
request PublishRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPublishResponse

The call object.

PublishAsync(PublishRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<PublishResponse> PublishAsync(PublishRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Publish events to a message bus.

Parameters
Name Description
request PublishRequest

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
AsyncUnaryCallPublishResponse

The call object.

PublishChannelConnectionEvents(PublishChannelConnectionEventsRequest, CallOptions)

public virtual PublishChannelConnectionEventsResponse PublishChannelConnectionEvents(PublishChannelConnectionEventsRequest request, CallOptions options)

Publish events to a ChannelConnection in a partner's project.

Parameters
Name Description
request PublishChannelConnectionEventsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
PublishChannelConnectionEventsResponse

The response received from the server.

PublishChannelConnectionEvents(PublishChannelConnectionEventsRequest, Metadata, DateTime?, CancellationToken)

public virtual PublishChannelConnectionEventsResponse PublishChannelConnectionEvents(PublishChannelConnectionEventsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Publish events to a ChannelConnection in a partner's project.

Parameters
Name Description
request PublishChannelConnectionEventsRequest

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
PublishChannelConnectionEventsResponse

The response received from the server.

PublishChannelConnectionEventsAsync(PublishChannelConnectionEventsRequest, CallOptions)

public virtual AsyncUnaryCall<PublishChannelConnectionEventsResponse> PublishChannelConnectionEventsAsync(PublishChannelConnectionEventsRequest request, CallOptions options)

Publish events to a ChannelConnection in a partner's project.

Parameters
Name Description
request PublishChannelConnectionEventsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPublishChannelConnectionEventsResponse

The call object.

PublishChannelConnectionEventsAsync(PublishChannelConnectionEventsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<PublishChannelConnectionEventsResponse> PublishChannelConnectionEventsAsync(PublishChannelConnectionEventsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Publish events to a ChannelConnection in a partner's project.

Parameters
Name Description
request PublishChannelConnectionEventsRequest

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
AsyncUnaryCallPublishChannelConnectionEventsResponse

The call object.

PublishEvents(PublishEventsRequest, CallOptions)

public virtual PublishEventsResponse PublishEvents(PublishEventsRequest request, CallOptions options)

Publish events to a subscriber's channel.

Parameters
Name Description
request PublishEventsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
PublishEventsResponse

The response received from the server.

PublishEvents(PublishEventsRequest, Metadata, DateTime?, CancellationToken)

public virtual PublishEventsResponse PublishEvents(PublishEventsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Publish events to a subscriber's channel.

Parameters
Name Description
request PublishEventsRequest

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
PublishEventsResponse

The response received from the server.

PublishEventsAsync(PublishEventsRequest, CallOptions)

public virtual AsyncUnaryCall<PublishEventsResponse> PublishEventsAsync(PublishEventsRequest request, CallOptions options)

Publish events to a subscriber's channel.

Parameters
Name Description
request PublishEventsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPublishEventsResponse

The call object.

PublishEventsAsync(PublishEventsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<PublishEventsResponse> PublishEventsAsync(PublishEventsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Publish events to a subscriber's channel.

Parameters
Name Description
request PublishEventsRequest

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
AsyncUnaryCallPublishEventsResponse

The call object.