Compute Engine v1 API - Class Images.ImagesClient (2.12.0)

public class Images.ImagesClient : ClientBase<Images.ImagesClient>

Reference documentation and code samples for the Compute Engine v1 API class Images.ImagesClient.

Client for Images

Inheritance

object > ClientBase > ClientBaseImagesImagesClient > Images.ImagesClient

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

ImagesClient()

protected ImagesClient()

Protected parameterless constructor to allow creation of test doubles.

ImagesClient(CallInvoker)

public ImagesClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

ImagesClient(ChannelBase)

public ImagesClient(ChannelBase channel)

Creates a new client for Images

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

ImagesClient(ClientBaseConfiguration)

protected ImagesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

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
OperationsOperationsClient

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

Delete(DeleteImageRequest, CallOptions)

public virtual Operation Delete(DeleteImageRequest request, CallOptions options)

Deletes the specified image.

Parameters
NameDescription
requestDeleteImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Delete(DeleteImageRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified image.

Parameters
NameDescription
requestDeleteImageRequest

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.

DeleteAsync(DeleteImageRequest, CallOptions)

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

Deletes the specified image.

Parameters
NameDescription
requestDeleteImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteAsync(DeleteImageRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified image.

Parameters
NameDescription
requestDeleteImageRequest

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.

Deprecate(DeprecateImageRequest, CallOptions)

public virtual Operation Deprecate(DeprecateImageRequest request, CallOptions options)

Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.

Parameters
NameDescription
requestDeprecateImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Deprecate(DeprecateImageRequest, Metadata, DateTime?, CancellationToken)

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

Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.

Parameters
NameDescription
requestDeprecateImageRequest

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.

DeprecateAsync(DeprecateImageRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeprecateAsync(DeprecateImageRequest request, CallOptions options)

Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.

Parameters
NameDescription
requestDeprecateImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeprecateAsync(DeprecateImageRequest, Metadata, DateTime?, CancellationToken)

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

Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.

Parameters
NameDescription
requestDeprecateImageRequest

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.

Get(GetImageRequest, CallOptions)

public virtual Image Get(GetImageRequest request, CallOptions options)

Returns the specified image.

Parameters
NameDescription
requestGetImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Image

The response received from the server.

Get(GetImageRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified image.

Parameters
NameDescription
requestGetImageRequest

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
Image

The response received from the server.

GetAsync(GetImageRequest, CallOptions)

public virtual AsyncUnaryCall<Image> GetAsync(GetImageRequest request, CallOptions options)

Returns the specified image.

Parameters
NameDescription
requestGetImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallImage

The call object.

GetAsync(GetImageRequest, Metadata, DateTime?, CancellationToken)

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

Returns the specified image.

Parameters
NameDescription
requestGetImageRequest

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
AsyncUnaryCallImage

The call object.

GetFromFamily(GetFromFamilyImageRequest, CallOptions)

public virtual Image GetFromFamily(GetFromFamilyImageRequest request, CallOptions options)

Returns the latest image that is part of an image family and is not deprecated. For more information on image families, see Public image families documentation.

Parameters
NameDescription
requestGetFromFamilyImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Image

The response received from the server.

GetFromFamily(GetFromFamilyImageRequest, Metadata, DateTime?, CancellationToken)

public virtual Image GetFromFamily(GetFromFamilyImageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the latest image that is part of an image family and is not deprecated. For more information on image families, see Public image families documentation.

Parameters
NameDescription
requestGetFromFamilyImageRequest

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
Image

The response received from the server.

GetFromFamilyAsync(GetFromFamilyImageRequest, CallOptions)

public virtual AsyncUnaryCall<Image> GetFromFamilyAsync(GetFromFamilyImageRequest request, CallOptions options)

Returns the latest image that is part of an image family and is not deprecated. For more information on image families, see Public image families documentation.

Parameters
NameDescription
requestGetFromFamilyImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallImage

The call object.

GetFromFamilyAsync(GetFromFamilyImageRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Image> GetFromFamilyAsync(GetFromFamilyImageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the latest image that is part of an image family and is not deprecated. For more information on image families, see Public image families documentation.

Parameters
NameDescription
requestGetFromFamilyImageRequest

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
AsyncUnaryCallImage

The call object.

GetIamPolicy(GetIamPolicyImageRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyImageRequest request, CallOptions options)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
requestGetIamPolicyImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Policy

The response received from the server.

GetIamPolicy(GetIamPolicyImageRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyImageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
requestGetIamPolicyImageRequest

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
Policy

The response received from the server.

GetIamPolicyAsync(GetIamPolicyImageRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyImageRequest request, CallOptions options)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
requestGetIamPolicyImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallPolicy

The call object.

GetIamPolicyAsync(GetIamPolicyImageRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyImageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
requestGetIamPolicyImageRequest

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
AsyncUnaryCallPolicy

The call object.

Insert(InsertImageRequest, CallOptions)

public virtual Operation Insert(InsertImageRequest request, CallOptions options)

Creates an image in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Insert(InsertImageRequest, Metadata, DateTime?, CancellationToken)

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

Creates an image in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertImageRequest

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.

InsertAsync(InsertImageRequest, CallOptions)

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

Creates an image in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

InsertAsync(InsertImageRequest, Metadata, DateTime?, CancellationToken)

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

Creates an image in the specified project using the data included in the request.

Parameters
NameDescription
requestInsertImageRequest

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.

List(ListImagesRequest, CallOptions)

public virtual ImageList List(ListImagesRequest request, CallOptions options)

Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

Parameters
NameDescription
requestListImagesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ImageList

The response received from the server.

List(ListImagesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

Parameters
NameDescription
requestListImagesRequest

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
ImageList

The response received from the server.

ListAsync(ListImagesRequest, CallOptions)

public virtual AsyncUnaryCall<ImageList> ListAsync(ListImagesRequest request, CallOptions options)

Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

Parameters
NameDescription
requestListImagesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallImageList

The call object.

ListAsync(ListImagesRequest, Metadata, DateTime?, CancellationToken)

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

Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

Parameters
NameDescription
requestListImagesRequest

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
AsyncUnaryCallImageList

The call object.

NewInstance(ClientBaseConfiguration)

protected override Images.ImagesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
ImagesImagesClient
Overrides

Patch(PatchImageRequest, CallOptions)

public virtual Operation Patch(PatchImageRequest request, CallOptions options)

Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.

Parameters
NameDescription
requestPatchImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

Patch(PatchImageRequest, Metadata, DateTime?, CancellationToken)

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

Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.

Parameters
NameDescription
requestPatchImageRequest

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.

PatchAsync(PatchImageRequest, CallOptions)

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

Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.

Parameters
NameDescription
requestPatchImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

PatchAsync(PatchImageRequest, Metadata, DateTime?, CancellationToken)

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

Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.

Parameters
NameDescription
requestPatchImageRequest

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.

SetIamPolicy(SetIamPolicyImageRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyImageRequest request, CallOptions options)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
requestSetIamPolicyImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Policy

The response received from the server.

SetIamPolicy(SetIamPolicyImageRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy SetIamPolicy(SetIamPolicyImageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
requestSetIamPolicyImageRequest

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
Policy

The response received from the server.

SetIamPolicyAsync(SetIamPolicyImageRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyImageRequest request, CallOptions options)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
requestSetIamPolicyImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallPolicy

The call object.

SetIamPolicyAsync(SetIamPolicyImageRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyImageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
requestSetIamPolicyImageRequest

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
AsyncUnaryCallPolicy

The call object.

SetLabels(SetLabelsImageRequest, CallOptions)

public virtual Operation SetLabels(SetLabelsImageRequest request, CallOptions options)

Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.

Parameters
NameDescription
requestSetLabelsImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetLabels(SetLabelsImageRequest, Metadata, DateTime?, CancellationToken)

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

Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.

Parameters
NameDescription
requestSetLabelsImageRequest

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.

SetLabelsAsync(SetLabelsImageRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetLabelsAsync(SetLabelsImageRequest request, CallOptions options)

Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.

Parameters
NameDescription
requestSetLabelsImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

SetLabelsAsync(SetLabelsImageRequest, Metadata, DateTime?, CancellationToken)

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

Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.

Parameters
NameDescription
requestSetLabelsImageRequest

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.

TestIamPermissions(TestIamPermissionsImageRequest, CallOptions)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsImageRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TestPermissionsResponse

The response received from the server.

TestIamPermissions(TestIamPermissionsImageRequest, Metadata, DateTime?, CancellationToken)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsImageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsImageRequest

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
TestPermissionsResponse

The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsImageRequest, CallOptions)

public virtual AsyncUnaryCall<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsImageRequest request, CallOptions options)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsImageRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallTestPermissionsResponse

The call object.

TestIamPermissionsAsync(TestIamPermissionsImageRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsImageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsImageRequest

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
AsyncUnaryCallTestPermissionsResponse

The call object.