Compute Engine v1 API - Class ImagesClientImpl (3.1.0) 

public sealed class ImagesClientImpl : ImagesClient

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

Images client wrapper implementation, for convenient use.

Inheritance

object > ImagesClient > ImagesClientImpl

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The Images API.

Constructors

ImagesClientImpl(ImagesClient, ImagesSettings, ILogger)

public ImagesClientImpl(Images.ImagesClient grpcClient, ImagesSettings settings, ILogger logger)

Constructs a client wrapper for the Images service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient ImagesImagesClient

The underlying gRPC client.
settings ImagesSettings

The base ImagesSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type Description
OperationsClient
Overrides

DeprecateOperationsClient

public override OperationsClient DeprecateOperationsClient { get; }

The long-running operations client for Deprecate.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override Images.ImagesClient GrpcClient { get; }

The underlying gRPC Images client

Property Value
Type Description
ImagesImagesClient
Overrides

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type Description
OperationsClient
Overrides

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type Description
OperationsClient
Overrides

SetLabelsOperationsClient

public override OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
Type Description
OperationsClient
Overrides

Methods

Delete(DeleteImageRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteImageRequest request, CallSettings callSettings = null)

Deletes the specified image.

Parameters
Name Description
request DeleteImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

DeleteAsync(DeleteImageRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteImageRequest request, CallSettings callSettings = null)

Deletes the specified image.

Parameters
Name Description
request DeleteImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

Deprecate(DeprecateImageRequest, CallSettings)

public override Operation<Operation, Operation> Deprecate(DeprecateImageRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeprecateImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

DeprecateAsync(DeprecateImageRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeprecateAsync(DeprecateImageRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeprecateImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

Get(GetImageRequest, CallSettings)

public override Image Get(GetImageRequest request, CallSettings callSettings = null)

Returns the specified image.

Parameters
Name Description
request GetImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Image

The RPC response.
Overrides

GetAsync(GetImageRequest, CallSettings)

public override Task<Image> GetAsync(GetImageRequest request, CallSettings callSettings = null)

Returns the specified image.

Parameters
Name Description
request GetImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskImage

A Task containing the RPC response.
Overrides

GetFromFamily(GetFromFamilyImageRequest, CallSettings)

public override Image GetFromFamily(GetFromFamilyImageRequest request, CallSettings callSettings = null)

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
Name Description
request GetFromFamilyImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Image

The RPC response.
Overrides

GetFromFamilyAsync(GetFromFamilyImageRequest, CallSettings)

public override Task<Image> GetFromFamilyAsync(GetFromFamilyImageRequest request, CallSettings callSettings = null)

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
Name Description
request GetFromFamilyImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskImage

A Task containing the RPC response.
Overrides

GetIamPolicy(GetIamPolicyImageRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyImageRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetIamPolicyImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Policy

The RPC response.
Overrides

GetIamPolicyAsync(GetIamPolicyImageRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyImageRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetIamPolicyImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPolicy

A Task containing the RPC response.
Overrides

Insert(InsertImageRequest, CallSettings)

public override Operation<Operation, Operation> Insert(InsertImageRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request InsertImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

InsertAsync(InsertImageRequest, CallSettings)

public override Task<Operation<Operation, Operation>> InsertAsync(InsertImageRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request InsertImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

List(ListImagesRequest, CallSettings)

public override PagedEnumerable<ImageList, Image> List(ListImagesRequest request, CallSettings callSettings = null)

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
Name Description
request ListImagesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableImageListImage

A pageable sequence of Image resources.
Overrides

ListAsync(ListImagesRequest, CallSettings)

public override PagedAsyncEnumerable<ImageList, Image> ListAsync(ListImagesRequest request, CallSettings callSettings = null)

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
Name Description
request ListImagesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableImageListImage

A pageable asynchronous sequence of Image resources.
Overrides

Patch(PatchImageRequest, CallSettings)

public override Operation<Operation, Operation> Patch(PatchImageRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request PatchImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

PatchAsync(PatchImageRequest, CallSettings)

public override Task<Operation<Operation, Operation>> PatchAsync(PatchImageRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request PatchImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

SetIamPolicy(SetIamPolicyImageRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyImageRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SetIamPolicyImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Policy

The RPC response.
Overrides

SetIamPolicyAsync(SetIamPolicyImageRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyImageRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SetIamPolicyImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPolicy

A Task containing the RPC response.
Overrides

SetLabels(SetLabelsImageRequest, CallSettings)

public override Operation<Operation, Operation> SetLabels(SetLabelsImageRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SetLabelsImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationOperationOperation

The RPC response.
Overrides

SetLabelsAsync(SetLabelsImageRequest, CallSettings)

public override Task<Operation<Operation, Operation>> SetLabelsAsync(SetLabelsImageRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SetLabelsImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationOperationOperation

A Task containing the RPC response.
Overrides

TestIamPermissions(TestIamPermissionsImageRequest, CallSettings)

public override TestPermissionsResponse TestIamPermissions(TestIamPermissionsImageRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TestPermissionsResponse

The RPC response.
Overrides

TestIamPermissionsAsync(TestIamPermissionsImageRequest, CallSettings)

public override Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsImageRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
Name Description
request TestIamPermissionsImageRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTestPermissionsResponse

A Task containing the RPC response.
Overrides