Class AttachedClustersClient
- java.lang.Object
-
- com.google.cloud.gkemulticloud.v1.AttachedClustersClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class AttachedClustersClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: The AttachedClusters API provides a single centrally managed service to register and manage Anthos attached clusters that run on customer's owned infrastructure.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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { AttachedClusterName name = AttachedClusterName.of("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]"); AttachedCluster response = attachedClustersClient.getAttachedCluster(name); }
Note: close() needs to be called on the AttachedClustersClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns 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 AttachedClustersSettings 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 AttachedClustersSettings attachedClustersSettings = AttachedClustersSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); AttachedClustersClient attachedClustersClient = AttachedClustersClient.create(attachedClustersSettings);
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 AttachedClustersSettings attachedClustersSettings = AttachedClustersSettings.newBuilder().setEndpoint(myEndpoint).build(); AttachedClustersClient attachedClustersClient = AttachedClustersClient.create(attachedClustersSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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 AttachedClustersSettings attachedClustersSettings = AttachedClustersSettings.newHttpJsonBuilder().build(); AttachedClustersClient attachedClustersClient = AttachedClustersClient.create(attachedClustersSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AttachedClustersClient.ListAttachedClustersFixedSizeCollection
static class
AttachedClustersClient.ListAttachedClustersPage
static class
AttachedClustersClient.ListAttachedClustersPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
AttachedClustersClient(AttachedClustersSettings settings)
Constructs an instance of AttachedClustersClient, using the given settings.protected
AttachedClustersClient(AttachedClustersStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static AttachedClustersClient
create()
Constructs an instance of AttachedClustersClient with default settings.static AttachedClustersClient
create(AttachedClustersSettings settings)
Constructs an instance of AttachedClustersClient, using the given settings.static AttachedClustersClient
create(AttachedClustersStub stub)
Constructs an instance of AttachedClustersClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<AttachedCluster,OperationMetadata>
createAttachedClusterAsync(CreateAttachedClusterRequest request)
Creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource on a given Google Cloud Platform project and region.com.google.api.gax.longrunning.OperationFuture<AttachedCluster,OperationMetadata>
createAttachedClusterAsync(LocationName parent, AttachedCluster attachedCluster, String attachedClusterId)
Creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource on a given Google Cloud Platform project and region.com.google.api.gax.longrunning.OperationFuture<AttachedCluster,OperationMetadata>
createAttachedClusterAsync(String parent, AttachedCluster attachedCluster, String attachedClusterId)
Creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource on a given Google Cloud Platform project and region.com.google.api.gax.rpc.UnaryCallable<CreateAttachedClusterRequest,com.google.longrunning.Operation>
createAttachedClusterCallable()
Creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource on a given Google Cloud Platform project and region.com.google.api.gax.rpc.OperationCallable<CreateAttachedClusterRequest,AttachedCluster,OperationMetadata>
createAttachedClusterOperationCallable()
Creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource on a given Google Cloud Platform project and region.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteAttachedClusterAsync(AttachedClusterName name)
Deletes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteAttachedClusterAsync(DeleteAttachedClusterRequest request)
Deletes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteAttachedClusterAsync(String name)
Deletes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.com.google.api.gax.rpc.UnaryCallable<DeleteAttachedClusterRequest,com.google.longrunning.Operation>
deleteAttachedClusterCallable()
Deletes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.com.google.api.gax.rpc.OperationCallable<DeleteAttachedClusterRequest,com.google.protobuf.Empty,OperationMetadata>
deleteAttachedClusterOperationCallable()
Deletes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.GenerateAttachedClusterInstallManifestResponse
generateAttachedClusterInstallManifest(GenerateAttachedClusterInstallManifestRequest request)
Generates the install manifest to be installed on the target cluster.GenerateAttachedClusterInstallManifestResponse
generateAttachedClusterInstallManifest(LocationName parent, String attachedClusterId)
Generates the install manifest to be installed on the target cluster.GenerateAttachedClusterInstallManifestResponse
generateAttachedClusterInstallManifest(String parent, String attachedClusterId)
Generates the install manifest to be installed on the target cluster.com.google.api.gax.rpc.UnaryCallable<GenerateAttachedClusterInstallManifestRequest,GenerateAttachedClusterInstallManifestResponse>
generateAttachedClusterInstallManifestCallable()
Generates the install manifest to be installed on the target cluster.AttachedCluster
getAttachedCluster(AttachedClusterName name)
Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.AttachedCluster
getAttachedCluster(GetAttachedClusterRequest request)
Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.AttachedCluster
getAttachedCluster(String name)
Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.com.google.api.gax.rpc.UnaryCallable<GetAttachedClusterRequest,AttachedCluster>
getAttachedClusterCallable()
Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.AttachedServerConfig
getAttachedServerConfig(AttachedServerConfigName name)
Returns information, such as supported Kubernetes versions, on a given Google Cloud location.AttachedServerConfig
getAttachedServerConfig(GetAttachedServerConfigRequest request)
Returns information, such as supported Kubernetes versions, on a given Google Cloud location.AttachedServerConfig
getAttachedServerConfig(String name)
Returns information, such as supported Kubernetes versions, on a given Google Cloud location.com.google.api.gax.rpc.UnaryCallable<GetAttachedServerConfigRequest,AttachedServerConfig>
getAttachedServerConfigCallable()
Returns information, such as supported Kubernetes versions, on a given Google Cloud location.com.google.api.gax.httpjson.longrunning.OperationsClient
getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.com.google.longrunning.OperationsClient
getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.AttachedClustersSettings
getSettings()
AttachedClustersStub
getStub()
com.google.api.gax.longrunning.OperationFuture<AttachedCluster,OperationMetadata>
importAttachedClusterAsync(ImportAttachedClusterRequest request)
Imports creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource by importing an existing Fleet Membership resource.com.google.api.gax.longrunning.OperationFuture<AttachedCluster,OperationMetadata>
importAttachedClusterAsync(LocationName parent, String fleetMembership)
Imports creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource by importing an existing Fleet Membership resource.com.google.api.gax.longrunning.OperationFuture<AttachedCluster,OperationMetadata>
importAttachedClusterAsync(String parent, String fleetMembership)
Imports creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource by importing an existing Fleet Membership resource.com.google.api.gax.rpc.UnaryCallable<ImportAttachedClusterRequest,com.google.longrunning.Operation>
importAttachedClusterCallable()
Imports creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource by importing an existing Fleet Membership resource.com.google.api.gax.rpc.OperationCallable<ImportAttachedClusterRequest,AttachedCluster,OperationMetadata>
importAttachedClusterOperationCallable()
Imports creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource by importing an existing Fleet Membership resource.boolean
isShutdown()
boolean
isTerminated()
AttachedClustersClient.ListAttachedClustersPagedResponse
listAttachedClusters(ListAttachedClustersRequest request)
Lists all [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources on a given Google Cloud project and region.AttachedClustersClient.ListAttachedClustersPagedResponse
listAttachedClusters(LocationName parent)
Lists all [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources on a given Google Cloud project and region.AttachedClustersClient.ListAttachedClustersPagedResponse
listAttachedClusters(String parent)
Lists all [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources on a given Google Cloud project and region.com.google.api.gax.rpc.UnaryCallable<ListAttachedClustersRequest,ListAttachedClustersResponse>
listAttachedClustersCallable()
Lists all [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources on a given Google Cloud project and region.com.google.api.gax.rpc.UnaryCallable<ListAttachedClustersRequest,AttachedClustersClient.ListAttachedClustersPagedResponse>
listAttachedClustersPagedCallable()
Lists all [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources on a given Google Cloud project and region.void
shutdown()
void
shutdownNow()
com.google.api.gax.longrunning.OperationFuture<AttachedCluster,OperationMetadata>
updateAttachedClusterAsync(AttachedCluster attachedCluster, com.google.protobuf.FieldMask updateMask)
Updates an [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster].com.google.api.gax.longrunning.OperationFuture<AttachedCluster,OperationMetadata>
updateAttachedClusterAsync(UpdateAttachedClusterRequest request)
Updates an [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster].com.google.api.gax.rpc.UnaryCallable<UpdateAttachedClusterRequest,com.google.longrunning.Operation>
updateAttachedClusterCallable()
Updates an [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster].com.google.api.gax.rpc.OperationCallable<UpdateAttachedClusterRequest,AttachedCluster,OperationMetadata>
updateAttachedClusterOperationCallable()
Updates an [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster].
-
-
-
Constructor Detail
-
AttachedClustersClient
protected AttachedClustersClient(AttachedClustersSettings settings) throws IOException
Constructs an instance of AttachedClustersClient, 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.- Throws:
IOException
-
AttachedClustersClient
protected AttachedClustersClient(AttachedClustersStub stub)
-
-
Method Detail
-
create
public static final AttachedClustersClient create() throws IOException
Constructs an instance of AttachedClustersClient with default settings.- Throws:
IOException
-
create
public static final AttachedClustersClient create(AttachedClustersSettings settings) throws IOException
Constructs an instance of AttachedClustersClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.- Throws:
IOException
-
create
public static final AttachedClustersClient create(AttachedClustersStub stub)
Constructs an instance of AttachedClustersClient, using the given stub for making calls. This is for advanced usage - prefer using create(AttachedClustersSettings).
-
getSettings
public final AttachedClustersSettings getSettings()
-
getStub
public AttachedClustersStub getStub()
-
getOperationsClient
public final com.google.longrunning.OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
getHttpJsonOperationsClient
@BetaApi public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
createAttachedClusterAsync
public final com.google.api.gax.longrunning.OperationFuture<AttachedCluster,OperationMetadata> createAttachedClusterAsync(LocationName parent, AttachedCluster attachedCluster, String attachedClusterId)
Creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource on a given Google Cloud Platform project and region.If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); AttachedCluster attachedCluster = AttachedCluster.newBuilder().build(); String attachedClusterId = "attachedClusterId865943409"; AttachedCluster response = attachedClustersClient .createAttachedClusterAsync(parent, attachedCluster, attachedClusterId) .get(); }
- Parameters:
parent
- Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.Location names are formatted as `projects/<project-id>/locations/<region>`.
See [Resource Names](https://cloud.google.com/apis/design/resource_names) for more details on Google Cloud resource names.
attachedCluster
- Required. The specification of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to create.attachedClusterId
- Required. A client provided ID the resource. Must be unique within the parent resource.The provided ID will be part of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource name formatted as `projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>`.
Valid characters are `/[a-z][0-9]-/`. Cannot be longer than 63 characters.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createAttachedClusterAsync
public final com.google.api.gax.longrunning.OperationFuture<AttachedCluster,OperationMetadata> createAttachedClusterAsync(String parent, AttachedCluster attachedCluster, String attachedClusterId)
Creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource on a given Google Cloud Platform project and region.If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); AttachedCluster attachedCluster = AttachedCluster.newBuilder().build(); String attachedClusterId = "attachedClusterId865943409"; AttachedCluster response = attachedClustersClient .createAttachedClusterAsync(parent, attachedCluster, attachedClusterId) .get(); }
- Parameters:
parent
- Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.Location names are formatted as `projects/<project-id>/locations/<region>`.
See [Resource Names](https://cloud.google.com/apis/design/resource_names) for more details on Google Cloud resource names.
attachedCluster
- Required. The specification of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to create.attachedClusterId
- Required. A client provided ID the resource. Must be unique within the parent resource.The provided ID will be part of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource name formatted as `projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>`.
Valid characters are `/[a-z][0-9]-/`. Cannot be longer than 63 characters.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createAttachedClusterAsync
public final com.google.api.gax.longrunning.OperationFuture<AttachedCluster,OperationMetadata> createAttachedClusterAsync(CreateAttachedClusterRequest request)
Creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource on a given Google Cloud Platform project and region.If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { CreateAttachedClusterRequest request = CreateAttachedClusterRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setAttachedCluster(AttachedCluster.newBuilder().build()) .setAttachedClusterId("attachedClusterId865943409") .setValidateOnly(true) .build(); AttachedCluster response = attachedClustersClient.createAttachedClusterAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createAttachedClusterOperationCallable
public final com.google.api.gax.rpc.OperationCallable<CreateAttachedClusterRequest,AttachedCluster,OperationMetadata> createAttachedClusterOperationCallable()
Creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource on a given Google Cloud Platform project and region.If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { CreateAttachedClusterRequest request = CreateAttachedClusterRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setAttachedCluster(AttachedCluster.newBuilder().build()) .setAttachedClusterId("attachedClusterId865943409") .setValidateOnly(true) .build(); OperationFuture<AttachedCluster, OperationMetadata> future = attachedClustersClient.createAttachedClusterOperationCallable().futureCall(request); // Do something. AttachedCluster response = future.get(); }
-
createAttachedClusterCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateAttachedClusterRequest,com.google.longrunning.Operation> createAttachedClusterCallable()
Creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource on a given Google Cloud Platform project and region.If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { CreateAttachedClusterRequest request = CreateAttachedClusterRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setAttachedCluster(AttachedCluster.newBuilder().build()) .setAttachedClusterId("attachedClusterId865943409") .setValidateOnly(true) .build(); ApiFuture<Operation> future = attachedClustersClient.createAttachedClusterCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
updateAttachedClusterAsync
public final com.google.api.gax.longrunning.OperationFuture<AttachedCluster,OperationMetadata> updateAttachedClusterAsync(AttachedCluster attachedCluster, com.google.protobuf.FieldMask updateMask)
Updates an [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster].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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { AttachedCluster attachedCluster = AttachedCluster.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); AttachedCluster response = attachedClustersClient.updateAttachedClusterAsync(attachedCluster, updateMask).get(); }
- Parameters:
attachedCluster
- Required. The [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource to update.updateMask
- Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field can only include these fields from [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster]:* `description`. * `annotations`. * `platform_version`. * `authorization.admin_users`. * `logging_config.component_config.enable_components`. * `monitoring_config.managed_prometheus_config.enabled`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateAttachedClusterAsync
public final com.google.api.gax.longrunning.OperationFuture<AttachedCluster,OperationMetadata> updateAttachedClusterAsync(UpdateAttachedClusterRequest request)
Updates an [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster].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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { UpdateAttachedClusterRequest request = UpdateAttachedClusterRequest.newBuilder() .setAttachedCluster(AttachedCluster.newBuilder().build()) .setValidateOnly(true) .setUpdateMask(FieldMask.newBuilder().build()) .build(); AttachedCluster response = attachedClustersClient.updateAttachedClusterAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateAttachedClusterOperationCallable
public final com.google.api.gax.rpc.OperationCallable<UpdateAttachedClusterRequest,AttachedCluster,OperationMetadata> updateAttachedClusterOperationCallable()
Updates an [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster].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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { UpdateAttachedClusterRequest request = UpdateAttachedClusterRequest.newBuilder() .setAttachedCluster(AttachedCluster.newBuilder().build()) .setValidateOnly(true) .setUpdateMask(FieldMask.newBuilder().build()) .build(); OperationFuture<AttachedCluster, OperationMetadata> future = attachedClustersClient.updateAttachedClusterOperationCallable().futureCall(request); // Do something. AttachedCluster response = future.get(); }
-
updateAttachedClusterCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateAttachedClusterRequest,com.google.longrunning.Operation> updateAttachedClusterCallable()
Updates an [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster].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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { UpdateAttachedClusterRequest request = UpdateAttachedClusterRequest.newBuilder() .setAttachedCluster(AttachedCluster.newBuilder().build()) .setValidateOnly(true) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<Operation> future = attachedClustersClient.updateAttachedClusterCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
importAttachedClusterAsync
public final com.google.api.gax.longrunning.OperationFuture<AttachedCluster,OperationMetadata> importAttachedClusterAsync(LocationName parent, String fleetMembership)
Imports creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource by importing an existing Fleet Membership resource.Attached Clusters created before the introduction of the Anthos Multi-Cloud API can be imported through this method.
If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); String fleetMembership = "fleetMembership-665479228"; AttachedCluster response = attachedClustersClient.importAttachedClusterAsync(parent, fleetMembership).get(); }
- Parameters:
parent
- Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.Location names are formatted as `projects/<project-id>/locations/<region>`.
See [Resource Names](https://cloud.google.com/apis/design/resource_names) for more details on Google Cloud resource names.
fleetMembership
- Required. The name of the fleet membership resource to import.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
importAttachedClusterAsync
public final com.google.api.gax.longrunning.OperationFuture<AttachedCluster,OperationMetadata> importAttachedClusterAsync(String parent, String fleetMembership)
Imports creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource by importing an existing Fleet Membership resource.Attached Clusters created before the introduction of the Anthos Multi-Cloud API can be imported through this method.
If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); String fleetMembership = "fleetMembership-665479228"; AttachedCluster response = attachedClustersClient.importAttachedClusterAsync(parent, fleetMembership).get(); }
- Parameters:
parent
- Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.Location names are formatted as `projects/<project-id>/locations/<region>`.
See [Resource Names](https://cloud.google.com/apis/design/resource_names) for more details on Google Cloud resource names.
fleetMembership
- Required. The name of the fleet membership resource to import.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
importAttachedClusterAsync
public final com.google.api.gax.longrunning.OperationFuture<AttachedCluster,OperationMetadata> importAttachedClusterAsync(ImportAttachedClusterRequest request)
Imports creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource by importing an existing Fleet Membership resource.Attached Clusters created before the introduction of the Anthos Multi-Cloud API can be imported through this method.
If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { ImportAttachedClusterRequest request = ImportAttachedClusterRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setValidateOnly(true) .setFleetMembership("fleetMembership-665479228") .setPlatformVersion("platformVersion1848800485") .setDistribution("distribution-1580708220") .build(); AttachedCluster response = attachedClustersClient.importAttachedClusterAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
importAttachedClusterOperationCallable
public final com.google.api.gax.rpc.OperationCallable<ImportAttachedClusterRequest,AttachedCluster,OperationMetadata> importAttachedClusterOperationCallable()
Imports creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource by importing an existing Fleet Membership resource.Attached Clusters created before the introduction of the Anthos Multi-Cloud API can be imported through this method.
If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { ImportAttachedClusterRequest request = ImportAttachedClusterRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setValidateOnly(true) .setFleetMembership("fleetMembership-665479228") .setPlatformVersion("platformVersion1848800485") .setDistribution("distribution-1580708220") .build(); OperationFuture<AttachedCluster, OperationMetadata> future = attachedClustersClient.importAttachedClusterOperationCallable().futureCall(request); // Do something. AttachedCluster response = future.get(); }
-
importAttachedClusterCallable
public final com.google.api.gax.rpc.UnaryCallable<ImportAttachedClusterRequest,com.google.longrunning.Operation> importAttachedClusterCallable()
Imports creates a new [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource by importing an existing Fleet Membership resource.Attached Clusters created before the introduction of the Anthos Multi-Cloud API can be imported through this method.
If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { ImportAttachedClusterRequest request = ImportAttachedClusterRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setValidateOnly(true) .setFleetMembership("fleetMembership-665479228") .setPlatformVersion("platformVersion1848800485") .setDistribution("distribution-1580708220") .build(); ApiFuture<Operation> future = attachedClustersClient.importAttachedClusterCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
getAttachedCluster
public final AttachedCluster getAttachedCluster(AttachedClusterName name)
Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] 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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { AttachedClusterName name = AttachedClusterName.of("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]"); AttachedCluster response = attachedClustersClient.getAttachedCluster(name); }
- Parameters:
name
- Required. The name of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource to describe.`AttachedCluster` names are formatted as `projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>`.
See [Resource Names](https://cloud.google.com/apis/design/resource_names) for more details on Google Cloud Platform resource names.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getAttachedCluster
public final AttachedCluster getAttachedCluster(String name)
Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] 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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { String name = AttachedClusterName.of("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]").toString(); AttachedCluster response = attachedClustersClient.getAttachedCluster(name); }
- Parameters:
name
- Required. The name of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource to describe.`AttachedCluster` names are formatted as `projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>`.
See [Resource Names](https://cloud.google.com/apis/design/resource_names) for more details on Google Cloud Platform resource names.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getAttachedCluster
public final AttachedCluster getAttachedCluster(GetAttachedClusterRequest request)
Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] 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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { GetAttachedClusterRequest request = GetAttachedClusterRequest.newBuilder() .setName( AttachedClusterName.of("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]") .toString()) .build(); AttachedCluster response = attachedClustersClient.getAttachedCluster(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getAttachedClusterCallable
public final com.google.api.gax.rpc.UnaryCallable<GetAttachedClusterRequest,AttachedCluster> getAttachedClusterCallable()
Describes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] 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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { GetAttachedClusterRequest request = GetAttachedClusterRequest.newBuilder() .setName( AttachedClusterName.of("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]") .toString()) .build(); ApiFuture<AttachedCluster> future = attachedClustersClient.getAttachedClusterCallable().futureCall(request); // Do something. AttachedCluster response = future.get(); }
-
listAttachedClusters
public final AttachedClustersClient.ListAttachedClustersPagedResponse listAttachedClusters(LocationName parent)
Lists all [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources on a given Google Cloud project and region.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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); for (AttachedCluster element : attachedClustersClient.listAttachedClusters(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The parent location which owns this collection of [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources.Location names are formatted as `projects/<project-id>/locations/<region>`.
See [Resource Names](https://cloud.google.com/apis/design/resource_names) for more details on Google Cloud Platform resource names.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listAttachedClusters
public final AttachedClustersClient.ListAttachedClustersPagedResponse listAttachedClusters(String parent)
Lists all [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources on a given Google Cloud project and region.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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); for (AttachedCluster element : attachedClustersClient.listAttachedClusters(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The parent location which owns this collection of [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources.Location names are formatted as `projects/<project-id>/locations/<region>`.
See [Resource Names](https://cloud.google.com/apis/design/resource_names) for more details on Google Cloud Platform resource names.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listAttachedClusters
public final AttachedClustersClient.ListAttachedClustersPagedResponse listAttachedClusters(ListAttachedClustersRequest request)
Lists all [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources on a given Google Cloud project and region.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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { ListAttachedClustersRequest request = ListAttachedClustersRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (AttachedCluster element : attachedClustersClient.listAttachedClusters(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listAttachedClustersPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListAttachedClustersRequest,AttachedClustersClient.ListAttachedClustersPagedResponse> listAttachedClustersPagedCallable()
Lists all [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources on a given Google Cloud project and region.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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { ListAttachedClustersRequest request = ListAttachedClustersRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<AttachedCluster> future = attachedClustersClient.listAttachedClustersPagedCallable().futureCall(request); // Do something. for (AttachedCluster element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listAttachedClustersCallable
public final com.google.api.gax.rpc.UnaryCallable<ListAttachedClustersRequest,ListAttachedClustersResponse> listAttachedClustersCallable()
Lists all [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resources on a given Google Cloud project and region.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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { ListAttachedClustersRequest request = ListAttachedClustersRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListAttachedClustersResponse response = attachedClustersClient.listAttachedClustersCallable().call(request); for (AttachedCluster element : response.getAttachedClustersList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
deleteAttachedClusterAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteAttachedClusterAsync(AttachedClusterName name)
Deletes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { AttachedClusterName name = AttachedClusterName.of("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]"); attachedClustersClient.deleteAttachedClusterAsync(name).get(); }
- Parameters:
name
- Required. The resource name the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to delete.`AttachedCluster` names are formatted as `projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>`.
See [Resource Names](https://cloud.google.com/apis/design/resource_names) for more details on Google Cloud Platform resource names.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteAttachedClusterAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteAttachedClusterAsync(String name)
Deletes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { String name = AttachedClusterName.of("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]").toString(); attachedClustersClient.deleteAttachedClusterAsync(name).get(); }
- Parameters:
name
- Required. The resource name the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] to delete.`AttachedCluster` names are formatted as `projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>`.
See [Resource Names](https://cloud.google.com/apis/design/resource_names) for more details on Google Cloud Platform resource names.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteAttachedClusterAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteAttachedClusterAsync(DeleteAttachedClusterRequest request)
Deletes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { DeleteAttachedClusterRequest request = DeleteAttachedClusterRequest.newBuilder() .setName( AttachedClusterName.of("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]") .toString()) .setValidateOnly(true) .setAllowMissing(true) .setIgnoreErrors(true) .setEtag("etag3123477") .build(); attachedClustersClient.deleteAttachedClusterAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteAttachedClusterOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteAttachedClusterRequest,com.google.protobuf.Empty,OperationMetadata> deleteAttachedClusterOperationCallable()
Deletes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { DeleteAttachedClusterRequest request = DeleteAttachedClusterRequest.newBuilder() .setName( AttachedClusterName.of("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]") .toString()) .setValidateOnly(true) .setAllowMissing(true) .setIgnoreErrors(true) .setEtag("etag3123477") .build(); OperationFuture<Empty, OperationMetadata> future = attachedClustersClient.deleteAttachedClusterOperationCallable().futureCall(request); // Do something. future.get(); }
-
deleteAttachedClusterCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteAttachedClusterRequest,com.google.longrunning.Operation> deleteAttachedClusterCallable()
Deletes a specific [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource.If successful, the response contains a newly created [Operation][google.longrunning.Operation] resource that can be described to track the status of the operation.
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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { DeleteAttachedClusterRequest request = DeleteAttachedClusterRequest.newBuilder() .setName( AttachedClusterName.of("[PROJECT]", "[LOCATION]", "[ATTACHED_CLUSTER]") .toString()) .setValidateOnly(true) .setAllowMissing(true) .setIgnoreErrors(true) .setEtag("etag3123477") .build(); ApiFuture<Operation> future = attachedClustersClient.deleteAttachedClusterCallable().futureCall(request); // Do something. future.get(); }
-
getAttachedServerConfig
public final AttachedServerConfig getAttachedServerConfig(AttachedServerConfigName name)
Returns information, such as supported Kubernetes versions, on a given Google Cloud location.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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { AttachedServerConfigName name = AttachedServerConfigName.of("[PROJECT]", "[LOCATION]"); AttachedServerConfig response = attachedClustersClient.getAttachedServerConfig(name); }
- Parameters:
name
- Required. The name of the [AttachedServerConfig][google.cloud.gkemulticloud.v1.AttachedServerConfig] resource to describe.`AttachedServerConfig` names are formatted as `projects/<project-id>/locations/<region>/attachedServerConfig`.
See [Resource Names](https://cloud.google.com/apis/design/resource_names) for more details on Google Cloud resource names.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getAttachedServerConfig
public final AttachedServerConfig getAttachedServerConfig(String name)
Returns information, such as supported Kubernetes versions, on a given Google Cloud location.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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { String name = AttachedServerConfigName.of("[PROJECT]", "[LOCATION]").toString(); AttachedServerConfig response = attachedClustersClient.getAttachedServerConfig(name); }
- Parameters:
name
- Required. The name of the [AttachedServerConfig][google.cloud.gkemulticloud.v1.AttachedServerConfig] resource to describe.`AttachedServerConfig` names are formatted as `projects/<project-id>/locations/<region>/attachedServerConfig`.
See [Resource Names](https://cloud.google.com/apis/design/resource_names) for more details on Google Cloud resource names.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getAttachedServerConfig
public final AttachedServerConfig getAttachedServerConfig(GetAttachedServerConfigRequest request)
Returns information, such as supported Kubernetes versions, on a given Google Cloud location.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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { GetAttachedServerConfigRequest request = GetAttachedServerConfigRequest.newBuilder() .setName(AttachedServerConfigName.of("[PROJECT]", "[LOCATION]").toString()) .build(); AttachedServerConfig response = attachedClustersClient.getAttachedServerConfig(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getAttachedServerConfigCallable
public final com.google.api.gax.rpc.UnaryCallable<GetAttachedServerConfigRequest,AttachedServerConfig> getAttachedServerConfigCallable()
Returns information, such as supported Kubernetes versions, on a given Google Cloud location.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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { GetAttachedServerConfigRequest request = GetAttachedServerConfigRequest.newBuilder() .setName(AttachedServerConfigName.of("[PROJECT]", "[LOCATION]").toString()) .build(); ApiFuture<AttachedServerConfig> future = attachedClustersClient.getAttachedServerConfigCallable().futureCall(request); // Do something. AttachedServerConfig response = future.get(); }
-
generateAttachedClusterInstallManifest
public final GenerateAttachedClusterInstallManifestResponse generateAttachedClusterInstallManifest(LocationName parent, String attachedClusterId)
Generates the install manifest to be installed on the target cluster.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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); String attachedClusterId = "attachedClusterId865943409"; GenerateAttachedClusterInstallManifestResponse response = attachedClustersClient.generateAttachedClusterInstallManifest(parent, attachedClusterId); }
- Parameters:
parent
- Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.Location names are formatted as `projects/<project-id>/locations/<region>`.
See [Resource Names](https://cloud.google.com/apis/design/resource_names) for more details on Google Cloud resource names.
attachedClusterId
- Required. A client provided ID of the resource. Must be unique within the parent resource.The provided ID will be part of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource name formatted as `projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>`.
Valid characters are `/[a-z][0-9]-/`. Cannot be longer than 63 characters.
When generating an install manifest for importing an existing Membership resource, the attached_cluster_id field must be the Membership id.
Membership names are formatted as `projects/<project-id>/locations/<region>/memberships/<membership-id>`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
generateAttachedClusterInstallManifest
public final GenerateAttachedClusterInstallManifestResponse generateAttachedClusterInstallManifest(String parent, String attachedClusterId)
Generates the install manifest to be installed on the target cluster.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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); String attachedClusterId = "attachedClusterId865943409"; GenerateAttachedClusterInstallManifestResponse response = attachedClustersClient.generateAttachedClusterInstallManifest(parent, attachedClusterId); }
- Parameters:
parent
- Required. The parent location where this [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource will be created.Location names are formatted as `projects/<project-id>/locations/<region>`.
See [Resource Names](https://cloud.google.com/apis/design/resource_names) for more details on Google Cloud resource names.
attachedClusterId
- Required. A client provided ID of the resource. Must be unique within the parent resource.The provided ID will be part of the [AttachedCluster][google.cloud.gkemulticloud.v1.AttachedCluster] resource name formatted as `projects/<project-id>/locations/<region>/attachedClusters/<cluster-id>`.
Valid characters are `/[a-z][0-9]-/`. Cannot be longer than 63 characters.
When generating an install manifest for importing an existing Membership resource, the attached_cluster_id field must be the Membership id.
Membership names are formatted as `projects/<project-id>/locations/<region>/memberships/<membership-id>`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
generateAttachedClusterInstallManifest
public final GenerateAttachedClusterInstallManifestResponse generateAttachedClusterInstallManifest(GenerateAttachedClusterInstallManifestRequest request)
Generates the install manifest to be installed on the target cluster.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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { GenerateAttachedClusterInstallManifestRequest request = GenerateAttachedClusterInstallManifestRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setAttachedClusterId("attachedClusterId865943409") .setPlatformVersion("platformVersion1848800485") .build(); GenerateAttachedClusterInstallManifestResponse response = attachedClustersClient.generateAttachedClusterInstallManifest(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
generateAttachedClusterInstallManifestCallable
public final com.google.api.gax.rpc.UnaryCallable<GenerateAttachedClusterInstallManifestRequest,GenerateAttachedClusterInstallManifestResponse> generateAttachedClusterInstallManifestCallable()
Generates the install manifest to be installed on the target cluster.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 (AttachedClustersClient attachedClustersClient = AttachedClustersClient.create()) { GenerateAttachedClusterInstallManifestRequest request = GenerateAttachedClusterInstallManifestRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setAttachedClusterId("attachedClusterId865943409") .setPlatformVersion("platformVersion1848800485") .build(); ApiFuture<GenerateAttachedClusterInstallManifestResponse> future = attachedClustersClient .generateAttachedClusterInstallManifestCallable() .futureCall(request); // Do something. GenerateAttachedClusterInstallManifestResponse response = future.get(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-