- 1.57.0 (latest)
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
GitHub Repository | Product Reference |
Service Description: The Images API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
String project = "project-309310695";
String image = "image100313435";
Image response = imagesClient.get(project, image);
}
Note: close() needs to be called on the ImagesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
Method | Description | Method Variants |
---|---|---|
Delete | Deletes the specified image. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Deprecate | Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Get | Returns the specified image. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetFromFamily | 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. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetIamPolicy | Gets the access control policy for a resource. May be empty if no such policy or resource exists. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Insert | Creates an image in the specified project using the data included in the request. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
List | 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. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
Patch | Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetIamPolicy | Sets the access control policy on the specified resource. Replaces any existing policy. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetLabels | Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
TestIamPermissions | Returns permissions that a caller has on the specified resource. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ImagesSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ImagesSettings imagesSettings =
ImagesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ImagesClient imagesClient = ImagesClient.create(imagesSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ImagesSettings imagesSettings = ImagesSettings.newBuilder().setEndpoint(myEndpoint).build();
ImagesClient imagesClient = ImagesClient.create(imagesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final ImagesClient create()
Constructs an instance of ImagesClient with default settings.
Returns | |
---|---|
Type | Description |
ImagesClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ImagesSettings settings)
public static final ImagesClient create(ImagesSettings settings)
Constructs an instance of ImagesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Parameter | |
---|---|
Name | Description |
settings | ImagesSettings |
Returns | |
---|---|
Type | Description |
ImagesClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(ImagesStub stub)
public static final ImagesClient create(ImagesStub stub)
Constructs an instance of ImagesClient, using the given stub for making calls. This is for advanced usage - prefer using create(ImagesSettings).
Parameter | |
---|---|
Name | Description |
stub | ImagesStub |
Returns | |
---|---|
Type | Description |
ImagesClient |
Constructors
ImagesClient(ImagesSettings settings)
protected ImagesClient(ImagesSettings settings)
Constructs an instance of ImagesClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
Parameter | |
---|---|
Name | Description |
settings | ImagesSettings |
ImagesClient(ImagesStub stub)
protected ImagesClient(ImagesStub stub)
Parameter | |
---|---|
Name | Description |
stub | ImagesStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration | long |
unit | TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
deleteAsync(DeleteImageRequest request)
public final OperationFuture<Operation,Operation> deleteAsync(DeleteImageRequest request)
Deletes the specified image.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
DeleteImageRequest request =
DeleteImageRequest.newBuilder()
.setImage("image100313435")
.setProject("project-309310695")
.setRequestId("requestId693933066")
.build();
Operation response = imagesClient.deleteAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DeleteImageRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
deleteAsync(String project, String image)
public final OperationFuture<Operation,Operation> deleteAsync(String project, String image)
Deletes the specified image.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
String project = "project-309310695";
String image = "image100313435";
Operation response = imagesClient.deleteAsync(project, image).get();
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
image | String Name of the image resource to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
deleteCallable()
public final UnaryCallable<DeleteImageRequest,Operation> deleteCallable()
Deletes the specified image.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
DeleteImageRequest request =
DeleteImageRequest.newBuilder()
.setImage("image100313435")
.setProject("project-309310695")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = imagesClient.deleteCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteImageRequest,Operation> |
deleteOperationCallable()
public final OperationCallable<DeleteImageRequest,Operation,Operation> deleteOperationCallable()
Deletes the specified image.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
DeleteImageRequest request =
DeleteImageRequest.newBuilder()
.setImage("image100313435")
.setProject("project-309310695")
.setRequestId("requestId693933066")
.build();
OperationFuture<Operation, Operation> future =
imagesClient.deleteOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteImageRequest,Operation,Operation> |
deprecateAsync(DeprecateImageRequest request)
public final OperationFuture<Operation,Operation> deprecateAsync(DeprecateImageRequest request)
Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
DeprecateImageRequest request =
DeprecateImageRequest.newBuilder()
.setDeprecationStatusResource(DeprecationStatus.newBuilder().build())
.setImage("image100313435")
.setProject("project-309310695")
.setRequestId("requestId693933066")
.build();
Operation response = imagesClient.deprecateAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DeprecateImageRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
deprecateAsync(String project, String image, DeprecationStatus deprecationStatusResource)
public final OperationFuture<Operation,Operation> deprecateAsync(String project, String image, DeprecationStatus deprecationStatusResource)
Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
String project = "project-309310695";
String image = "image100313435";
DeprecationStatus deprecationStatusResource = DeprecationStatus.newBuilder().build();
Operation response =
imagesClient.deprecateAsync(project, image, deprecationStatusResource).get();
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
image | String Image name. |
deprecationStatusResource | DeprecationStatus The body resource for this request |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
deprecateCallable()
public final UnaryCallable<DeprecateImageRequest,Operation> deprecateCallable()
Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
DeprecateImageRequest request =
DeprecateImageRequest.newBuilder()
.setDeprecationStatusResource(DeprecationStatus.newBuilder().build())
.setImage("image100313435")
.setProject("project-309310695")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = imagesClient.deprecateCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeprecateImageRequest,Operation> |
deprecateOperationCallable()
public final OperationCallable<DeprecateImageRequest,Operation,Operation> deprecateOperationCallable()
Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
DeprecateImageRequest request =
DeprecateImageRequest.newBuilder()
.setDeprecationStatusResource(DeprecationStatus.newBuilder().build())
.setImage("image100313435")
.setProject("project-309310695")
.setRequestId("requestId693933066")
.build();
OperationFuture<Operation, Operation> future =
imagesClient.deprecateOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeprecateImageRequest,Operation,Operation> |
get(GetImageRequest request)
public final Image get(GetImageRequest request)
Returns the specified image.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
GetImageRequest request =
GetImageRequest.newBuilder()
.setImage("image100313435")
.setProject("project-309310695")
.build();
Image response = imagesClient.get(request);
}
Parameter | |
---|---|
Name | Description |
request | GetImageRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Image |
get(String project, String image)
public final Image get(String project, String image)
Returns the specified image.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
String project = "project-309310695";
String image = "image100313435";
Image response = imagesClient.get(project, image);
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
image | String Name of the image resource to return. |
Returns | |
---|---|
Type | Description |
Image |
getCallable()
public final UnaryCallable<GetImageRequest,Image> getCallable()
Returns the specified image.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
GetImageRequest request =
GetImageRequest.newBuilder()
.setImage("image100313435")
.setProject("project-309310695")
.build();
ApiFuture<Image> future = imagesClient.getCallable().futureCall(request);
// Do something.
Image response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetImageRequest,Image> |
getFromFamily(GetFromFamilyImageRequest request)
public final Image getFromFamily(GetFromFamilyImageRequest request)
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
GetFromFamilyImageRequest request =
GetFromFamilyImageRequest.newBuilder()
.setFamily("family-1281860764")
.setProject("project-309310695")
.build();
Image response = imagesClient.getFromFamily(request);
}
Parameter | |
---|---|
Name | Description |
request | GetFromFamilyImageRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Image |
getFromFamily(String project, String family)
public final Image getFromFamily(String project, String family)
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
String project = "project-309310695";
String family = "family-1281860764";
Image response = imagesClient.getFromFamily(project, family);
}
Parameters | |
---|---|
Name | Description |
project | String The image project that the image belongs to. For example, to get a CentOS image, specify centos-cloud as the image project. |
family | String Name of the image family to search for. |
Returns | |
---|---|
Type | Description |
Image |
getFromFamilyCallable()
public final UnaryCallable<GetFromFamilyImageRequest,Image> getFromFamilyCallable()
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
GetFromFamilyImageRequest request =
GetFromFamilyImageRequest.newBuilder()
.setFamily("family-1281860764")
.setProject("project-309310695")
.build();
ApiFuture<Image> future = imagesClient.getFromFamilyCallable().futureCall(request);
// Do something.
Image response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetFromFamilyImageRequest,Image> |
getIamPolicy(GetIamPolicyImageRequest request)
public final Policy getIamPolicy(GetIamPolicyImageRequest request)
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
GetIamPolicyImageRequest request =
GetIamPolicyImageRequest.newBuilder()
.setOptionsRequestedPolicyVersion(-574521795)
.setProject("project-309310695")
.setResource("resource-341064690")
.build();
Policy response = imagesClient.getIamPolicy(request);
}
Parameter | |
---|---|
Name | Description |
request | GetIamPolicyImageRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Policy |
getIamPolicy(String project, String resource)
public final Policy getIamPolicy(String project, String resource)
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
String project = "project-309310695";
String resource = "resource-341064690";
Policy response = imagesClient.getIamPolicy(project, resource);
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
resource | String Name or id of the resource for this request. |
Returns | |
---|---|
Type | Description |
Policy |
getIamPolicyCallable()
public final UnaryCallable<GetIamPolicyImageRequest,Policy> getIamPolicyCallable()
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
GetIamPolicyImageRequest request =
GetIamPolicyImageRequest.newBuilder()
.setOptionsRequestedPolicyVersion(-574521795)
.setProject("project-309310695")
.setResource("resource-341064690")
.build();
ApiFuture<Policy> future = imagesClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetIamPolicyImageRequest,Policy> |
getSettings()
public final ImagesSettings getSettings()
Returns | |
---|---|
Type | Description |
ImagesSettings |
getStub()
public ImagesStub getStub()
Returns | |
---|---|
Type | Description |
ImagesStub |
insertAsync(InsertImageRequest request)
public final OperationFuture<Operation,Operation> insertAsync(InsertImageRequest request)
Creates an image in the specified project using the data included in the request.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
InsertImageRequest request =
InsertImageRequest.newBuilder()
.setForceCreate(true)
.setImageResource(Image.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.build();
Operation response = imagesClient.insertAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | InsertImageRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
insertAsync(String project, Image imageResource)
public final OperationFuture<Operation,Operation> insertAsync(String project, Image imageResource)
Creates an image in the specified project using the data included in the request.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
String project = "project-309310695";
Image imageResource = Image.newBuilder().build();
Operation response = imagesClient.insertAsync(project, imageResource).get();
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
imageResource | Image The body resource for this request |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
insertCallable()
public final UnaryCallable<InsertImageRequest,Operation> insertCallable()
Creates an image in the specified project using the data included in the request.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
InsertImageRequest request =
InsertImageRequest.newBuilder()
.setForceCreate(true)
.setImageResource(Image.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = imagesClient.insertCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<InsertImageRequest,Operation> |
insertOperationCallable()
public final OperationCallable<InsertImageRequest,Operation,Operation> insertOperationCallable()
Creates an image in the specified project using the data included in the request.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
InsertImageRequest request =
InsertImageRequest.newBuilder()
.setForceCreate(true)
.setImageResource(Image.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.build();
OperationFuture<Operation, Operation> future =
imagesClient.insertOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<InsertImageRequest,Operation,Operation> |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
list(ListImagesRequest request)
public final ImagesClient.ListPagedResponse list(ListImagesRequest request)
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
ListImagesRequest request =
ListImagesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
for (Image element : imagesClient.list(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListImagesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ImagesClient.ListPagedResponse |
list(String project)
public final ImagesClient.ListPagedResponse list(String project)
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
String project = "project-309310695";
for (Image element : imagesClient.list(project).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
project | String Project ID for this request. |
Returns | |
---|---|
Type | Description |
ImagesClient.ListPagedResponse |
listCallable()
public final UnaryCallable<ListImagesRequest,ImageList> listCallable()
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
ListImagesRequest request =
ListImagesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
while (true) {
ImageList response = imagesClient.listCallable().call(request);
for (Image element : response.getItemsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListImagesRequest,ImageList> |
listPagedCallable()
public final UnaryCallable<ListImagesRequest,ImagesClient.ListPagedResponse> listPagedCallable()
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
ListImagesRequest request =
ListImagesRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.build();
ApiFuture<Image> future = imagesClient.listPagedCallable().futureCall(request);
// Do something.
for (Image element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListImagesRequest,ListPagedResponse> |
patchAsync(PatchImageRequest request)
public final OperationFuture<Operation,Operation> patchAsync(PatchImageRequest request)
Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
PatchImageRequest request =
PatchImageRequest.newBuilder()
.setImage("image100313435")
.setImageResource(Image.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.build();
Operation response = imagesClient.patchAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | PatchImageRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
patchAsync(String project, String image, Image imageResource)
public final OperationFuture<Operation,Operation> patchAsync(String project, String image, Image imageResource)
Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
String project = "project-309310695";
String image = "image100313435";
Image imageResource = Image.newBuilder().build();
Operation response = imagesClient.patchAsync(project, image, imageResource).get();
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
image | String Name of the image resource to patch. |
imageResource | Image The body resource for this request |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
patchCallable()
public final UnaryCallable<PatchImageRequest,Operation> patchCallable()
Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
PatchImageRequest request =
PatchImageRequest.newBuilder()
.setImage("image100313435")
.setImageResource(Image.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future = imagesClient.patchCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<PatchImageRequest,Operation> |
patchOperationCallable()
public final OperationCallable<PatchImageRequest,Operation,Operation> patchOperationCallable()
Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
PatchImageRequest request =
PatchImageRequest.newBuilder()
.setImage("image100313435")
.setImageResource(Image.newBuilder().build())
.setProject("project-309310695")
.setRequestId("requestId693933066")
.build();
OperationFuture<Operation, Operation> future =
imagesClient.patchOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<PatchImageRequest,Operation,Operation> |
setIamPolicy(SetIamPolicyImageRequest request)
public final Policy setIamPolicy(SetIamPolicyImageRequest request)
Sets the access control policy on the specified resource. Replaces any existing policy.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
SetIamPolicyImageRequest request =
SetIamPolicyImageRequest.newBuilder()
.setGlobalSetPolicyRequestResource(GlobalSetPolicyRequest.newBuilder().build())
.setProject("project-309310695")
.setResource("resource-341064690")
.build();
Policy response = imagesClient.setIamPolicy(request);
}
Parameter | |
---|---|
Name | Description |
request | SetIamPolicyImageRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Policy |
setIamPolicy(String project, String resource, GlobalSetPolicyRequest globalSetPolicyRequestResource)
public final Policy setIamPolicy(String project, String resource, GlobalSetPolicyRequest globalSetPolicyRequestResource)
Sets the access control policy on the specified resource. Replaces any existing policy.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
String project = "project-309310695";
String resource = "resource-341064690";
GlobalSetPolicyRequest globalSetPolicyRequestResource =
GlobalSetPolicyRequest.newBuilder().build();
Policy response =
imagesClient.setIamPolicy(project, resource, globalSetPolicyRequestResource);
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
resource | String Name or id of the resource for this request. |
globalSetPolicyRequestResource | GlobalSetPolicyRequest The body resource for this request |
Returns | |
---|---|
Type | Description |
Policy |
setIamPolicyCallable()
public final UnaryCallable<SetIamPolicyImageRequest,Policy> setIamPolicyCallable()
Sets the access control policy on the specified resource. Replaces any existing policy.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
SetIamPolicyImageRequest request =
SetIamPolicyImageRequest.newBuilder()
.setGlobalSetPolicyRequestResource(GlobalSetPolicyRequest.newBuilder().build())
.setProject("project-309310695")
.setResource("resource-341064690")
.build();
ApiFuture<Policy> future = imagesClient.setIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<SetIamPolicyImageRequest,Policy> |
setLabelsAsync(SetLabelsImageRequest request)
public final OperationFuture<Operation,Operation> setLabelsAsync(SetLabelsImageRequest request)
Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
SetLabelsImageRequest request =
SetLabelsImageRequest.newBuilder()
.setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build())
.setProject("project-309310695")
.setResource("resource-341064690")
.build();
Operation response = imagesClient.setLabelsAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | SetLabelsImageRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
setLabelsAsync(String project, String resource, GlobalSetLabelsRequest globalSetLabelsRequestResource)
public final OperationFuture<Operation,Operation> setLabelsAsync(String project, String resource, GlobalSetLabelsRequest globalSetLabelsRequestResource)
Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
String project = "project-309310695";
String resource = "resource-341064690";
GlobalSetLabelsRequest globalSetLabelsRequestResource =
GlobalSetLabelsRequest.newBuilder().build();
Operation response =
imagesClient.setLabelsAsync(project, resource, globalSetLabelsRequestResource).get();
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
resource | String Name or id of the resource for this request. |
globalSetLabelsRequestResource | GlobalSetLabelsRequest The body resource for this request |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
setLabelsCallable()
public final UnaryCallable<SetLabelsImageRequest,Operation> setLabelsCallable()
Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
SetLabelsImageRequest request =
SetLabelsImageRequest.newBuilder()
.setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build())
.setProject("project-309310695")
.setResource("resource-341064690")
.build();
ApiFuture<Operation> future = imagesClient.setLabelsCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<SetLabelsImageRequest,Operation> |
setLabelsOperationCallable()
public final OperationCallable<SetLabelsImageRequest,Operation,Operation> setLabelsOperationCallable()
Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
SetLabelsImageRequest request =
SetLabelsImageRequest.newBuilder()
.setGlobalSetLabelsRequestResource(GlobalSetLabelsRequest.newBuilder().build())
.setProject("project-309310695")
.setResource("resource-341064690")
.build();
OperationFuture<Operation, Operation> future =
imagesClient.setLabelsOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<SetLabelsImageRequest,Operation,Operation> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
testIamPermissions(TestIamPermissionsImageRequest request)
public final TestPermissionsResponse testIamPermissions(TestIamPermissionsImageRequest request)
Returns permissions that a caller has on the specified resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
TestIamPermissionsImageRequest request =
TestIamPermissionsImageRequest.newBuilder()
.setProject("project-309310695")
.setResource("resource-341064690")
.setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
.build();
TestPermissionsResponse response = imagesClient.testIamPermissions(request);
}
Parameter | |
---|---|
Name | Description |
request | TestIamPermissionsImageRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
TestPermissionsResponse |
testIamPermissions(String project, String resource, TestPermissionsRequest testPermissionsRequestResource)
public final TestPermissionsResponse testIamPermissions(String project, String resource, TestPermissionsRequest testPermissionsRequestResource)
Returns permissions that a caller has on the specified resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
String project = "project-309310695";
String resource = "resource-341064690";
TestPermissionsRequest testPermissionsRequestResource =
TestPermissionsRequest.newBuilder().build();
TestPermissionsResponse response =
imagesClient.testIamPermissions(project, resource, testPermissionsRequestResource);
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
resource | String Name or id of the resource for this request. |
testPermissionsRequestResource | TestPermissionsRequest The body resource for this request |
Returns | |
---|---|
Type | Description |
TestPermissionsResponse |
testIamPermissionsCallable()
public final UnaryCallable<TestIamPermissionsImageRequest,TestPermissionsResponse> testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ImagesClient imagesClient = ImagesClient.create()) {
TestIamPermissionsImageRequest request =
TestIamPermissionsImageRequest.newBuilder()
.setProject("project-309310695")
.setResource("resource-341064690")
.setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
.build();
ApiFuture<TestPermissionsResponse> future =
imagesClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestPermissionsResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<TestIamPermissionsImageRequest,TestPermissionsResponse> |