public sealed class ImagesClientImpl : ImagesClientReference documentation and code samples for the Compute Engine v1 API class ImagesClientImpl.
Images client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Compute.V1Assembly
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 | ImagesImagesClientThe underlying gRPC client. |
settings | ImagesSettingsThe base ImagesSettings used within this client. |
logger | ILoggerOptional 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 | |
DeprecateOperationsClient
public override OperationsClient DeprecateOperationsClient { get; }The long-running operations client for Deprecate.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override Images.ImagesClient GrpcClient { get; }The underlying gRPC Images client
| Property Value | |
|---|---|
| Type | Description |
ImagesImagesClient | |
InsertOperationsClient
public override OperationsClient InsertOperationsClient { get; }The long-running operations client for Insert.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
PatchOperationsClient
public override OperationsClient PatchOperationsClient { get; }The long-running operations client for Patch.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SetLabelsOperationsClient
public override OperationsClient SetLabelsOperationsClient { get; }The long-running operations client for SetLabels.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
Methods
Delete(DeleteImageRequest, CallSettings)
public override Operation<Operation, Operation> Delete(DeleteImageRequest request, CallSettings callSettings = null)Deletes the specified image.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
DeleteAsync(DeleteImageRequest, CallSettings)
public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteImageRequest request, CallSettings callSettings = null)Deletes the specified image.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
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 | DeprecateImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
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 | DeprecateImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
Get(GetImageRequest, CallSettings)
public override Image Get(GetImageRequest request, CallSettings callSettings = null)Returns the specified image.
| Parameters | |
|---|---|
| Name | Description |
request | GetImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Image | The RPC response. |
GetAsync(GetImageRequest, CallSettings)
public override Task<Image> GetAsync(GetImageRequest request, CallSettings callSettings = null)Returns the specified image.
| Parameters | |
|---|---|
| Name | Description |
request | GetImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskImage | A Task containing the RPC response. |
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 | GetFromFamilyImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Image | The RPC response. |
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 | GetFromFamilyImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskImage | A Task containing the RPC response. |
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 | GetIamPolicyImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
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 | GetIamPolicyImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
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 | InsertImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
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 | InsertImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
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 | ListImagesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableImageListImage | A pageable sequence of Image resources. |
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 | ListImagesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableImageListImage | A pageable asynchronous sequence of Image resources. |
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 | PatchImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
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 | PatchImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
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 | SetIamPolicyImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
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 | SetIamPolicyImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPolicy | A Task containing the RPC response. |
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 | SetLabelsImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationOperationOperation | The RPC response. |
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 | SetLabelsImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationOperationOperation | A Task containing the RPC response. |
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 | TestIamPermissionsImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TestPermissionsResponse | The RPC response. |
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 | TestIamPermissionsImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTestPermissionsResponse | A Task containing the RPC response. |