Compute Engine v1 API - Class BackendBuckets.BackendBucketsClient (2.2.0)

public class BackendBucketsClient : ClientBase<BackendBuckets.BackendBucketsClient>

Reference documentation and code samples for the Compute Engine v1 API class BackendBuckets.BackendBucketsClient.

Client for BackendBuckets

Inheritance

Object > ClientBase > ClientBase<BackendBuckets.BackendBucketsClient> > BackendBuckets.BackendBucketsClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

BackendBucketsClient()

protected BackendBucketsClient()

Protected parameterless constructor to allow creation of test doubles.

BackendBucketsClient(CallInvoker)

public BackendBucketsClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

BackendBucketsClient(ChannelBase)

public BackendBucketsClient(ChannelBase channel)

Creates a new client for BackendBuckets

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

BackendBucketsClient(ClientBase.ClientBaseConfiguration)

protected BackendBucketsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

AddSignedUrlKey(AddSignedUrlKeyBackendBucketRequest, CallOptions)

public virtual Operation AddSignedUrlKey(AddSignedUrlKeyBackendBucketRequest request, CallOptions options)

Adds a key for validating requests with signed URLs for this backend bucket.

Parameters
NameDescription
requestAddSignedUrlKeyBackendBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

AddSignedUrlKey(AddSignedUrlKeyBackendBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Adds a key for validating requests with signed URLs for this backend bucket.

Parameters
NameDescription
requestAddSignedUrlKeyBackendBucketRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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.

AddSignedUrlKeyAsync(AddSignedUrlKeyBackendBucketRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> AddSignedUrlKeyAsync(AddSignedUrlKeyBackendBucketRequest request, CallOptions options)

Adds a key for validating requests with signed URLs for this backend bucket.

Parameters
NameDescription
requestAddSignedUrlKeyBackendBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

AddSignedUrlKeyAsync(AddSignedUrlKeyBackendBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Adds a key for validating requests with signed URLs for this backend bucket.

Parameters
NameDescription
requestAddSignedUrlKeyBackendBucketRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

The call object.

CreateOperationsClientForGlobalOperations()

public virtual Operations.OperationsClient CreateOperationsClientForGlobalOperations()

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

Returns
TypeDescription
Operations.OperationsClient

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

Delete(DeleteBackendBucketRequest, CallOptions)

public virtual Operation Delete(DeleteBackendBucketRequest request, CallOptions options)

Deletes the specified BackendBucket resource.

Parameters
NameDescription
requestDeleteBackendBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Delete(DeleteBackendBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified BackendBucket resource.

Parameters
NameDescription
requestDeleteBackendBucketRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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.

DeleteAsync(DeleteBackendBucketRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteAsync(DeleteBackendBucketRequest request, CallOptions options)

Deletes the specified BackendBucket resource.

Parameters
NameDescription
requestDeleteBackendBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteAsync(DeleteBackendBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified BackendBucket resource.

Parameters
NameDescription
requestDeleteBackendBucketRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

The call object.

DeleteSignedUrlKey(DeleteSignedUrlKeyBackendBucketRequest, CallOptions)

public virtual Operation DeleteSignedUrlKey(DeleteSignedUrlKeyBackendBucketRequest request, CallOptions options)

Deletes a key for validating requests with signed URLs for this backend bucket.

Parameters
NameDescription
requestDeleteSignedUrlKeyBackendBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteSignedUrlKey(DeleteSignedUrlKeyBackendBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a key for validating requests with signed URLs for this backend bucket.

Parameters
NameDescription
requestDeleteSignedUrlKeyBackendBucketRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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.

DeleteSignedUrlKeyAsync(DeleteSignedUrlKeyBackendBucketRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteSignedUrlKeyAsync(DeleteSignedUrlKeyBackendBucketRequest request, CallOptions options)

Deletes a key for validating requests with signed URLs for this backend bucket.

Parameters
NameDescription
requestDeleteSignedUrlKeyBackendBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteSignedUrlKeyAsync(DeleteSignedUrlKeyBackendBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a key for validating requests with signed URLs for this backend bucket.

Parameters
NameDescription
requestDeleteSignedUrlKeyBackendBucketRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

The call object.

Get(GetBackendBucketRequest, CallOptions)

public virtual BackendBucket Get(GetBackendBucketRequest request, CallOptions options)

Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.

Parameters
NameDescription
requestGetBackendBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
BackendBucket

The response received from the server.

Get(GetBackendBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual BackendBucket Get(GetBackendBucketRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.

Parameters
NameDescription
requestGetBackendBucketRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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
BackendBucket

The response received from the server.

GetAsync(GetBackendBucketRequest, CallOptions)

public virtual AsyncUnaryCall<BackendBucket> GetAsync(GetBackendBucketRequest request, CallOptions options)

Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.

Parameters
NameDescription
requestGetBackendBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<BackendBucket>

The call object.

GetAsync(GetBackendBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<BackendBucket> GetAsync(GetBackendBucketRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.

Parameters
NameDescription
requestGetBackendBucketRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

The call object.

Insert(InsertBackendBucketRequest, CallOptions)

public virtual Operation Insert(InsertBackendBucketRequest request, CallOptions options)

Creates a BackendBucket resource in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertBackendBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Insert(InsertBackendBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a BackendBucket resource in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertBackendBucketRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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.

InsertAsync(InsertBackendBucketRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InsertAsync(InsertBackendBucketRequest request, CallOptions options)

Creates a BackendBucket resource in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertBackendBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

InsertAsync(InsertBackendBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a BackendBucket resource in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertBackendBucketRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

The call object.

List(ListBackendBucketsRequest, CallOptions)

public virtual BackendBucketList List(ListBackendBucketsRequest request, CallOptions options)

Retrieves the list of BackendBucket resources available to the specified project.

Parameters
NameDescription
requestListBackendBucketsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
BackendBucketList

The response received from the server.

List(ListBackendBucketsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual BackendBucketList List(ListBackendBucketsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves the list of BackendBucket resources available to the specified project.

Parameters
NameDescription
requestListBackendBucketsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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
BackendBucketList

The response received from the server.

ListAsync(ListBackendBucketsRequest, CallOptions)

public virtual AsyncUnaryCall<BackendBucketList> ListAsync(ListBackendBucketsRequest request, CallOptions options)

Retrieves the list of BackendBucket resources available to the specified project.

Parameters
NameDescription
requestListBackendBucketsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<BackendBucketList>

The call object.

ListAsync(ListBackendBucketsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<BackendBucketList> ListAsync(ListBackendBucketsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves the list of BackendBucket resources available to the specified project.

Parameters
NameDescription
requestListBackendBucketsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override BackendBuckets.BackendBucketsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
BackendBuckets.BackendBucketsClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Compute.V1.BackendBuckets.BackendBucketsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Patch(PatchBackendBucketRequest, CallOptions)

public virtual Operation Patch(PatchBackendBucketRequest request, CallOptions options)

Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchBackendBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Patch(PatchBackendBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchBackendBucketRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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.

PatchAsync(PatchBackendBucketRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PatchAsync(PatchBackendBucketRequest request, CallOptions options)

Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchBackendBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

PatchAsync(PatchBackendBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
NameDescription
requestPatchBackendBucketRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

The call object.

SetEdgeSecurityPolicy(SetEdgeSecurityPolicyBackendBucketRequest, CallOptions)

public virtual Operation SetEdgeSecurityPolicy(SetEdgeSecurityPolicyBackendBucketRequest request, CallOptions options)

Sets the edge security policy for the specified backend bucket.

Parameters
NameDescription
requestSetEdgeSecurityPolicyBackendBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetEdgeSecurityPolicy(SetEdgeSecurityPolicyBackendBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets the edge security policy for the specified backend bucket.

Parameters
NameDescription
requestSetEdgeSecurityPolicyBackendBucketRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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.

SetEdgeSecurityPolicyAsync(SetEdgeSecurityPolicyBackendBucketRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetEdgeSecurityPolicyAsync(SetEdgeSecurityPolicyBackendBucketRequest request, CallOptions options)

Sets the edge security policy for the specified backend bucket.

Parameters
NameDescription
requestSetEdgeSecurityPolicyBackendBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetEdgeSecurityPolicyAsync(SetEdgeSecurityPolicyBackendBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Sets the edge security policy for the specified backend bucket.

Parameters
NameDescription
requestSetEdgeSecurityPolicyBackendBucketRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

The call object.

Update(UpdateBackendBucketRequest, CallOptions)

public virtual Operation Update(UpdateBackendBucketRequest request, CallOptions options)

Updates the specified BackendBucket resource with the data included in the request.

Parameters
NameDescription
requestUpdateBackendBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Update(UpdateBackendBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the specified BackendBucket resource with the data included in the request.

Parameters
NameDescription
requestUpdateBackendBucketRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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.

UpdateAsync(UpdateBackendBucketRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateAsync(UpdateBackendBucketRequest request, CallOptions options)

Updates the specified BackendBucket resource with the data included in the request.

Parameters
NameDescription
requestUpdateBackendBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateAsync(UpdateBackendBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates the specified BackendBucket resource with the data included in the request.

Parameters
NameDescription
requestUpdateBackendBucketRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

The call object.