Class ProjectsResource.LocationsResource.MembershipsResource

The "memberships" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.MembershipsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.GKEHub.v1alpha

Assembly: Google.Apis.GKEHub.v1alpha.dll

Syntax

public class ProjectsResource.LocationsResource.MembershipsResource

Constructors

MembershipsResource(IClientService)

Constructs a new resource.

Declaration

public MembershipsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Bindings

Gets the Bindings resource.

Declaration

public virtual ProjectsResource.LocationsResource.MembershipsResource.BindingsResource Bindings { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.MembershipsResource.BindingsResource

Rbacrolebindings

Gets the Rbacrolebindings resource.

Declaration

public virtual ProjectsResource.LocationsResource.MembershipsResource.RbacrolebindingsResource Rbacrolebindings { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.MembershipsResource.RbacrolebindingsResource

Methods

Create(Membership, string)

Creates a new Membership. This is currently only supported for GKE clusters on Google Cloud. To register other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.

Declaration

public virtual ProjectsResource.LocationsResource.MembershipsResource.CreateRequest Create(Membership body, string parent)

Parameters

Type	Name	Description
Membership	body	The body of the request.
string	parent	Required. The parent (project and location) where the Memberships will be created. Specified in the format projects/*/locations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.MembershipsResource.CreateRequest

Delete(string)

Removes a Membership. This is currently only supported for GKE clusters on Google Cloud. To unregister other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.

Declaration

public virtual ProjectsResource.LocationsResource.MembershipsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

Returns

Type	Description
ProjectsResource.LocationsResource.MembershipsResource.DeleteRequest

GenerateConnectManifest(string)

Generates the manifest for deployment of the GKE connect agent. This method is used internally by Google-provided libraries. Most clients should not need to call this method directly.

Declaration

public virtual ProjectsResource.LocationsResource.MembershipsResource.GenerateConnectManifestRequest GenerateConnectManifest(string name)

Parameters

Type	Name	Description
string	name	Required. The Membership resource name the Agent will associate with, in the format projects/*/locations/*/memberships/*.

Returns

Type	Description
ProjectsResource.LocationsResource.MembershipsResource.GenerateConnectManifestRequest

GenerateExclusivityManifest(string)

GenerateExclusivityManifest generates the manifests to update the exclusivity artifacts in the cluster if needed. Exclusivity artifacts include the Membership custom resource definition (CRD) and the singleton Membership custom resource (CR). Combined with ValidateExclusivity, exclusivity artifacts guarantee that a Kubernetes cluster is only registered to a single GKE Hub. The Membership CRD is versioned, and may require conversion when the GKE Hub API server begins serving a newer version of the CRD and corresponding CR. The response will be the converted CRD and CR if there are any differences between the versions.

Declaration

public virtual ProjectsResource.LocationsResource.MembershipsResource.GenerateExclusivityManifestRequest GenerateExclusivityManifest(string name)

Parameters

Type	Name	Description
string	name	Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

Returns

Type	Description
ProjectsResource.LocationsResource.MembershipsResource.GenerateExclusivityManifestRequest

Get(string)

Gets the details of a Membership.

Declaration

public virtual ProjectsResource.LocationsResource.MembershipsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

Returns

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

List(string)

Lists Memberships in a given project and location.

Declaration

public virtual ProjectsResource.LocationsResource.MembershipsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The parent (project and location) where the Memberships will be listed. Specified in the format projects/*/locations/*. projects/*/locations/- list memberships in all the regions.

Returns

Type	Description
ProjectsResource.LocationsResource.MembershipsResource.ListRequest

ListAdmin(string)

Lists Memberships of admin clusters in a given project and location. This method is only used internally.

Declaration

public virtual ProjectsResource.LocationsResource.MembershipsResource.ListAdminRequest ListAdmin(string parent)

Parameters

Type	Name	Description
string	parent	Required. The parent (project and location) where the Memberships of admin cluster will be listed. Specified in the format projects/*/locations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.MembershipsResource.ListAdminRequest

Patch(Membership, string)

Updates an existing Membership.

Declaration

public virtual ProjectsResource.LocationsResource.MembershipsResource.PatchRequest Patch(Membership body, string name)

Parameters

Type	Name	Description
Membership	body	The body of the request.
string	name	Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

Returns

Type	Description
ProjectsResource.LocationsResource.MembershipsResource.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.MembershipsResource.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.MembershipsResource.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.MembershipsResource.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.MembershipsResource.TestIamPermissionsRequest

ValidateCreate(ValidateCreateMembershipRequest, string)

ValidateCreateMembership is a preflight check for CreateMembership. It checks the following: 1. Caller has the required gkehub.memberships.create permission. 2. The membership_id is still available.

Declaration

public virtual ProjectsResource.LocationsResource.MembershipsResource.ValidateCreateRequest ValidateCreate(ValidateCreateMembershipRequest body, string parent)

Parameters

Type	Name	Description
ValidateCreateMembershipRequest	body	The body of the request.
string	parent	Required. The parent (project and location) where the Memberships will be created. Specified in the format projects/*/locations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.MembershipsResource.ValidateCreateRequest

ValidateExclusivity(string)

ValidateExclusivity validates the state of exclusivity in the cluster. The validation does not depend on an existing Hub membership resource.

Declaration

public virtual ProjectsResource.LocationsResource.MembershipsResource.ValidateExclusivityRequest ValidateExclusivity(string parent)

Parameters

Type	Name	Description
string	parent	Required. The parent (project and location) where the Memberships will be created. Specified in the format projects/*/locations/*.

Returns

Type	Description
ProjectsResource.LocationsResource.MembershipsResource.ValidateExclusivityRequest