Google Cloud Deploy v1 API - Class CloudDeploy.CloudDeployClient (2.3.0)

Stay organized with collections Save and categorize content based on your preferences.
public class CloudDeploy.CloudDeployClient : ClientBase<CloudDeploy.CloudDeployClient>

Reference documentation and code samples for the Google Cloud Deploy v1 API class CloudDeploy.CloudDeployClient.

Client for CloudDeploy

Inheritance

object > ClientBase > ClientBaseCloudDeployCloudDeployClient > CloudDeploy.CloudDeployClient

Namespace

GoogleCloudGoogle.Cloud.DeployV1

Assembly

Google.Cloud.Deploy.V1.dll

Constructors

CloudDeployClient()

protected CloudDeployClient()

Protected parameterless constructor to allow creation of test doubles.

CloudDeployClient(CallInvoker)

public CloudDeployClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

CloudDeployClient(ChannelBase)

public CloudDeployClient(ChannelBase channel)

Creates a new client for CloudDeploy

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

CloudDeployClient(ClientBaseConfiguration)

protected CloudDeployClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

AbandonRelease(AbandonReleaseRequest, CallOptions)

public virtual AbandonReleaseResponse AbandonRelease(AbandonReleaseRequest request, CallOptions options)

Abandons a Release in the Delivery Pipeline.

Parameters
NameDescription
requestAbandonReleaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AbandonReleaseResponse

The response received from the server.

AbandonRelease(AbandonReleaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AbandonReleaseResponse AbandonRelease(AbandonReleaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Abandons a Release in the Delivery Pipeline.

Parameters
NameDescription
requestAbandonReleaseRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AbandonReleaseResponse

The response received from the server.

AbandonReleaseAsync(AbandonReleaseRequest, CallOptions)

public virtual AsyncUnaryCall<AbandonReleaseResponse> AbandonReleaseAsync(AbandonReleaseRequest request, CallOptions options)

Abandons a Release in the Delivery Pipeline.

Parameters
NameDescription
requestAbandonReleaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallAbandonReleaseResponse

The call object.

AbandonReleaseAsync(AbandonReleaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AbandonReleaseResponse> AbandonReleaseAsync(AbandonReleaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Abandons a Release in the Delivery Pipeline.

Parameters
NameDescription
requestAbandonReleaseRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallAbandonReleaseResponse

The call object.

AdvanceRollout(AdvanceRolloutRequest, CallOptions)

public virtual AdvanceRolloutResponse AdvanceRollout(AdvanceRolloutRequest request, CallOptions options)

Advances a Rollout in a given project and location.

Parameters
NameDescription
requestAdvanceRolloutRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AdvanceRolloutResponse

The response received from the server.

AdvanceRollout(AdvanceRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual AdvanceRolloutResponse AdvanceRollout(AdvanceRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Advances a Rollout in a given project and location.

Parameters
NameDescription
requestAdvanceRolloutRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AdvanceRolloutResponse

The response received from the server.

AdvanceRolloutAsync(AdvanceRolloutRequest, CallOptions)

public virtual AsyncUnaryCall<AdvanceRolloutResponse> AdvanceRolloutAsync(AdvanceRolloutRequest request, CallOptions options)

Advances a Rollout in a given project and location.

Parameters
NameDescription
requestAdvanceRolloutRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallAdvanceRolloutResponse

The call object.

AdvanceRolloutAsync(AdvanceRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AdvanceRolloutResponse> AdvanceRolloutAsync(AdvanceRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Advances a Rollout in a given project and location.

Parameters
NameDescription
requestAdvanceRolloutRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallAdvanceRolloutResponse

The call object.

ApproveRollout(ApproveRolloutRequest, CallOptions)

public virtual ApproveRolloutResponse ApproveRollout(ApproveRolloutRequest request, CallOptions options)

Approves a Rollout.

Parameters
NameDescription
requestApproveRolloutRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ApproveRolloutResponse

The response received from the server.

ApproveRollout(ApproveRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual ApproveRolloutResponse ApproveRollout(ApproveRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Approves a Rollout.

Parameters
NameDescription
requestApproveRolloutRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
ApproveRolloutResponse

The response received from the server.

ApproveRolloutAsync(ApproveRolloutRequest, CallOptions)

public virtual AsyncUnaryCall<ApproveRolloutResponse> ApproveRolloutAsync(ApproveRolloutRequest request, CallOptions options)

Approves a Rollout.

Parameters
NameDescription
requestApproveRolloutRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallApproveRolloutResponse

The call object.

ApproveRolloutAsync(ApproveRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ApproveRolloutResponse> ApproveRolloutAsync(ApproveRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Approves a Rollout.

Parameters
NameDescription
requestApproveRolloutRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallApproveRolloutResponse

The call object.

CancelRollout(CancelRolloutRequest, CallOptions)

public virtual CancelRolloutResponse CancelRollout(CancelRolloutRequest request, CallOptions options)

Cancels a Rollout in a given project and location.

Parameters
NameDescription
requestCancelRolloutRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
CancelRolloutResponse

The response received from the server.

CancelRollout(CancelRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual CancelRolloutResponse CancelRollout(CancelRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Cancels a Rollout in a given project and location.

Parameters
NameDescription
requestCancelRolloutRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
CancelRolloutResponse

The response received from the server.

CancelRolloutAsync(CancelRolloutRequest, CallOptions)

public virtual AsyncUnaryCall<CancelRolloutResponse> CancelRolloutAsync(CancelRolloutRequest request, CallOptions options)

Cancels a Rollout in a given project and location.

Parameters
NameDescription
requestCancelRolloutRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallCancelRolloutResponse

The call object.

CancelRolloutAsync(CancelRolloutRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CancelRolloutResponse> CancelRolloutAsync(CancelRolloutRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Cancels a Rollout in a given project and location.

Parameters
NameDescription
requestCancelRolloutRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallCancelRolloutResponse

The call object.

CreateDeliveryPipeline(CreateDeliveryPipelineRequest, CallOptions)

public virtual Operation CreateDeliveryPipeline(CreateDeliveryPipelineRequest request, CallOptions options)

Creates a new DeliveryPipeline in a given project and location.

Parameters
NameDescription
requestCreateDeliveryPipelineRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateDeliveryPipeline(CreateDeliveryPipelineRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new DeliveryPipeline in a given project and location.

Parameters
NameDescription
requestCreateDeliveryPipelineRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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.

CreateDeliveryPipelineAsync(CreateDeliveryPipelineRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateDeliveryPipelineAsync(CreateDeliveryPipelineRequest request, CallOptions options)

Creates a new DeliveryPipeline in a given project and location.

Parameters
NameDescription
requestCreateDeliveryPipelineRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateDeliveryPipelineAsync(CreateDeliveryPipelineRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new DeliveryPipeline in a given project and location.

Parameters
NameDescription
requestCreateDeliveryPipelineRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallOperation

The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
TypeDescription
IAMPolicyIAMPolicyClient

A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
TypeDescription
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

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

Returns
TypeDescription
OperationsOperationsClient

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

CreateRelease(CreateReleaseRequest, CallOptions)

public virtual Operation CreateRelease(CreateReleaseRequest request, CallOptions options)

Creates a new Release in a given project and location.

Parameters
NameDescription
requestCreateReleaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateRelease(CreateReleaseRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new Release in a given project and location.

Parameters
NameDescription
requestCreateReleaseRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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.

CreateReleaseAsync(CreateReleaseRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateReleaseAsync(CreateReleaseRequest request, CallOptions options)

Creates a new Release in a given project and location.

Parameters
NameDescription
requestCreateReleaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateReleaseAsync(CreateReleaseRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new Release in a given project and location.

Parameters
NameDescription
requestCreateReleaseRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallOperation

The call object.

CreateRollout(CreateRolloutRequest, CallOptions)

public virtual Operation CreateRollout(CreateRolloutRequest request, CallOptions options)

Creates a new Rollout in a given project and location.

Parameters
NameDescription
requestCreateRolloutRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateRollout(CreateRolloutRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new Rollout in a given project and location.

Parameters
NameDescription
requestCreateRolloutRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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.

CreateRolloutAsync(CreateRolloutRequest, CallOptions)

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

Creates a new Rollout in a given project and location.

Parameters
NameDescription
requestCreateRolloutRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateRolloutAsync(CreateRolloutRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new Rollout in a given project and location.

Parameters
NameDescription
requestCreateRolloutRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallOperation

The call object.

CreateTarget(CreateTargetRequest, CallOptions)

public virtual Operation CreateTarget(CreateTargetRequest request, CallOptions options)

Creates a new Target in a given project and location.

Parameters
NameDescription
requestCreateTargetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateTarget(CreateTargetRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new Target in a given project and location.

Parameters
NameDescription
requestCreateTargetRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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.

CreateTargetAsync(CreateTargetRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateTargetAsync(CreateTargetRequest request, CallOptions options)

Creates a new Target in a given project and location.

Parameters
NameDescription
requestCreateTargetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateTargetAsync(CreateTargetRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new Target in a given project and location.

Parameters
NameDescription
requestCreateTargetRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallOperation

The call object.

DeleteDeliveryPipeline(DeleteDeliveryPipelineRequest, CallOptions)

public virtual Operation DeleteDeliveryPipeline(DeleteDeliveryPipelineRequest request, CallOptions options)

Deletes a single DeliveryPipeline.

Parameters
NameDescription
requestDeleteDeliveryPipelineRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteDeliveryPipeline(DeleteDeliveryPipelineRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single DeliveryPipeline.

Parameters
NameDescription
requestDeleteDeliveryPipelineRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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.

DeleteDeliveryPipelineAsync(DeleteDeliveryPipelineRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteDeliveryPipelineAsync(DeleteDeliveryPipelineRequest request, CallOptions options)

Deletes a single DeliveryPipeline.

Parameters
NameDescription
requestDeleteDeliveryPipelineRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteDeliveryPipelineAsync(DeleteDeliveryPipelineRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single DeliveryPipeline.

Parameters
NameDescription
requestDeleteDeliveryPipelineRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallOperation

The call object.

DeleteTarget(DeleteTargetRequest, CallOptions)

public virtual Operation DeleteTarget(DeleteTargetRequest request, CallOptions options)

Deletes a single Target.

Parameters
NameDescription
requestDeleteTargetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteTarget(DeleteTargetRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single Target.

Parameters
NameDescription
requestDeleteTargetRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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.

DeleteTargetAsync(DeleteTargetRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteTargetAsync(DeleteTargetRequest request, CallOptions options)

Deletes a single Target.

Parameters
NameDescription
requestDeleteTargetRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteTargetAsync(DeleteTargetRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single Target.

Parameters
NameDescription
requestDeleteTargetRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallOperation

The call object.

GetConfig(GetConfigRequest, CallOptions)

public virtual Config GetConfig(GetConfigRequest request, CallOptions options)

Gets the configuration for a location.

Parameters
NameDescription
requestGetConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Config

The response received from the server.

GetConfig(GetConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual Config GetConfig(GetConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the configuration for a location.

Parameters
NameDescription
requestGetConfigRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
Config

The response received from the server.

GetConfigAsync(GetConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Config> GetConfigAsync(GetConfigRequest request, CallOptions options)

Gets the configuration for a location.

Parameters
NameDescription
requestGetConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallConfig

The call object.

GetConfigAsync(GetConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Config> GetConfigAsync(GetConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the configuration for a location.

Parameters
NameDescription
requestGetConfigRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallConfig

The call object.

GetDeliveryPipeline(GetDeliveryPipelineRequest, CallOptions)

public virtual DeliveryPipeline GetDeliveryPipeline(GetDeliveryPipelineRequest request, CallOptions options)

Gets details of a single DeliveryPipeline.

Parameters
NameDescription
requestGetDeliveryPipelineRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
DeliveryPipeline

The response received from the server.

GetDeliveryPipeline(GetDeliveryPipelineRequest, Metadata, DateTime?, CancellationToken)

public virtual DeliveryPipeline GetDeliveryPipeline(GetDeliveryPipelineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single DeliveryPipeline.

Parameters
NameDescription
requestGetDeliveryPipelineRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
DeliveryPipeline

The response received from the server.

GetDeliveryPipelineAsync(GetDeliveryPipelineRequest, CallOptions)

public virtual AsyncUnaryCall<DeliveryPipeline> GetDeliveryPipelineAsync(GetDeliveryPipelineRequest request, CallOptions options)

Gets details of a single DeliveryPipeline.

Parameters
NameDescription
requestGetDeliveryPipelineRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallDeliveryPipeline

The call object.

GetDeliveryPipelineAsync(GetDeliveryPipelineRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DeliveryPipeline> GetDeliveryPipelineAsync(GetDeliveryPipelineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single DeliveryPipeline.

Parameters
NameDescription
requestGetDeliveryPipelineRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallDeliveryPipeline

The call object.

GetJobRun(GetJobRunRequest, CallOptions)

public virtual JobRun GetJobRun(GetJobRunRequest request, CallOptions options)

Gets details of a single JobRun.

Parameters
NameDescription
requestGetJobRunRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
JobRun

The response received from the server.

GetJobRun(GetJobRunRequest, Metadata, DateTime?, CancellationToken)

public virtual JobRun GetJobRun(GetJobRunRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single JobRun.

Parameters
NameDescription
requestGetJobRunRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
JobRun

The response received from the server.

GetJobRunAsync(GetJobRunRequest, CallOptions)

public virtual AsyncUnaryCall<JobRun> GetJobRunAsync(GetJobRunRequest request, CallOptions options)

Gets details of a single JobRun.

Parameters
NameDescription
requestGetJobRunRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallJobRun

The call object.