Compute Engine v1 API - Class ImagesClientImpl (2.7.0)

Version 2.7.0

• 3.1.0 (latest)
• 3.0.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.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

Inherited Members

ImagesClient.DefaultEndpoint

ImagesClient.DefaultScopes

ImagesClient.ServiceMetadata

ImagesClient.CreateAsync(CancellationToken)

ImagesClient.Create()

ImagesClient.ShutdownDefaultChannelsAsync()

ImagesClient.DeleteAsync(DeleteImageRequest, CancellationToken)

ImagesClient.PollOnceDelete(string, CallSettings)

ImagesClient.PollOnceDeleteAsync(string, CallSettings)

ImagesClient.Delete(string, string, CallSettings)

ImagesClient.DeleteAsync(string, string, CallSettings)

ImagesClient.DeleteAsync(string, string, CancellationToken)

ImagesClient.DeprecateAsync(DeprecateImageRequest, CancellationToken)

ImagesClient.PollOnceDeprecate(string, CallSettings)

ImagesClient.PollOnceDeprecateAsync(string, CallSettings)

ImagesClient.Deprecate(string, string, DeprecationStatus, CallSettings)

ImagesClient.DeprecateAsync(string, string, DeprecationStatus, CallSettings)

ImagesClient.DeprecateAsync(string, string, DeprecationStatus, CancellationToken)

ImagesClient.GetAsync(GetImageRequest, CancellationToken)

ImagesClient.Get(string, string, CallSettings)

ImagesClient.GetAsync(string, string, CallSettings)

ImagesClient.GetAsync(string, string, CancellationToken)

ImagesClient.GetFromFamilyAsync(GetFromFamilyImageRequest, CancellationToken)

ImagesClient.GetFromFamily(string, string, CallSettings)

ImagesClient.GetFromFamilyAsync(string, string, CallSettings)

ImagesClient.GetFromFamilyAsync(string, string, CancellationToken)

ImagesClient.GetIamPolicyAsync(GetIamPolicyImageRequest, CancellationToken)

ImagesClient.GetIamPolicy(string, string, CallSettings)

ImagesClient.GetIamPolicyAsync(string, string, CallSettings)

ImagesClient.GetIamPolicyAsync(string, string, CancellationToken)

ImagesClient.InsertAsync(InsertImageRequest, CancellationToken)

ImagesClient.PollOnceInsert(string, CallSettings)

ImagesClient.PollOnceInsertAsync(string, CallSettings)

ImagesClient.Insert(string, Image, CallSettings)

ImagesClient.InsertAsync(string, Image, CallSettings)

ImagesClient.InsertAsync(string, Image, CancellationToken)

ImagesClient.List(string, string, int?, CallSettings)

ImagesClient.ListAsync(string, string, int?, CallSettings)

ImagesClient.PatchAsync(PatchImageRequest, CancellationToken)

ImagesClient.PollOncePatch(string, CallSettings)

ImagesClient.PollOncePatchAsync(string, CallSettings)

ImagesClient.Patch(string, string, Image, CallSettings)

ImagesClient.PatchAsync(string, string, Image, CallSettings)

ImagesClient.PatchAsync(string, string, Image, CancellationToken)

ImagesClient.SetIamPolicyAsync(SetIamPolicyImageRequest, CancellationToken)

ImagesClient.SetIamPolicy(string, string, GlobalSetPolicyRequest, CallSettings)

ImagesClient.SetIamPolicyAsync(string, string, GlobalSetPolicyRequest, CallSettings)

ImagesClient.SetIamPolicyAsync(string, string, GlobalSetPolicyRequest, CancellationToken)

ImagesClient.SetLabelsAsync(SetLabelsImageRequest, CancellationToken)

ImagesClient.PollOnceSetLabels(string, CallSettings)

ImagesClient.PollOnceSetLabelsAsync(string, CallSettings)

ImagesClient.SetLabels(string, string, GlobalSetLabelsRequest, CallSettings)

ImagesClient.SetLabelsAsync(string, string, GlobalSetLabelsRequest, CallSettings)

ImagesClient.SetLabelsAsync(string, string, GlobalSetLabelsRequest, CancellationToken)

ImagesClient.TestIamPermissionsAsync(TestIamPermissionsImageRequest, CancellationToken)

ImagesClient.TestIamPermissions(string, string, TestPermissionsRequest, CallSettings)

ImagesClient.TestIamPermissionsAsync(string, string, TestPermissionsRequest, CallSettings)

ImagesClient.TestIamPermissionsAsync(string, string, TestPermissionsRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

GoogleCloudGoogle.Cloud.ComputeV1

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

ImagesClient.DeleteOperationsClient

DeprecateOperationsClient

public override OperationsClient DeprecateOperationsClient { get; }

The long-running operations client for Deprecate.

Property Value
Type	Description
OperationsClient

Overrides

ImagesClient.DeprecateOperationsClient

GrpcClient

public override Images.ImagesClient GrpcClient { get; }

The underlying gRPC Images client

Property Value
Type	Description
ImagesImagesClient

Overrides

ImagesClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
OperationsClient

Overrides

ImagesClient.InsertOperationsClient

PatchOperationsClient

public override OperationsClient PatchOperationsClient { get; }

The long-running operations client for Patch.

Property Value
Type	Description
OperationsClient

Overrides

ImagesClient.PatchOperationsClient

SetLabelsOperationsClient

public override OperationsClient SetLabelsOperationsClient { get; }

The long-running operations client for SetLabels.

Property Value
Type	Description
OperationsClient

Overrides

ImagesClient.SetLabelsOperationsClient

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

ImagesClient.Delete(DeleteImageRequest, CallSettings)

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

ImagesClient.DeleteAsync(DeleteImageRequest, CallSettings)

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

ImagesClient.Deprecate(DeprecateImageRequest, CallSettings)

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

ImagesClient.DeprecateAsync(DeprecateImageRequest, CallSettings)

Get(GetImageRequest, CallSettings)

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

Returns the specified image. Gets a list of available images by making a list() request.

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

ImagesClient.Get(GetImageRequest, CallSettings)

GetAsync(GetImageRequest, CallSettings)

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

Returns the specified image. Gets a list of available images by making a list() request.

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

ImagesClient.GetAsync(GetImageRequest, CallSettings)

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.

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

ImagesClient.GetFromFamily(GetFromFamilyImageRequest, CallSettings)

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.

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

ImagesClient.GetFromFamilyAsync(GetFromFamilyImageRequest, CallSettings)

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

ImagesClient.GetIamPolicy(GetIamPolicyImageRequest, CallSettings)

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

ImagesClient.GetIamPolicyAsync(GetIamPolicyImageRequest, CallSettings)

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

ImagesClient.Insert(InsertImageRequest, CallSettings)

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

ImagesClient.InsertAsync(InsertImageRequest, CallSettings)

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

ImagesClient.List(ListImagesRequest, CallSettings)

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

ImagesClient.ListAsync(ListImagesRequest, CallSettings)

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

ImagesClient.Patch(PatchImageRequest, CallSettings)

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

ImagesClient.PatchAsync(PatchImageRequest, CallSettings)

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

ImagesClient.SetIamPolicy(SetIamPolicyImageRequest, CallSettings)

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

ImagesClient.SetIamPolicyAsync(SetIamPolicyImageRequest, CallSettings)

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

ImagesClient.SetLabels(SetLabelsImageRequest, CallSettings)

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

ImagesClient.SetLabelsAsync(SetLabelsImageRequest, CallSettings)

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

ImagesClient.TestIamPermissions(TestIamPermissionsImageRequest, CallSettings)

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

ImagesClient.TestIamPermissionsAsync(TestIamPermissionsImageRequest, CallSettings)