Managed Service for Apache Kafka API v1 API - Class AclName (1.0.0-beta07) 

public sealed class AclName : IResourceName, IEquatable<AclName>

Reference documentation and code samples for the Managed Service for Apache Kafka API v1 API class AclName.

Resource name for the Acl resource.

Inheritance

object > AclName

Namespace

Google.Cloud.ManagedKafka.V1

Assembly

Google.Cloud.ManagedKafka.V1.dll

Constructors

AclName(string, string, string, string)

public AclName(string projectId, string locationId, string clusterId, string aclId)

Constructs a new instance of a AclName class from the component parts of pattern projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
clusterId string

The Cluster ID. Must not be null or empty.
aclId string

The Acl ID. Must not be null or empty.

Properties

AclId

public string AclId { get; }

The Acl ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

ClusterId

public string ClusterId { get; }

The Cluster ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Type

public AclName.ResourceNameType Type { get; }

The AclName.ResourceNameType of the contained resource name.

Property Value
Type Description
AclNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string clusterId, string aclId)

Formats the IDs into the string representation of this AclName with pattern projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
clusterId string

The Cluster ID. Must not be null or empty.
aclId string

The Acl ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this AclName with pattern projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl}.

FormatProjectLocationClusterAcl(string, string, string, string)

public static string FormatProjectLocationClusterAcl(string projectId, string locationId, string clusterId, string aclId)

Formats the IDs into the string representation of this AclName with pattern projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
clusterId string

The Cluster ID. Must not be null or empty.
aclId string

The Acl ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this AclName with pattern projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl}.

FromProjectLocationClusterAcl(string, string, string, string)

public static AclName FromProjectLocationClusterAcl(string projectId, string locationId, string clusterId, string aclId)

Creates a AclName with the pattern projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
clusterId string

The Cluster ID. Must not be null or empty.
aclId string

The Acl ID. Must not be null or empty.
Returns
Type Description
AclName

A new instance of AclName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AclName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AclName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
AclName

A new instance of AclName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static AclName Parse(string aclName)

Parses the given resource name string into a new AclName instance.

Parameter
Name Description
aclName string

The resource name in string form. Must not be null.
Returns
Type Description
AclName

The parsed AclName if successful.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl}

Parse(string, bool)

public static AclName Parse(string aclName, bool allowUnparsed)

Parses the given resource name string into a new AclName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
aclName string

The resource name in string form. Must not be null.
allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
Returns
Type Description
AclName

The parsed AclName if successful.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type Description
string

The string representation of the resource name.
Overrides

TryParse(string, out AclName)

public static bool TryParse(string aclName, out AclName result)

Tries to parse the given resource name string into a new AclName instance.

Parameters
Name Description
aclName string

The resource name in string form. Must not be null.
result AclName

When this method returns, the parsed AclName, or null if parsing failed.
Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl}

TryParse(string, bool, out AclName)

public static bool TryParse(string aclName, bool allowUnparsed, out AclName result)

Tries to parse the given resource name string into a new AclName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
aclName string

The resource name in string form. Must not be null.
allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
result AclName

When this method returns, the parsed AclName, or null if parsing failed.
Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AclName, AclName)

public static bool operator ==(AclName a, AclName b)

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AclName

The first resource name to compare, or null.
b AclName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(AclName, AclName)

public static bool operator !=(AclName a, AclName b)

Determines whether two specified resource names have different values.

Parameters
Name Description
a AclName

The first resource name to compare, or null.
b AclName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.