target.apidocs.com.google.api.services.cloudkms.v1.CloudKMS.Projects.Locations.KeyRings.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-cloudkms Show documentation

There is a newer version: v1-rev20240926-2.0.0

Show newest version







CloudKMS.Projects.Locations.KeyRings (Cloud Key Management Service (KMS) API v1-rev20240801-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.cloudkms.v1
Class CloudKMS.Projects.Locations.KeyRings



java.lang.Object


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







Enclosing class:
CloudKMS.Projects.Locations




public class CloudKMS.Projects.Locations.KeyRings
extends Object
The "keyRings" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
CloudKMS.Projects.Locations.KeyRings.Create 


class 
CloudKMS.Projects.Locations.KeyRings.CryptoKeys
The "cryptoKeys" collection of methods.



class 
CloudKMS.Projects.Locations.KeyRings.Get 


class 
CloudKMS.Projects.Locations.KeyRings.GetIamPolicy 


class 
CloudKMS.Projects.Locations.KeyRings.ImportJobs
The "importJobs" collection of methods.



class 
CloudKMS.Projects.Locations.KeyRings.List 


class 
CloudKMS.Projects.Locations.KeyRings.SetIamPolicy 


class 
CloudKMS.Projects.Locations.KeyRings.TestIamPermissions 









Constructor Summary

Constructors 

Constructor and Description


KeyRings() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


CloudKMS.Projects.Locations.KeyRings.Create
create(String parent,
      KeyRing content)
Create a new KeyRing in a given Project and Location.



CloudKMS.Projects.Locations.KeyRings.CryptoKeys
cryptoKeys()
An accessor for creating requests from the CryptoKeys collection.



CloudKMS.Projects.Locations.KeyRings.Get
get(String name)
Returns metadata for a given KeyRing.



CloudKMS.Projects.Locations.KeyRings.GetIamPolicy
getIamPolicy(String resource)
Gets the access control policy for a resource.



CloudKMS.Projects.Locations.KeyRings.ImportJobs
importJobs()
An accessor for creating requests from the ImportJobs collection.



CloudKMS.Projects.Locations.KeyRings.List
list(String parent)
Lists KeyRings.



CloudKMS.Projects.Locations.KeyRings.SetIamPolicy
setIamPolicy(String resource,
            SetIamPolicyRequest content)
Sets the access control policy on the specified resource.



CloudKMS.Projects.Locations.KeyRings.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





KeyRings
public KeyRings()









Method Detail





create
public CloudKMS.Projects.Locations.KeyRings.Create create(String parent,
                                                          KeyRing content)
                                                   throws IOException
Create a new KeyRing in a given Project and Location.

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

 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:
parent - Required. The resource name of the location associated with the KeyRings, in the format
        `projects/locations`.
content - the KeyRing
Returns:
the request
Throws:
IOException








get
public CloudKMS.Projects.Locations.KeyRings.Get get(String name)
                                             throws IOException
Returns metadata for a given KeyRing.

 Create a request for the method "keyRings.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 - Required. The name of the KeyRing to get.
Returns:
the request
Throws:
IOException








getIamPolicy
public CloudKMS.Projects.Locations.KeyRings.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 "keyRings.getIamPolicy".

 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:
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 CloudKMS.Projects.Locations.KeyRings.List list(String parent)
                                               throws IOException
Lists KeyRings.

 Create a request for the method "keyRings.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:
parent - Required. The resource name of the location associated with the KeyRings, in the format
        `projects/locations`.
Returns:
the request
Throws:
IOException








setIamPolicy
public CloudKMS.Projects.Locations.KeyRings.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 "keyRings.setIamPolicy".

 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:
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 CloudKMS.Projects.Locations.KeyRings.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 "keyRings.testIamPermissions".

 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:
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








cryptoKeys
public CloudKMS.Projects.Locations.KeyRings.CryptoKeys cryptoKeys()
An accessor for creating requests from the CryptoKeys collection.

 The typical use is:
     CloudKMS cloudkms = new CloudKMS(...);
    CloudKMS.CryptoKeys.List request = cloudkms.cryptoKeys().list(parameters ...)
 

Returns:
the resource collection








importJobs
public CloudKMS.Projects.Locations.KeyRings.ImportJobs importJobs()
An accessor for creating requests from the ImportJobs collection.

 The typical use is:
     CloudKMS cloudkms = new CloudKMS(...);
    CloudKMS.ImportJobs.List request = cloudkms.importJobs().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`	`CloudKMS.Projects.Locations.KeyRings.Create`
`class`	`CloudKMS.Projects.Locations.KeyRings.CryptoKeys` The "cryptoKeys" collection of methods.
`class`	`CloudKMS.Projects.Locations.KeyRings.Get`
`class`	`CloudKMS.Projects.Locations.KeyRings.GetIamPolicy`
`class`	`CloudKMS.Projects.Locations.KeyRings.ImportJobs` The "importJobs" collection of methods.
`class`	`CloudKMS.Projects.Locations.KeyRings.List`
`class`	`CloudKMS.Projects.Locations.KeyRings.SetIamPolicy`
`class`	`CloudKMS.Projects.Locations.KeyRings.TestIamPermissions`

Modifier and Type	Method and Description
`CloudKMS.Projects.Locations.KeyRings.Create`	`create(String parent, KeyRing content)` Create a new KeyRing in a given Project and Location.
`CloudKMS.Projects.Locations.KeyRings.CryptoKeys`	`cryptoKeys()` An accessor for creating requests from the CryptoKeys collection.
`CloudKMS.Projects.Locations.KeyRings.Get`	`get(String name)` Returns metadata for a given KeyRing.
`CloudKMS.Projects.Locations.KeyRings.GetIamPolicy`	`getIamPolicy(String resource)` Gets the access control policy for a resource.
`CloudKMS.Projects.Locations.KeyRings.ImportJobs`	`importJobs()` An accessor for creating requests from the ImportJobs collection.
`CloudKMS.Projects.Locations.KeyRings.List`	`list(String parent)` Lists KeyRings.
`CloudKMS.Projects.Locations.KeyRings.SetIamPolicy`	`setIamPolicy(String resource, SetIamPolicyRequest content)` Sets the access control policy on the specified resource.
`CloudKMS.Projects.Locations.KeyRings.TestIamPermissions`	`testIamPermissions(String resource, TestIamPermissionsRequest content)` Returns permissions that a caller has on the specified resource.