SaaS Runtime v1beta1 API - Class SaasRollouts.SaasRolloutsClient (1.0.0-beta01)

public class SaasRollouts.SaasRolloutsClient : ClientBase<SaasRollouts.SaasRolloutsClient>

Reference documentation and code samples for the SaaS Runtime v1beta1 API class SaasRollouts.SaasRolloutsClient.

Client for SaasRollouts

Inheritance

object > ClientBase > ClientBaseSaasRolloutsSaasRolloutsClient > SaasRollouts.SaasRolloutsClient

Namespace

Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1

Assembly

Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1.dll

Constructors

SaasRolloutsClient()

protected SaasRolloutsClient()

Protected parameterless constructor to allow creation of test doubles.

SaasRolloutsClient(CallInvoker)

public SaasRolloutsClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

SaasRolloutsClient(ChannelBase)

public SaasRolloutsClient(ChannelBase channel)

Creates a new client for SaasRollouts

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

SaasRolloutsClient(ClientBaseConfiguration)

protected SaasRolloutsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

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.

CreateRollout(CreateRolloutRequest, CallOptions)

public virtual Rollout CreateRollout(CreateRolloutRequest request, CallOptions options)

Create a new rollout.

Parameters
Name Description
request CreateRolloutRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Rollout

The response received from the server.

CreateRollout(CreateRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual Rollout CreateRollout(CreateRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create a new rollout.

Parameters
Name Description
request CreateRolloutRequest

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
Rollout

The response received from the server.

CreateRolloutAsync(CreateRolloutRequest, CallOptions)

public virtual AsyncUnaryCall<Rollout> CreateRolloutAsync(CreateRolloutRequest request, CallOptions options)

Create a new rollout.

Parameters
Name Description
request CreateRolloutRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallRollout

The call object.

CreateRolloutAsync(CreateRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Rollout> CreateRolloutAsync(CreateRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create a new rollout.

Parameters
Name Description
request CreateRolloutRequest

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
AsyncUnaryCallRollout

The call object.

CreateRolloutKind(CreateRolloutKindRequest, CallOptions)

public virtual RolloutKind CreateRolloutKind(CreateRolloutKindRequest request, CallOptions options)

Create a new rollout kind.

Parameters
Name Description
request CreateRolloutKindRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
RolloutKind

The response received from the server.

CreateRolloutKind(CreateRolloutKindRequest, Metadata, DateTime?, CancellationToken)

public virtual RolloutKind CreateRolloutKind(CreateRolloutKindRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create a new rollout kind.

Parameters
Name Description
request CreateRolloutKindRequest

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
RolloutKind

The response received from the server.

CreateRolloutKindAsync(CreateRolloutKindRequest, CallOptions)

public virtual AsyncUnaryCall<RolloutKind> CreateRolloutKindAsync(CreateRolloutKindRequest request, CallOptions options)

Create a new rollout kind.

Parameters
Name Description
request CreateRolloutKindRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallRolloutKind

The call object.

CreateRolloutKindAsync(CreateRolloutKindRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RolloutKind> CreateRolloutKindAsync(CreateRolloutKindRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create a new rollout kind.

Parameters
Name Description
request CreateRolloutKindRequest

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
AsyncUnaryCallRolloutKind

The call object.

DeleteRollout(DeleteRolloutRequest, CallOptions)

public virtual Empty DeleteRollout(DeleteRolloutRequest request, CallOptions options)

Delete a single rollout.

Parameters
Name Description
request DeleteRolloutRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteRollout(DeleteRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteRollout(DeleteRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Delete a single rollout.

Parameters
Name Description
request DeleteRolloutRequest

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
Empty

The response received from the server.

DeleteRolloutAsync(DeleteRolloutRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteRolloutAsync(DeleteRolloutRequest request, CallOptions options)

Delete a single rollout.

Parameters
Name Description
request DeleteRolloutRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteRolloutAsync(DeleteRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteRolloutAsync(DeleteRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Delete a single rollout.

Parameters
Name Description
request DeleteRolloutRequest

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
AsyncUnaryCallEmpty

The call object.

DeleteRolloutKind(DeleteRolloutKindRequest, CallOptions)

public virtual Empty DeleteRolloutKind(DeleteRolloutKindRequest request, CallOptions options)

Delete a single rollout kind.

Parameters
Name Description
request DeleteRolloutKindRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteRolloutKind(DeleteRolloutKindRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteRolloutKind(DeleteRolloutKindRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Delete a single rollout kind.

Parameters
Name Description
request DeleteRolloutKindRequest

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
Empty

The response received from the server.

DeleteRolloutKindAsync(DeleteRolloutKindRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteRolloutKindAsync(DeleteRolloutKindRequest request, CallOptions options)

Delete a single rollout kind.

Parameters
Name Description
request DeleteRolloutKindRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteRolloutKindAsync(DeleteRolloutKindRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteRolloutKindAsync(DeleteRolloutKindRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Delete a single rollout kind.

Parameters
Name Description
request DeleteRolloutKindRequest

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
AsyncUnaryCallEmpty

The call object.

GetRollout(GetRolloutRequest, CallOptions)

public virtual Rollout GetRollout(GetRolloutRequest request, CallOptions options)

Retrieve a single rollout.

Parameters
Name Description
request GetRolloutRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Rollout

The response received from the server.

GetRollout(GetRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual Rollout GetRollout(GetRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve a single rollout.

Parameters
Name Description
request GetRolloutRequest

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
Rollout

The response received from the server.

GetRolloutAsync(GetRolloutRequest, CallOptions)

public virtual AsyncUnaryCall<Rollout> GetRolloutAsync(GetRolloutRequest request, CallOptions options)

Retrieve a single rollout.

Parameters
Name Description
request GetRolloutRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallRollout

The call object.

GetRolloutAsync(GetRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Rollout> GetRolloutAsync(GetRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve a single rollout.

Parameters
Name Description
request GetRolloutRequest

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
AsyncUnaryCallRollout

The call object.

GetRolloutKind(GetRolloutKindRequest, CallOptions)

public virtual RolloutKind GetRolloutKind(GetRolloutKindRequest request, CallOptions options)

Retrieve a single rollout kind.

Parameters
Name Description
request GetRolloutKindRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
RolloutKind

The response received from the server.

GetRolloutKind(GetRolloutKindRequest, Metadata, DateTime?, CancellationToken)

public virtual RolloutKind GetRolloutKind(GetRolloutKindRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve a single rollout kind.

Parameters
Name Description
request GetRolloutKindRequest

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
RolloutKind

The response received from the server.

GetRolloutKindAsync(GetRolloutKindRequest, CallOptions)

public virtual AsyncUnaryCall<RolloutKind> GetRolloutKindAsync(GetRolloutKindRequest request, CallOptions options)

Retrieve a single rollout kind.

Parameters
Name Description
request GetRolloutKindRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallRolloutKind

The call object.

GetRolloutKindAsync(GetRolloutKindRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RolloutKind> GetRolloutKindAsync(GetRolloutKindRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve a single rollout kind.

Parameters
Name Description
request GetRolloutKindRequest

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
AsyncUnaryCallRolloutKind

The call object.

ListRolloutKinds(ListRolloutKindsRequest, CallOptions)

public virtual ListRolloutKindsResponse ListRolloutKinds(ListRolloutKindsRequest request, CallOptions options)

Retrieve a collection of rollout kinds.

Parameters
Name Description
request ListRolloutKindsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListRolloutKindsResponse

The response received from the server.

ListRolloutKinds(ListRolloutKindsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListRolloutKindsResponse ListRolloutKinds(ListRolloutKindsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve a collection of rollout kinds.

Parameters
Name Description
request ListRolloutKindsRequest

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
ListRolloutKindsResponse

The response received from the server.

ListRolloutKindsAsync(ListRolloutKindsRequest, CallOptions)

public virtual AsyncUnaryCall<ListRolloutKindsResponse> ListRolloutKindsAsync(ListRolloutKindsRequest request, CallOptions options)

Retrieve a collection of rollout kinds.

Parameters
Name Description
request ListRolloutKindsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListRolloutKindsResponse

The call object.

ListRolloutKindsAsync(ListRolloutKindsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListRolloutKindsResponse> ListRolloutKindsAsync(ListRolloutKindsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve a collection of rollout kinds.

Parameters
Name Description
request ListRolloutKindsRequest

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
AsyncUnaryCallListRolloutKindsResponse

The call object.

ListRollouts(ListRolloutsRequest, CallOptions)

public virtual ListRolloutsResponse ListRollouts(ListRolloutsRequest request, CallOptions options)

Retrieve a collection of rollouts.

Parameters
Name Description
request ListRolloutsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListRolloutsResponse

The response received from the server.

ListRollouts(ListRolloutsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListRolloutsResponse ListRollouts(ListRolloutsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve a collection of rollouts.

Parameters
Name Description
request ListRolloutsRequest

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
ListRolloutsResponse

The response received from the server.

ListRolloutsAsync(ListRolloutsRequest, CallOptions)

public virtual AsyncUnaryCall<ListRolloutsResponse> ListRolloutsAsync(ListRolloutsRequest request, CallOptions options)

Retrieve a collection of rollouts.

Parameters
Name Description
request ListRolloutsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListRolloutsResponse

The call object.

ListRolloutsAsync(ListRolloutsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListRolloutsResponse> ListRolloutsAsync(ListRolloutsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve a collection of rollouts.

Parameters
Name Description
request ListRolloutsRequest

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
AsyncUnaryCallListRolloutsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override SaasRollouts.SaasRolloutsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
SaasRolloutsSaasRolloutsClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1.SaasRollouts.SaasRolloutsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateRollout(UpdateRolloutRequest, CallOptions)

public virtual Rollout UpdateRollout(UpdateRolloutRequest request, CallOptions options)

Update a single rollout.

Parameters
Name Description
request UpdateRolloutRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Rollout

The response received from the server.

UpdateRollout(UpdateRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual Rollout UpdateRollout(UpdateRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update a single rollout.

Parameters
Name Description
request UpdateRolloutRequest

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
Rollout

The response received from the server.

UpdateRolloutAsync(UpdateRolloutRequest, CallOptions)

public virtual AsyncUnaryCall<Rollout> UpdateRolloutAsync(UpdateRolloutRequest request, CallOptions options)

Update a single rollout.

Parameters
Name Description
request UpdateRolloutRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallRollout

The call object.

UpdateRolloutAsync(UpdateRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Rollout> UpdateRolloutAsync(UpdateRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update a single rollout.

Parameters
Name Description
request UpdateRolloutRequest

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
AsyncUnaryCallRollout

The call object.

UpdateRolloutKind(UpdateRolloutKindRequest, CallOptions)

public virtual RolloutKind UpdateRolloutKind(UpdateRolloutKindRequest request, CallOptions options)

Update a single rollout kind.

Parameters
Name Description
request UpdateRolloutKindRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
RolloutKind

The response received from the server.

UpdateRolloutKind(UpdateRolloutKindRequest, Metadata, DateTime?, CancellationToken)

public virtual RolloutKind UpdateRolloutKind(UpdateRolloutKindRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update a single rollout kind.

Parameters
Name Description
request UpdateRolloutKindRequest

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
RolloutKind

The response received from the server.

UpdateRolloutKindAsync(UpdateRolloutKindRequest, CallOptions)

public virtual AsyncUnaryCall<RolloutKind> UpdateRolloutKindAsync(UpdateRolloutKindRequest request, CallOptions options)

Update a single rollout kind.

Parameters
Name Description
request UpdateRolloutKindRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallRolloutKind

The call object.

UpdateRolloutKindAsync(UpdateRolloutKindRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RolloutKind> UpdateRolloutKindAsync(UpdateRolloutKindRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update a single rollout kind.

Parameters
Name Description
request UpdateRolloutKindRequest

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
AsyncUnaryCallRolloutKind

The call object.