Class DataSubscriptionService.DataSubscriptionServiceClient

Client for DataSubscriptionService

Inheritance

object

ClientBase

ClientBase<DataSubscriptionService.DataSubscriptionServiceClient>

DataSubscriptionService.DataSubscriptionServiceClient

Inherited Members

ClientBase<DataSubscriptionService.DataSubscriptionServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace: Google.DevicesAndServices.Health.V4

Assembly: Google.DevicesAndServices.Health.V4.dll

Syntax

public class DataSubscriptionService.DataSubscriptionServiceClient : ClientBase<DataSubscriptionService.DataSubscriptionServiceClient>

Constructors

DataSubscriptionServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected DataSubscriptionServiceClient()

DataSubscriptionServiceClient(CallInvoker)

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

Declaration

public DataSubscriptionServiceClient(CallInvoker callInvoker)

Parameters

Type	Name	Description
CallInvoker	callInvoker	The callInvoker to use to make remote calls.

DataSubscriptionServiceClient(ChannelBase)

Creates a new client for DataSubscriptionService

Declaration

public DataSubscriptionServiceClient(ChannelBase channel)

Parameters

Type	Name	Description
ChannelBase	channel	The channel to use to make remote calls.

DataSubscriptionServiceClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected DataSubscriptionServiceClient(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.

CreateSubscriber(CreateSubscriberRequest, CallOptions)

Registers a new subscriber endpoint to receive notifications. A subscriber represents an application or service that wishes to receive data change notifications for users who have granted consent.

Endpoint Verification: For a subscriber to be successfully created, the provided endpoint_uri must be a valid HTTPS endpoint and must pass an automated verification check. The backend will send two HTTP POST requests to the endpoint_uri:

1. Verification with Authorization:

   • Headers: Includes Content-Type: application/json and Authorization (with the exact value from CreateSubscriberPayload.endpoint_authorization.secret).
   • Body: {"type": "verification"}
   • Expected Response: HTTP 201 Created.

2. Verification without Authorization:

   • Headers: Includes Content-Type: application/json. The Authorization header is OMITTED.
   • Body: {"type": "verification"}
   • Expected Response: HTTP 401 Unauthorized or 403 Forbidden.

Both tests must pass for the subscriber creation to succeed. If verification fails, the operation will not be completed and an error will be returned. This process ensures the endpoint is reachable and correctly validates the Authorization header.

Declaration

public virtual Operation CreateSubscriber(CreateSubscriberRequest request, CallOptions options)

Parameters

Type	Name	Description
CreateSubscriberRequest	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.

CreateSubscriber(CreateSubscriberRequest, Metadata, DateTime?, CancellationToken)

Registers a new subscriber endpoint to receive notifications. A subscriber represents an application or service that wishes to receive data change notifications for users who have granted consent.

Endpoint Verification: For a subscriber to be successfully created, the provided endpoint_uri must be a valid HTTPS endpoint and must pass an automated verification check. The backend will send two HTTP POST requests to the endpoint_uri:

1. Verification with Authorization:

   • Headers: Includes Content-Type: application/json and Authorization (with the exact value from CreateSubscriberPayload.endpoint_authorization.secret).
   • Body: {"type": "verification"}
   • Expected Response: HTTP 201 Created.

2. Verification without Authorization:

   • Headers: Includes Content-Type: application/json. The Authorization header is OMITTED.
   • Body: {"type": "verification"}
   • Expected Response: HTTP 401 Unauthorized or 403 Forbidden.

Both tests must pass for the subscriber creation to succeed. If verification fails, the operation will not be completed and an error will be returned. This process ensures the endpoint is reachable and correctly validates the Authorization header.

Declaration

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

Parameters

Type	Name	Description
CreateSubscriberRequest	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.

CreateSubscriberAsync(CreateSubscriberRequest, CallOptions)

Registers a new subscriber endpoint to receive notifications. A subscriber represents an application or service that wishes to receive data change notifications for users who have granted consent.

Endpoint Verification: For a subscriber to be successfully created, the provided endpoint_uri must be a valid HTTPS endpoint and must pass an automated verification check. The backend will send two HTTP POST requests to the endpoint_uri:

1. Verification with Authorization:

   • Headers: Includes Content-Type: application/json and Authorization (with the exact value from CreateSubscriberPayload.endpoint_authorization.secret).
   • Body: {"type": "verification"}
   • Expected Response: HTTP 201 Created.

2. Verification without Authorization:

   • Headers: Includes Content-Type: application/json. The Authorization header is OMITTED.
   • Body: {"type": "verification"}
   • Expected Response: HTTP 401 Unauthorized or 403 Forbidden.

Both tests must pass for the subscriber creation to succeed. If verification fails, the operation will not be completed and an error will be returned. This process ensures the endpoint is reachable and correctly validates the Authorization header.

Declaration

public virtual AsyncUnaryCall<Operation> CreateSubscriberAsync(CreateSubscriberRequest request, CallOptions options)

Parameters

Type	Name	Description
CreateSubscriberRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

CreateSubscriberAsync(CreateSubscriberRequest, Metadata, DateTime?, CancellationToken)

Registers a new subscriber endpoint to receive notifications. A subscriber represents an application or service that wishes to receive data change notifications for users who have granted consent.

Endpoint Verification: For a subscriber to be successfully created, the provided endpoint_uri must be a valid HTTPS endpoint and must pass an automated verification check. The backend will send two HTTP POST requests to the endpoint_uri:

1. Verification with Authorization:

   • Headers: Includes Content-Type: application/json and Authorization (with the exact value from CreateSubscriberPayload.endpoint_authorization.secret).
   • Body: {"type": "verification"}
   • Expected Response: HTTP 201 Created.

2. Verification without Authorization:

   • Headers: Includes Content-Type: application/json. The Authorization header is OMITTED.
   • Body: {"type": "verification"}
   • Expected Response: HTTP 401 Unauthorized or 403 Forbidden.

Both tests must pass for the subscriber creation to succeed. If verification fails, the operation will not be completed and an error will be returned. This process ensures the endpoint is reachable and correctly validates the Authorization header.

Declaration

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

Parameters

Type	Name	Description
CreateSubscriberRequest	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.

CreateSubscription(CreateSubscriptionRequest, CallOptions)

Creates a subscription for a specific user to a specific subscriber. This method requires the subscriber to have a SubscriptionCreatePolicy set to MANUAL for the given data types.

Declaration

public virtual Subscription 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
Subscription	The response received from the server.

CreateSubscription(CreateSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Creates a subscription for a specific user to a specific subscriber. This method requires the subscriber to have a SubscriptionCreatePolicy set to MANUAL for the given data types.

Declaration

public virtual Subscription 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
Subscription	The response received from the server.

CreateSubscriptionAsync(CreateSubscriptionRequest, CallOptions)

Creates a subscription for a specific user to a specific subscriber. This method requires the subscriber to have a SubscriptionCreatePolicy set to MANUAL for the given data types.

Declaration

public virtual AsyncUnaryCall<Subscription> 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<Subscription>	The call object.

CreateSubscriptionAsync(CreateSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Creates a subscription for a specific user to a specific subscriber. This method requires the subscriber to have a SubscriptionCreatePolicy set to MANUAL for the given data types.

Declaration

public virtual AsyncUnaryCall<Subscription> 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<Subscription>	The call object.

DeleteSubscriber(DeleteSubscriberRequest, CallOptions)

Deletes a subscriber registration. This will stop all notifications to the subscriber's endpoint.

Declaration

public virtual Operation DeleteSubscriber(DeleteSubscriberRequest request, CallOptions options)

Parameters

Type	Name	Description
DeleteSubscriberRequest	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.

DeleteSubscriber(DeleteSubscriberRequest, Metadata, DateTime?, CancellationToken)

Deletes a subscriber registration. This will stop all notifications to the subscriber's endpoint.

Declaration

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

Parameters

Type	Name	Description
DeleteSubscriberRequest	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.

DeleteSubscriberAsync(DeleteSubscriberRequest, CallOptions)

Deletes a subscriber registration. This will stop all notifications to the subscriber's endpoint.

Declaration

public virtual AsyncUnaryCall<Operation> DeleteSubscriberAsync(DeleteSubscriberRequest request, CallOptions options)

Parameters

Type	Name	Description
DeleteSubscriberRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

DeleteSubscriberAsync(DeleteSubscriberRequest, Metadata, DateTime?, CancellationToken)

Deletes a subscriber registration. This will stop all notifications to the subscriber's endpoint.

Declaration

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

Parameters

Type	Name	Description
DeleteSubscriberRequest	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 specific user subscription, stopping notifications for this user to this subscriber.

Declaration

public virtual Empty 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
Empty	The response received from the server.

DeleteSubscription(DeleteSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Deletes a specific user subscription, stopping notifications for this user to this subscriber.

Declaration

public virtual Empty 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
Empty	The response received from the server.

DeleteSubscriptionAsync(DeleteSubscriptionRequest, CallOptions)

Deletes a specific user subscription, stopping notifications for this user to this subscriber.

Declaration

public virtual AsyncUnaryCall<Empty> 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<Empty>	The call object.

DeleteSubscriptionAsync(DeleteSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Deletes a specific user subscription, stopping notifications for this user to this subscriber.

Declaration

public virtual AsyncUnaryCall<Empty> 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<Empty>	The call object.

ListSubscribers(ListSubscribersRequest, CallOptions)

Lists all subscribers registered within the owned Google Cloud Project.

Declaration

public virtual ListSubscribersResponse ListSubscribers(ListSubscribersRequest request, CallOptions options)

Parameters

Type	Name	Description
ListSubscribersRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
ListSubscribersResponse	The response received from the server.

ListSubscribers(ListSubscribersRequest, Metadata, DateTime?, CancellationToken)

Lists all subscribers registered within the owned Google Cloud Project.

Declaration

public virtual ListSubscribersResponse ListSubscribers(ListSubscribersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListSubscribersRequest	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
ListSubscribersResponse	The response received from the server.

ListSubscribersAsync(ListSubscribersRequest, CallOptions)

Lists all subscribers registered within the owned Google Cloud Project.

Declaration

public virtual AsyncUnaryCall<ListSubscribersResponse> ListSubscribersAsync(ListSubscribersRequest request, CallOptions options)

Parameters

Type	Name	Description
ListSubscribersRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<ListSubscribersResponse>	The call object.

ListSubscribersAsync(ListSubscribersRequest, Metadata, DateTime?, CancellationToken)

Lists all subscribers registered within the owned Google Cloud Project.

Declaration

public virtual AsyncUnaryCall<ListSubscribersResponse> ListSubscribersAsync(ListSubscribersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListSubscribersRequest	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<ListSubscribersResponse>	The call object.

ListSubscriptions(ListSubscriptionsRequest, CallOptions)

Lists all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.

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 all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.

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 all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.

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 all active subscriptions for a given subscriber. This can be filtered, for example, by user or data type.

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 DataSubscriptionService.DataSubscriptionServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
DataSubscriptionService.DataSubscriptionServiceClient

Overrides

Grpc.Core.ClientBase<Google.DevicesAndServices.Health.V4.DataSubscriptionService.DataSubscriptionServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateSubscriber(UpdateSubscriberRequest, CallOptions)

Updates the configuration of an existing subscriber, such as the endpoint URI or the data types it's interested in.

Endpoint Verification: If the endpoint_uri or endpoint_authorization field is included in the update_mask, the backend will re-verify the endpoint. The verification process is the same as described in CreateSubscriber:

1. Verification with Authorization: POST to the new or existing endpoint_uri with the new or existing Authorization secret. Expects HTTP 201 Created.
2. Verification without Authorization: POST to the endpoint_uri without the Authorization header. Expects HTTP 401 Unauthorized or 403 Forbidden.

Both tests must pass using the potentially updated values for the subscriber update to succeed. If verification fails, the update will not be applied, and an error will be returned.

Declaration

public virtual Operation UpdateSubscriber(UpdateSubscriberRequest request, CallOptions options)

Parameters

Type	Name	Description
UpdateSubscriberRequest	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.

UpdateSubscriber(UpdateSubscriberRequest, Metadata, DateTime?, CancellationToken)

Updates the configuration of an existing subscriber, such as the endpoint URI or the data types it's interested in.

Endpoint Verification: If the endpoint_uri or endpoint_authorization field is included in the update_mask, the backend will re-verify the endpoint. The verification process is the same as described in CreateSubscriber:

1. Verification with Authorization: POST to the new or existing endpoint_uri with the new or existing Authorization secret. Expects HTTP 201 Created.
2. Verification without Authorization: POST to the endpoint_uri without the Authorization header. Expects HTTP 401 Unauthorized or 403 Forbidden.

Both tests must pass using the potentially updated values for the subscriber update to succeed. If verification fails, the update will not be applied, and an error will be returned.

Declaration

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

Parameters

Type	Name	Description
UpdateSubscriberRequest	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.

UpdateSubscriberAsync(UpdateSubscriberRequest, CallOptions)

Updates the configuration of an existing subscriber, such as the endpoint URI or the data types it's interested in.

Endpoint Verification: If the endpoint_uri or endpoint_authorization field is included in the update_mask, the backend will re-verify the endpoint. The verification process is the same as described in CreateSubscriber:

1. Verification with Authorization: POST to the new or existing endpoint_uri with the new or existing Authorization secret. Expects HTTP 201 Created.
2. Verification without Authorization: POST to the endpoint_uri without the Authorization header. Expects HTTP 401 Unauthorized or 403 Forbidden.

Both tests must pass using the potentially updated values for the subscriber update to succeed. If verification fails, the update will not be applied, and an error will be returned.

Declaration

public virtual AsyncUnaryCall<Operation> UpdateSubscriberAsync(UpdateSubscriberRequest request, CallOptions options)

Parameters

Type	Name	Description
UpdateSubscriberRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

UpdateSubscriberAsync(UpdateSubscriberRequest, Metadata, DateTime?, CancellationToken)

Updates the configuration of an existing subscriber, such as the endpoint URI or the data types it's interested in.

Endpoint Verification: If the endpoint_uri or endpoint_authorization field is included in the update_mask, the backend will re-verify the endpoint. The verification process is the same as described in CreateSubscriber:

1. Verification with Authorization: POST to the new or existing endpoint_uri with the new or existing Authorization secret. Expects HTTP 201 Created.
2. Verification without Authorization: POST to the endpoint_uri without the Authorization header. Expects HTTP 401 Unauthorized or 403 Forbidden.

Both tests must pass using the potentially updated values for the subscriber update to succeed. If verification fails, the update will not be applied, and an error will be returned.

Declaration

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

Parameters

Type	Name	Description
UpdateSubscriberRequest	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 the data types for an existing user subscription.

Declaration

public virtual Subscription 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
Subscription	The response received from the server.

UpdateSubscription(UpdateSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Updates the data types for an existing user subscription.

Declaration

public virtual Subscription 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
Subscription	The response received from the server.

UpdateSubscriptionAsync(UpdateSubscriptionRequest, CallOptions)

Updates the data types for an existing user subscription.

Declaration

public virtual AsyncUnaryCall<Subscription> 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<Subscription>	The call object.

UpdateSubscriptionAsync(UpdateSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Updates the data types for an existing user subscription.

Declaration

public virtual AsyncUnaryCall<Subscription> 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<Subscription>	The call object.