Show / Hide Table of Contents

Class SubscriptionsService.SubscriptionsServiceClient

Client for SubscriptionsService

Inheritance
object
ClientBase
ClientBase<SubscriptionsService.SubscriptionsServiceClient>
SubscriptionsService.SubscriptionsServiceClient
Inherited Members
ClientBase<SubscriptionsService.SubscriptionsServiceClient>.WithHost(string)
ClientBase.CallInvoker
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ToString()
Namespace: Google.Apps.Events.Subscriptions.V1
Assembly: Google.Apps.Events.Subscriptions.V1.dll
Syntax
public class SubscriptionsService.SubscriptionsServiceClient : ClientBase<SubscriptionsService.SubscriptionsServiceClient>

Constructors

SubscriptionsServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration
protected SubscriptionsServiceClient()

SubscriptionsServiceClient(CallInvoker)

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

Declaration
public SubscriptionsServiceClient(CallInvoker callInvoker)
Parameters
Type Name Description
CallInvoker callInvoker

The callInvoker to use to make remote calls.

SubscriptionsServiceClient(ChannelBase)

Creates a new client for SubscriptionsService

Declaration
public SubscriptionsServiceClient(ChannelBase channel)
Parameters
Type Name Description
ChannelBase channel

The channel to use to make remote calls.

SubscriptionsServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration
protected SubscriptionsServiceClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type Name Description
ClientBase.ClientBaseConfiguration configuration

The client configuration.

Methods

CreateOperationsClient()

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

Declaration
public virtual Operations.OperationsClient CreateOperationsClient()
Returns
Type Description
Operations.OperationsClient

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

CreateSubscription(CreateSubscriptionRequest, CallOptions)

Creates a Google Workspace subscription. To learn how to use this method, see Create a Google Workspace subscription.

Declaration
public virtual Operation CreateSubscription(CreateSubscriptionRequest request, CallOptions options)
Parameters
Type Name Description
CreateSubscriptionRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateSubscription(CreateSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Creates a Google Workspace subscription. To learn how to use this method, see Create a Google Workspace subscription.

Declaration
public virtual Operation CreateSubscription(CreateSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateSubscriptionRequest request

The request to send to the server.

Metadata headers

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

DateTime? deadline

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.

CreateSubscriptionAsync(CreateSubscriptionRequest, CallOptions)

Creates a Google Workspace subscription. To learn how to use this method, see Create a Google Workspace subscription.

Declaration
public virtual AsyncUnaryCall<Operation> CreateSubscriptionAsync(CreateSubscriptionRequest request, CallOptions options)
Parameters
Type Name Description
CreateSubscriptionRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

CreateSubscriptionAsync(CreateSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Creates a Google Workspace subscription. To learn how to use this method, see Create a Google Workspace subscription.

Declaration
public virtual AsyncUnaryCall<Operation> CreateSubscriptionAsync(CreateSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateSubscriptionRequest request

The request to send to the server.

Metadata headers

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

DateTime? deadline

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
AsyncUnaryCall<Operation>

The call object.

DeleteSubscription(DeleteSubscriptionRequest, CallOptions)

Deletes a Google Workspace subscription. To learn how to use this method, see Delete a Google Workspace subscription.

Declaration
public virtual Operation DeleteSubscription(DeleteSubscriptionRequest request, CallOptions options)
Parameters
Type Name Description
DeleteSubscriptionRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteSubscription(DeleteSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Deletes a Google Workspace subscription. To learn how to use this method, see Delete a Google Workspace subscription.

Declaration
public virtual Operation DeleteSubscription(DeleteSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DeleteSubscriptionRequest request

The request to send to the server.

Metadata headers

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

DateTime? deadline

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.

DeleteSubscriptionAsync(DeleteSubscriptionRequest, CallOptions)

Deletes a Google Workspace subscription. To learn how to use this method, see Delete a Google Workspace subscription.

Declaration
public virtual AsyncUnaryCall<Operation> DeleteSubscriptionAsync(DeleteSubscriptionRequest request, CallOptions options)
Parameters
Type Name Description
DeleteSubscriptionRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

DeleteSubscriptionAsync(DeleteSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Deletes a Google Workspace subscription. To learn how to use this method, see Delete a Google Workspace subscription.

Declaration
public virtual AsyncUnaryCall<Operation> DeleteSubscriptionAsync(DeleteSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DeleteSubscriptionRequest request

The request to send to the server.

Metadata headers

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

DateTime? deadline

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
AsyncUnaryCall<Operation>

The call object.

GetSubscription(GetSubscriptionRequest, CallOptions)

Gets details about a Google Workspace subscription. To learn how to use this method, see Get details about a Google Workspace subscription.

Declaration
public virtual Subscription GetSubscription(GetSubscriptionRequest request, CallOptions options)
Parameters
Type Name Description
GetSubscriptionRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Subscription

The response received from the server.

GetSubscription(GetSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Gets details about a Google Workspace subscription. To learn how to use this method, see Get details about a Google Workspace subscription.

Declaration
public virtual Subscription GetSubscription(GetSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetSubscriptionRequest request

The request to send to the server.

Metadata headers

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

DateTime? deadline

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
Subscription

The response received from the server.

GetSubscriptionAsync(GetSubscriptionRequest, CallOptions)

Gets details about a Google Workspace subscription. To learn how to use this method, see Get details about a Google Workspace subscription.

Declaration
public virtual AsyncUnaryCall<Subscription> GetSubscriptionAsync(GetSubscriptionRequest request, CallOptions options)
Parameters
Type Name Description
GetSubscriptionRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Subscription>

The call object.

GetSubscriptionAsync(GetSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Gets details about a Google Workspace subscription. To learn how to use this method, see Get details about a Google Workspace subscription.

Declaration
public virtual AsyncUnaryCall<Subscription> GetSubscriptionAsync(GetSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetSubscriptionRequest request

The request to send to the server.

Metadata headers

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

DateTime? deadline

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
AsyncUnaryCall<Subscription>

The call object.

ListSubscriptions(ListSubscriptionsRequest, CallOptions)

Lists Google Workspace subscriptions. To learn how to use this method, see List Google Workspace subscriptions.

Declaration
public virtual ListSubscriptionsResponse ListSubscriptions(ListSubscriptionsRequest request, CallOptions options)
Parameters
Type Name Description
ListSubscriptionsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
ListSubscriptionsResponse

The response received from the server.

ListSubscriptions(ListSubscriptionsRequest, Metadata, DateTime?, CancellationToken)

Lists Google Workspace subscriptions. To learn how to use this method, see List Google Workspace subscriptions.

Declaration
public virtual ListSubscriptionsResponse ListSubscriptions(ListSubscriptionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListSubscriptionsRequest request

The request to send to the server.

Metadata headers

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

DateTime? deadline

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
ListSubscriptionsResponse

The response received from the server.

ListSubscriptionsAsync(ListSubscriptionsRequest, CallOptions)

Lists Google Workspace subscriptions. To learn how to use this method, see List Google Workspace subscriptions.

Declaration
public virtual AsyncUnaryCall<ListSubscriptionsResponse> ListSubscriptionsAsync(ListSubscriptionsRequest request, CallOptions options)
Parameters
Type Name Description
ListSubscriptionsRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<ListSubscriptionsResponse>

The call object.

ListSubscriptionsAsync(ListSubscriptionsRequest, Metadata, DateTime?, CancellationToken)

Lists Google Workspace subscriptions. To learn how to use this method, see List Google Workspace subscriptions.

Declaration
public virtual AsyncUnaryCall<ListSubscriptionsResponse> ListSubscriptionsAsync(ListSubscriptionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ListSubscriptionsRequest request

The request to send to the server.

Metadata headers

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

DateTime? deadline

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
AsyncUnaryCall<ListSubscriptionsResponse>

The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration
protected override SubscriptionsService.SubscriptionsServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type Name Description
ClientBase.ClientBaseConfiguration configuration
Returns
Type Description
SubscriptionsService.SubscriptionsServiceClient
Overrides
Grpc.Core.ClientBase<Google.Apps.Events.Subscriptions.V1.SubscriptionsService.SubscriptionsServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

ReactivateSubscription(ReactivateSubscriptionRequest, CallOptions)

Reactivates a suspended Google Workspace subscription.

This method resets your subscription's State field to ACTIVE. Before you use this method, you must fix the error that suspended the subscription. To learn how to use this method, see Reactivate a Google Workspace subscription.

Declaration
public virtual Operation ReactivateSubscription(ReactivateSubscriptionRequest request, CallOptions options)
Parameters
Type Name Description
ReactivateSubscriptionRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Operation

The response received from the server.

ReactivateSubscription(ReactivateSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Reactivates a suspended Google Workspace subscription.

This method resets your subscription's State field to ACTIVE. Before you use this method, you must fix the error that suspended the subscription. To learn how to use this method, see Reactivate a Google Workspace subscription.

Declaration
public virtual Operation ReactivateSubscription(ReactivateSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ReactivateSubscriptionRequest request

The request to send to the server.

Metadata headers

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

DateTime? deadline

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.

ReactivateSubscriptionAsync(ReactivateSubscriptionRequest, CallOptions)

Reactivates a suspended Google Workspace subscription.

This method resets your subscription's State field to ACTIVE. Before you use this method, you must fix the error that suspended the subscription. To learn how to use this method, see Reactivate a Google Workspace subscription.

Declaration
public virtual AsyncUnaryCall<Operation> ReactivateSubscriptionAsync(ReactivateSubscriptionRequest request, CallOptions options)
Parameters
Type Name Description
ReactivateSubscriptionRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

ReactivateSubscriptionAsync(ReactivateSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Reactivates a suspended Google Workspace subscription.

This method resets your subscription's State field to ACTIVE. Before you use this method, you must fix the error that suspended the subscription. To learn how to use this method, see Reactivate a Google Workspace subscription.

Declaration
public virtual AsyncUnaryCall<Operation> ReactivateSubscriptionAsync(ReactivateSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ReactivateSubscriptionRequest request

The request to send to the server.

Metadata headers

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

DateTime? deadline

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
AsyncUnaryCall<Operation>

The call object.

UpdateSubscription(UpdateSubscriptionRequest, CallOptions)

Updates or renews a Google Workspace subscription. To learn how to use this method, see Update or renew a Google Workspace subscription.

Declaration
public virtual Operation UpdateSubscription(UpdateSubscriptionRequest request, CallOptions options)
Parameters
Type Name Description
UpdateSubscriptionRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpdateSubscription(UpdateSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Updates or renews a Google Workspace subscription. To learn how to use this method, see Update or renew a Google Workspace subscription.

Declaration
public virtual Operation UpdateSubscription(UpdateSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
UpdateSubscriptionRequest request

The request to send to the server.

Metadata headers

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

DateTime? deadline

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.

UpdateSubscriptionAsync(UpdateSubscriptionRequest, CallOptions)

Updates or renews a Google Workspace subscription. To learn how to use this method, see Update or renew a Google Workspace subscription.

Declaration
public virtual AsyncUnaryCall<Operation> UpdateSubscriptionAsync(UpdateSubscriptionRequest request, CallOptions options)
Parameters
Type Name Description
UpdateSubscriptionRequest request

The request to send to the server.

CallOptions options

The options for the call.

Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

UpdateSubscriptionAsync(UpdateSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Updates or renews a Google Workspace subscription. To learn how to use this method, see Update or renew a Google Workspace subscription.

Declaration
public virtual AsyncUnaryCall<Operation> UpdateSubscriptionAsync(UpdateSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
UpdateSubscriptionRequest request

The request to send to the server.

Metadata headers

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

DateTime? deadline

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
AsyncUnaryCall<Operation>

The call object.

In this article
Back to top Generated by DocFX