Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.ClustersResource.AclsResource

The "acls" collection of methods.

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

Constructors

AclsResource(IClientService)

Constructs a new resource.

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

Methods

AddAclEntry(AclEntry, string)

Incremental update: Adds an acl entry to an acl. Creates the acl if it does not exist yet.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.AclsResource.AddAclEntryRequest AddAclEntry(AclEntry body, string acl)
Parameters
Type Name Description
AclEntry body

The body of the request.

string acl

Required. The name of the acl to add the acl entry to. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}. The structure of acl_id defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See Acl.name for details.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.AclsResource.AddAclEntryRequest

Create(Acl, string)

Creates a new acl in the given project, location, and cluster.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.AclsResource.CreateRequest Create(Acl body, string parent)
Parameters
Type Name Description
Acl body

The body of the request.

string parent

Required. The parent cluster in which to create the acl. Structured like projects/{project}/locations/{location}/clusters/{cluster}.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.AclsResource.CreateRequest

Delete(string)

Deletes an acl.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.AclsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The name of the acl to delete. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}. The structure of acl_id defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See Acl.name for details.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.AclsResource.DeleteRequest

Get(string)

Returns the properties of a single acl.

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

Required. The name of the acl to return. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}. The structure of acl_id defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See Acl.name for details.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.AclsResource.GetRequest

List(string)

Lists the acls in a given cluster.

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

Required. The parent cluster whose acls are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.AclsResource.ListRequest

Patch(Acl, string)

Updates the properties of a single acl.

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.AclsResource.PatchRequest Patch(Acl body, string name)
Parameters
Type Name Description
Acl body

The body of the request.

string name

Identifier. The name for the acl. Represents a single Resource Pattern. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id} The structure of acl_id defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. acl_id is structured like one of the following: For acls on the cluster: cluster For acls on a single resource within the cluster: topic/{resource_name} consumerGroup/{resource_name} transactionalId/{resource_name} For acls on all resources that match a prefix: topicPrefixed/{resource_name} consumerGroupPrefixed/{resource_name} transactionalIdPrefixed/{resource_name} For acls on all resources of a given type (i.e. the wildcard literal "*"): allTopics (represents topic/*) allConsumerGroups (represents consumerGroup/*) allTransactionalIds (represents transactionalId/*)

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.AclsResource.PatchRequest

RemoveAclEntry(AclEntry, string)

Incremental update: Removes an acl entry from an acl. Deletes the acl if its acl entries become empty (i.e. if the removed entry was the last one in the acl).

Declaration
public virtual ProjectsResource.LocationsResource.ClustersResource.AclsResource.RemoveAclEntryRequest RemoveAclEntry(AclEntry body, string acl)
Parameters
Type Name Description
AclEntry body

The body of the request.

string acl

Required. The name of the acl to remove the acl entry from. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}. The structure of acl_id defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See Acl.name for details.

Returns
Type Description
ProjectsResource.LocationsResource.ClustersResource.AclsResource.RemoveAclEntryRequest
In this article
Back to top Generated by DocFX