com.google.api.services.cloudkms.v1

Class CloudKMS.Projects.Locations

java.lang.Object

com.google.api.services.cloudkms.v1.CloudKMS.Projects.Locations

Enclosing class:

CloudKMS.Projects

public class CloudKMS.Projects.Locations
extends Object

The "locations" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudKMS.Projects.Locations.EkmConfig The "ekmConfig" collection of methods.
class	CloudKMS.Projects.Locations.EkmConnections The "ekmConnections" collection of methods.
class	CloudKMS.Projects.Locations.GenerateRandomBytes
class	CloudKMS.Projects.Locations.Get
class	CloudKMS.Projects.Locations.GetEkmConfig
class	CloudKMS.Projects.Locations.KeyHandles The "keyHandles" collection of methods.
class	CloudKMS.Projects.Locations.KeyRings The "keyRings" collection of methods.
class	CloudKMS.Projects.Locations.List
class	CloudKMS.Projects.Locations.Operations The "operations" collection of methods.
class	CloudKMS.Projects.Locations.RetiredResources The "retiredResources" collection of methods.
class	CloudKMS.Projects.Locations.SingleTenantHsmInstances The "singleTenantHsmInstances" collection of methods.
class	CloudKMS.Projects.Locations.UpdateEkmConfig

Constructor Summary

Constructors

Constructor and Description
Locations()

Method Summary

Modifier and Type	Method and Description
CloudKMS.Projects.Locations.EkmConfig	ekmConfig() An accessor for creating requests from the EkmConfig collection.
CloudKMS.Projects.Locations.EkmConnections	ekmConnections() An accessor for creating requests from the EkmConnections collection.
CloudKMS.Projects.Locations.GenerateRandomBytes	generateRandomBytes(String location, GenerateRandomBytesRequest content) Generate random bytes using the Cloud KMS randomness source in the provided location.
CloudKMS.Projects.Locations.Get	get(String name) Gets information about a location.
CloudKMS.Projects.Locations.GetEkmConfig	getEkmConfig(String name) Returns the EkmConfig singleton resource for a given project and location.
CloudKMS.Projects.Locations.KeyHandles	keyHandles() An accessor for creating requests from the KeyHandles collection.
CloudKMS.Projects.Locations.KeyRings	keyRings() An accessor for creating requests from the KeyRings collection.
CloudKMS.Projects.Locations.List	list(String name) Lists information about the supported locations for this service.
CloudKMS.Projects.Locations.Operations	operations() An accessor for creating requests from the Operations collection.
CloudKMS.Projects.Locations.RetiredResources	retiredResources() An accessor for creating requests from the RetiredResources collection.
CloudKMS.Projects.Locations.SingleTenantHsmInstances	singleTenantHsmInstances() An accessor for creating requests from the SingleTenantHsmInstances collection.
CloudKMS.Projects.Locations.UpdateEkmConfig	updateEkmConfig(String name, EkmConfig content) Updates the EkmConfig singleton resource for a given project and location.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Locations

public Locations()

Method Detail

generateRandomBytes

public CloudKMS.Projects.Locations.GenerateRandomBytes generateRandomBytes(String location,
                                                                           GenerateRandomBytesRequest content)
                                                                    throws IOException

Generate random bytes using the Cloud KMS randomness source in the provided location. Create a request for the method "locations.generateRandomBytes". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

location - The project-specific location in which to generate random bytes. For example, "projects/my- project/locations/us-central1".

content - the GenerateRandomBytesRequest

Returns:

the request

Throws:

IOException

get

public CloudKMS.Projects.Locations.Get get(String name)
                                    throws IOException

Gets information about a location. Create a request for the method "locations.get". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Resource name for the location.

Returns:

the request

Throws:

IOException

getEkmConfig

public CloudKMS.Projects.Locations.GetEkmConfig getEkmConfig(String name)
                                                      throws IOException

Returns the EkmConfig singleton resource for a given project and location. Create a request for the method "locations.getEkmConfig". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the EkmConfig to get.

Returns:

the request

Throws:

IOException

list

public CloudKMS.Projects.Locations.List list(String name)
                                      throws IOException

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Create a request for the method "locations.list". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - The resource that owns the locations collection, if applicable.

Returns:

the request

Throws:

IOException

updateEkmConfig

public CloudKMS.Projects.Locations.UpdateEkmConfig updateEkmConfig(String name,
                                                                   EkmConfig content)
                                                            throws IOException

Updates the EkmConfig singleton resource for a given project and location. Create a request for the method "locations.updateEkmConfig". This request holds the parameters needed by the cloudkms server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Output only. The resource name for the EkmConfig in the format `projects/locations/ekmConfig`.

content - the EkmConfig

Returns:

the request

Throws:

IOException

ekmConfig

public CloudKMS.Projects.Locations.EkmConfig ekmConfig()

An accessor for creating requests from the EkmConfig collection.

The typical use is:

    CloudKMS cloudkms = new CloudKMS(...);
    CloudKMS.EkmConfig.List request = cloudkms.ekmConfig().list(parameters ...)
 

Returns:

the resource collection

ekmConnections

public CloudKMS.Projects.Locations.EkmConnections ekmConnections()

An accessor for creating requests from the EkmConnections collection.

The typical use is:

    CloudKMS cloudkms = new CloudKMS(...);
    CloudKMS.EkmConnections.List request = cloudkms.ekmConnections().list(parameters ...)
 

Returns:

the resource collection

keyHandles

public CloudKMS.Projects.Locations.KeyHandles keyHandles()

An accessor for creating requests from the KeyHandles collection.

The typical use is:

    CloudKMS cloudkms = new CloudKMS(...);
    CloudKMS.KeyHandles.List request = cloudkms.keyHandles().list(parameters ...)
 

Returns:

the resource collection

keyRings

public CloudKMS.Projects.Locations.KeyRings keyRings()

An accessor for creating requests from the KeyRings collection.

The typical use is:

    CloudKMS cloudkms = new CloudKMS(...);
    CloudKMS.KeyRings.List request = cloudkms.keyRings().list(parameters ...)
 

Returns:

the resource collection

operations

public CloudKMS.Projects.Locations.Operations operations()

An accessor for creating requests from the Operations collection.

The typical use is:

    CloudKMS cloudkms = new CloudKMS(...);
    CloudKMS.Operations.List request = cloudkms.operations().list(parameters ...)
 

Returns:

the resource collection

retiredResources

public CloudKMS.Projects.Locations.RetiredResources retiredResources()

An accessor for creating requests from the RetiredResources collection.

The typical use is:

    CloudKMS cloudkms = new CloudKMS(...);
    CloudKMS.RetiredResources.List request = cloudkms.retiredResources().list(parameters ...)
 

Returns:

the resource collection

singleTenantHsmInstances

public CloudKMS.Projects.Locations.SingleTenantHsmInstances singleTenantHsmInstances()

An accessor for creating requests from the SingleTenantHsmInstances collection.

The typical use is:

    CloudKMS cloudkms = new CloudKMS(...);
    CloudKMS.SingleTenantHsmInstances.List request = cloudkms.singleTenantHsmInstances().list(parameters ...)
 

Returns:

the resource collection