target.apidocs.com.google.api.services.vmwareengine.v1.VMwareEngine.Projects.Locations.PrivateClouds.Clusters.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-vmwareengine Show documentation

There is a newer version: v1-rev20241009-2.0.0

Show newest version







VMwareEngine.Projects.Locations.PrivateClouds.Clusters (VMware Engine API v1-rev20240412-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.vmwareengine.v1
Class VMwareEngine.Projects.Locations.PrivateClouds.Clusters



java.lang.Object


com.google.api.services.vmwareengine.v1.VMwareEngine.Projects.Locations.PrivateClouds.Clusters







Enclosing class:
VMwareEngine.Projects.Locations.PrivateClouds




public class VMwareEngine.Projects.Locations.PrivateClouds.Clusters
extends Object
The "clusters" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Create 


class 
VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Delete 


class 
VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Get 


class 
VMwareEngine.Projects.Locations.PrivateClouds.Clusters.GetIamPolicy 


class 
VMwareEngine.Projects.Locations.PrivateClouds.Clusters.List 


class 
VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Nodes
The "nodes" collection of methods.



class 
VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Patch 


class 
VMwareEngine.Projects.Locations.PrivateClouds.Clusters.SetIamPolicy 


class 
VMwareEngine.Projects.Locations.PrivateClouds.Clusters.TestIamPermissions 









Constructor Summary

Constructors 

Constructor and Description


Clusters() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Create
create(String parent,
      Cluster content)
Creates a new cluster in a given private cloud.



VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Delete
delete(String name)
Deletes a `Cluster` resource.



VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Get
get(String name)
Retrieves a `Cluster` resource by its resource name.



VMwareEngine.Projects.Locations.PrivateClouds.Clusters.GetIamPolicy
getIamPolicy(String resource)
Gets the access control policy for a resource.



VMwareEngine.Projects.Locations.PrivateClouds.Clusters.List
list(String parent)
Lists `Cluster` resources in a given private cloud.



VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Nodes
nodes()
An accessor for creating requests from the Nodes collection.



VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Patch
patch(String name,
     Cluster content)
Modifies a `Cluster` resource.



VMwareEngine.Projects.Locations.PrivateClouds.Clusters.SetIamPolicy
setIamPolicy(String resource,
            SetIamPolicyRequest content)
Sets the access control policy on the specified resource.



VMwareEngine.Projects.Locations.PrivateClouds.Clusters.TestIamPermissions
testIamPermissions(String resource,
                  TestIamPermissionsRequest content)
Returns permissions that a caller has on the specified resource.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Clusters
public Clusters()









Method Detail





create
public VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Create create(String parent,
                                                                            Cluster content)
                                                                     throws IOException
Creates a new cluster in a given private cloud. Creating a new cluster provides additional nodes
 for use in the parent private cloud and requires sufficient [node quota](https://cloud.google.com
 /vmware-engine/quotas).

 Create a request for the method "clusters.create".

 This request holds the parameters needed by the vmwareengine server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The resource name of the private cloud to create a new cluster in. Resource names are
        schemeless URIs that follow the conventions in
        https://cloud.google.com/apis/design/resource_names. For example: `projects/my-
        project/locations/us-central1-a/privateClouds/my-cloud`
content - the Cluster
Returns:
the request
Throws:
IOException








delete
public VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Delete delete(String name)
                                                                     throws IOException
Deletes a `Cluster` resource. To avoid unintended data loss, migrate or gracefully shut down any
 workloads running on the cluster before deletion. You cannot delete the management cluster of a
 private cloud using this method.

 Create a request for the method "clusters.delete".

 This request holds the parameters needed by the vmwareengine server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The resource name of the cluster to delete. Resource names are schemeless URIs that follow
        the conventions in https://cloud.google.com/apis/design/resource_names. For example:
        `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`
Returns:
the request
Throws:
IOException








get
public VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Get get(String name)
                                                               throws IOException
Retrieves a `Cluster` resource by its resource name.

 Create a request for the method "clusters.get".

 This request holds the parameters needed by the vmwareengine server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The cluster resource name to retrieve. Resource names are schemeless URIs that follow the
        conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects
        /my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`
Returns:
the request
Throws:
IOException








getIamPolicy
public VMwareEngine.Projects.Locations.PrivateClouds.Clusters.GetIamPolicy getIamPolicy(String resource)
                                                                                 throws IOException
Gets the access control policy for a resource. Returns an empty policy if the resource exists and
 does not have a policy set.

 Create a request for the method "clusters.getIamPolicy".

 This request holds the parameters needed by the vmwareengine server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
resource - REQUIRED: The resource for which the policy is being requested. See [Resource
        names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
        this field.
Returns:
the request
Throws:
IOException








list
public VMwareEngine.Projects.Locations.PrivateClouds.Clusters.List list(String parent)
                                                                 throws IOException
Lists `Cluster` resources in a given private cloud.

 Create a request for the method "clusters.list".

 This request holds the parameters needed by the vmwareengine server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The resource name of the private cloud to query for clusters. Resource names are
        schemeless URIs that follow the conventions in
        https://cloud.google.com/apis/design/resource_names. For example: `projects/my-
        project/locations/us-central1-a/privateClouds/my-cloud`
Returns:
the request
Throws:
IOException








patch
public VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Patch patch(String name,
                                                                          Cluster content)
                                                                   throws IOException
Modifies a `Cluster` resource. Only fields specified in `updateMask` are applied. During
 operation processing, the resource is temporarily in the `ACTIVE` state before the operation
 fully completes. For that period of time, you can't update the resource. Use the operation status
 to determine when the processing fully completes.

 Create a request for the method "clusters.patch".

 This request holds the parameters needed by the vmwareengine server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the
        conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects
        /my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`
content - the Cluster
Returns:
the request
Throws:
IOException








setIamPolicy
public VMwareEngine.Projects.Locations.PrivateClouds.Clusters.SetIamPolicy setIamPolicy(String resource,
                                                                                        SetIamPolicyRequest content)
                                                                                 throws IOException
Sets the access control policy on the specified resource. Replaces any existing policy. Can
 return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

 Create a request for the method "clusters.setIamPolicy".

 This request holds the parameters needed by the vmwareengine server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
resource - REQUIRED: The resource for which the policy is being specified. See [Resource
        names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
        this field.
content - the SetIamPolicyRequest
Returns:
the request
Throws:
IOException








testIamPermissions
public VMwareEngine.Projects.Locations.PrivateClouds.Clusters.TestIamPermissions testIamPermissions(String resource,
                                                                                                    TestIamPermissionsRequest content)
                                                                                             throws IOException
Returns permissions that a caller has on the specified resource. If the resource does not exist,
 this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is
 designed to be used for building permission-aware UIs and command-line tools, not for
 authorization checking. This operation may "fail open" without warning.

 Create a request for the method "clusters.testIamPermissions".

 This request holds the parameters needed by the vmwareengine server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource
        names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
        this field.
content - the TestIamPermissionsRequest
Returns:
the request
Throws:
IOException








nodes
public VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Nodes nodes()
An accessor for creating requests from the Nodes collection.

 The typical use is:
     VMwareEngine vmwareengine = new VMwareEngine(...);
    VMwareEngine.Nodes.List request = vmwareengine.nodes().list(parameters ...)
 

Returns:
the resource collection














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Create`
`class`	`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Delete`
`class`	`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Get`
`class`	`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.GetIamPolicy`
`class`	`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.List`
`class`	`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Nodes` The "nodes" collection of methods.
`class`	`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Patch`
`class`	`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.SetIamPolicy`
`class`	`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.TestIamPermissions`

Modifier and Type	Method and Description
`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Create`	`create(String parent, Cluster content)` Creates a new cluster in a given private cloud.
`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Delete`	`delete(String name)` Deletes a `Cluster` resource.
`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Get`	`get(String name)` Retrieves a `Cluster` resource by its resource name.
`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.GetIamPolicy`	`getIamPolicy(String resource)` Gets the access control policy for a resource.
`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.List`	`list(String parent)` Lists `Cluster` resources in a given private cloud.
`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Nodes`	`nodes()` An accessor for creating requests from the Nodes collection.
`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.Patch`	`patch(String name, Cluster content)` Modifies a `Cluster` resource.
`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.SetIamPolicy`	`setIamPolicy(String resource, SetIamPolicyRequest content)` Sets the access control policy on the specified resource.
`VMwareEngine.Projects.Locations.PrivateClouds.Clusters.TestIamPermissions`	`testIamPermissions(String resource, TestIamPermissionsRequest content)` Returns permissions that a caller has on the specified resource.