Class ProjectsResource.LocationsResource.KeyRingsResource
The "keyRings" collection of methods.
Inherited Members
Namespace: Google.Apis.CloudKMS.v1
Assembly: Google.Apis.CloudKMS.v1.dll
Syntax
public class ProjectsResource.LocationsResource.KeyRingsResource
Constructors
KeyRingsResource(IClientService)
Constructs a new resource.
Declaration
public KeyRingsResource(IClientService service)
Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service |
Properties
CryptoKeys
Gets the CryptoKeys resource.
Declaration
public virtual ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource CryptoKeys { get; }
Property Value
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.KeyRingsResource.CryptoKeysResource |
ImportJobs
Gets the ImportJobs resource.
Declaration
public virtual ProjectsResource.LocationsResource.KeyRingsResource.ImportJobsResource ImportJobs { get; }
Property Value
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.KeyRingsResource.ImportJobsResource |
Methods
Create(KeyRing, string)
Create a new KeyRing in a given Project and Location.
Declaration
public virtual ProjectsResource.LocationsResource.KeyRingsResource.CreateRequest Create(KeyRing body, string parent)
Parameters
| Type | Name | Description |
|---|---|---|
| KeyRing | body | The body of the request. |
| string | parent | Required. The resource name of the location associated with the KeyRings, in the format
|
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.KeyRingsResource.CreateRequest |
Delete(string)
Permanently deletes the given KeyRing. All child resources of the KeyRing must have been previously deleted using their corresponding Delete operations. The specified key ring will be immediately and permanently deleted upon calling this method. This action cannot be undone.
Declaration
public virtual ProjectsResource.LocationsResource.KeyRingsResource.DeleteRequest Delete(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the KeyRing to delete. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.KeyRingsResource.DeleteRequest |
Get(string)
Returns metadata for a given KeyRing.
Declaration
public virtual ProjectsResource.LocationsResource.KeyRingsResource.GetRequest Get(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Required. The name of the KeyRing to get. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.KeyRingsResource.GetRequest |
GetIamPolicy(string)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Declaration
public virtual ProjectsResource.LocationsResource.KeyRingsResource.GetIamPolicyRequest GetIamPolicy(string resource)
Parameters
| Type | Name | Description |
|---|---|---|
| string | resource | REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.KeyRingsResource.GetIamPolicyRequest |
List(string)
Lists KeyRings.
Declaration
public virtual ProjectsResource.LocationsResource.KeyRingsResource.ListRequest List(string parent)
Parameters
| Type | Name | Description |
|---|---|---|
| string | parent | Required. The resource name of the location associated with the KeyRings, in the format
|
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.KeyRingsResource.ListRequest |
SetIamPolicy(SetIamPolicyRequest, string)
Sets the access control policy on the specified resource. Replaces any existing policy. Can return
NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Declaration
public virtual ProjectsResource.LocationsResource.KeyRingsResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)
Parameters
| Type | Name | Description |
|---|---|---|
| SetIamPolicyRequest | body | The body of the request. |
| string | resource | REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.KeyRingsResource.SetIamPolicyRequest |
TestIamPermissions(TestIamPermissionsRequest, string)
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.
Declaration
public virtual ProjectsResource.LocationsResource.KeyRingsResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)
Parameters
| Type | Name | Description |
|---|---|---|
| TestIamPermissionsRequest | body | The body of the request. |
| string | resource | REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. |
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.KeyRingsResource.TestIamPermissionsRequest |