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



java.lang.Object


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







Enclosing class:
CloudKMS.Projects.Locations




public class CloudKMS.Projects.Locations.EkmConnections
extends Object
The "ekmConnections" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
CloudKMS.Projects.Locations.EkmConnections.Create 


class 
CloudKMS.Projects.Locations.EkmConnections.Get 


class 
CloudKMS.Projects.Locations.EkmConnections.GetIamPolicy 


class 
CloudKMS.Projects.Locations.EkmConnections.List 


class 
CloudKMS.Projects.Locations.EkmConnections.Patch 


class 
CloudKMS.Projects.Locations.EkmConnections.SetIamPolicy 


class 
CloudKMS.Projects.Locations.EkmConnections.TestIamPermissions 


class 
CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity 









Constructor Summary

Constructors 

Constructor and Description


EkmConnections() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


CloudKMS.Projects.Locations.EkmConnections.Create
create(String parent,
      EkmConnection content)
Creates a new EkmConnection in a given Project and Location.



CloudKMS.Projects.Locations.EkmConnections.Get
get(String name)
Returns metadata for a given EkmConnection.



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



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



CloudKMS.Projects.Locations.EkmConnections.Patch
patch(String name,
     EkmConnection content)
Updates an EkmConnection's metadata.



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



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



CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity
verifyConnectivity(String name)
Verifies that Cloud KMS can successfully connect to the external key manager specified by an
 EkmConnection.







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














Constructor Detail





EkmConnections
public EkmConnections()









Method Detail





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

 Create a request for the method "ekmConnections.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 EkmConnection, in the format
        `projects/locations`.
content - the EkmConnection
Returns:
the request
Throws:
IOException








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

 Create a request for the method "ekmConnections.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 EkmConnection to get.
Returns:
the request
Throws:
IOException








getIamPolicy
public CloudKMS.Projects.Locations.EkmConnections.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 "ekmConnections.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.EkmConnections.List list(String parent)
                                                     throws IOException
Lists EkmConnections.

 Create a request for the method "ekmConnections.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 EkmConnections to list, in the
        format `projects/locations`.
Returns:
the request
Throws:
IOException








patch
public CloudKMS.Projects.Locations.EkmConnections.Patch patch(String name,
                                                              EkmConnection content)
                                                       throws IOException
Updates an EkmConnection's metadata.

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

 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 EkmConnection in the format
        `projects/locations/ekmConnections`.
content - the EkmConnection
Returns:
the request
Throws:
IOException








setIamPolicy
public CloudKMS.Projects.Locations.EkmConnections.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 "ekmConnections.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.EkmConnections.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 "ekmConnections.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








verifyConnectivity
public CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity verifyConnectivity(String name)
                                                                                 throws IOException
Verifies that Cloud KMS can successfully connect to the external key manager specified by an
 EkmConnection. If there is an error connecting to the EKM, this method returns a
 FAILED_PRECONDITION status containing structured information as described at
 https://cloud.google.com/kms/docs/reference/ekm_errors.

 Create a request for the method "ekmConnections.verifyConnectivity".

 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 EkmConnection to verify.
Returns:
the request
Throws:
IOException














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.EkmConnections.Create`
`class`	`CloudKMS.Projects.Locations.EkmConnections.Get`
`class`	`CloudKMS.Projects.Locations.EkmConnections.GetIamPolicy`
`class`	`CloudKMS.Projects.Locations.EkmConnections.List`
`class`	`CloudKMS.Projects.Locations.EkmConnections.Patch`
`class`	`CloudKMS.Projects.Locations.EkmConnections.SetIamPolicy`
`class`	`CloudKMS.Projects.Locations.EkmConnections.TestIamPermissions`
`class`	`CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity`

Modifier and Type	Method and Description
`CloudKMS.Projects.Locations.EkmConnections.Create`	`create(String parent, EkmConnection content)` Creates a new EkmConnection in a given Project and Location.
`CloudKMS.Projects.Locations.EkmConnections.Get`	`get(String name)` Returns metadata for a given EkmConnection.
`CloudKMS.Projects.Locations.EkmConnections.GetIamPolicy`	`getIamPolicy(String resource)` Gets the access control policy for a resource.
`CloudKMS.Projects.Locations.EkmConnections.List`	`list(String parent)` Lists EkmConnections.
`CloudKMS.Projects.Locations.EkmConnections.Patch`	`patch(String name, EkmConnection content)` Updates an EkmConnection's metadata.
`CloudKMS.Projects.Locations.EkmConnections.SetIamPolicy`	`setIamPolicy(String resource, SetIamPolicyRequest content)` Sets the access control policy on the specified resource.
`CloudKMS.Projects.Locations.EkmConnections.TestIamPermissions`	`testIamPermissions(String resource, TestIamPermissionsRequest content)` Returns permissions that a caller has on the specified resource.
`CloudKMS.Projects.Locations.EkmConnections.VerifyConnectivity`	`verifyConnectivity(String name)` Verifies that Cloud KMS can successfully connect to the external key manager specified by an EkmConnection.