Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.EkmConnectionsResource

The "ekmConnections" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.EkmConnectionsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudKMS.v1
Assembly: Google.Apis.CloudKMS.v1.dll
Syntax
public class ProjectsResource.LocationsResource.EkmConnectionsResource

Constructors

EkmConnectionsResource(IClientService)

Constructs a new resource.

Declaration
public EkmConnectionsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Create(EkmConnection, string)

Creates a new EkmConnection in a given Project and Location.

Declaration
public virtual ProjectsResource.LocationsResource.EkmConnectionsResource.CreateRequest Create(EkmConnection body, string parent)
Parameters
Type Name Description
EkmConnection body

The body of the request.

string parent

Required. The resource name of the location associated with the EkmConnection, in the format projects/*/locations/*.

Returns
Type Description
ProjectsResource.LocationsResource.EkmConnectionsResource.CreateRequest

Get(string)

Returns metadata for a given EkmConnection.

Declaration
public virtual ProjectsResource.LocationsResource.EkmConnectionsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The name of the EkmConnection to get.

Returns
Type Description
ProjectsResource.LocationsResource.EkmConnectionsResource.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.EkmConnectionsResource.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.EkmConnectionsResource.GetIamPolicyRequest

List(string)

Lists EkmConnections.

Declaration
public virtual ProjectsResource.LocationsResource.EkmConnectionsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The resource name of the location associated with the EkmConnections to list, in the format projects/*/locations/*.

Returns
Type Description
ProjectsResource.LocationsResource.EkmConnectionsResource.ListRequest

Patch(EkmConnection, string)

Updates an EkmConnection's metadata.

Declaration
public virtual ProjectsResource.LocationsResource.EkmConnectionsResource.PatchRequest Patch(EkmConnection body, string name)
Parameters
Type Name Description
EkmConnection body

The body of the request.

string name

Output only. The resource name for the EkmConnection in the format projects/*/locations/*/ekmConnections/*.

Returns
Type Description
ProjectsResource.LocationsResource.EkmConnectionsResource.PatchRequest

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.EkmConnectionsResource.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.EkmConnectionsResource.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.EkmConnectionsResource.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.EkmConnectionsResource.TestIamPermissionsRequest

VerifyConnectivity(string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.EkmConnectionsResource.VerifyConnectivityRequest VerifyConnectivity(string name)
Parameters
Type Name Description
string name

Required. The name of the EkmConnection to verify.

Returns
Type Description
ProjectsResource.LocationsResource.EkmConnectionsResource.VerifyConnectivityRequest
In this article
Back to top Generated by DocFX