Google Cloud Memorystore for Redis (cluster management) v1 API - Class AclPolicyName (1.9.0) 

public sealed class AclPolicyName : IResourceName, IEquatable<AclPolicyName>

Reference documentation and code samples for the Google Cloud Memorystore for Redis (cluster management) v1 API class AclPolicyName.

Resource name for the AclPolicy resource.

Inheritance

object > AclPolicyName

Namespace

Google.Cloud.Redis.Cluster.V1

Assembly

Google.Cloud.Redis.Cluster.V1.dll

Constructors

AclPolicyName(string, string, string)

public AclPolicyName(string projectId, string locationId, string aclPolicyId)

Constructs a new instance of a AclPolicyName class from the component parts of pattern projects/{project}/locations/{location}/aclPolicies/{acl_policy}

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.
aclPolicyId string

The AclPolicy ID. Must not be null or empty.

Properties

AclPolicyId

public string AclPolicyId { get; }

The AclPolicy 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 AclPolicyName.ResourceNameType Type { get; }

The AclPolicyName.ResourceNameType of the contained resource name.

Property Value
Type Description
AclPolicyNameResourceNameType

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)

public static string Format(string projectId, string locationId, string aclPolicyId)

Formats the IDs into the string representation of this AclPolicyName with pattern projects/{project}/locations/{location}/aclPolicies/{acl_policy}.

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.
aclPolicyId string

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

The string representation of this AclPolicyName with pattern projects/{project}/locations/{location}/aclPolicies/{acl_policy}.

FormatProjectLocationAclPolicy(string, string, string)

public static string FormatProjectLocationAclPolicy(string projectId, string locationId, string aclPolicyId)

Formats the IDs into the string representation of this AclPolicyName with pattern projects/{project}/locations/{location}/aclPolicies/{acl_policy}.

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.
aclPolicyId string

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

The string representation of this AclPolicyName with pattern projects/{project}/locations/{location}/aclPolicies/{acl_policy}.

FromProjectLocationAclPolicy(string, string, string)

public static AclPolicyName FromProjectLocationAclPolicy(string projectId, string locationId, string aclPolicyId)

Creates a AclPolicyName with the pattern projects/{project}/locations/{location}/aclPolicies/{acl_policy}.

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.
aclPolicyId string

The AclPolicy ID. Must not be null or empty.
Returns
Type Description
AclPolicyName

A new instance of AclPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AclPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AclPolicyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of AclPolicyName 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 AclPolicyName Parse(string aclPolicyName)

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

Parameter
Name Description
aclPolicyName string

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

The parsed AclPolicyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/aclPolicies/{acl_policy}

Parse(string, bool)

public static AclPolicyName Parse(string aclPolicyName, bool allowUnparsed)

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

Parameters
Name Description
aclPolicyName 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
AclPolicyName

The parsed AclPolicyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/aclPolicies/{acl_policy}

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 AclPolicyName)

public static bool TryParse(string aclPolicyName, out AclPolicyName result)

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

Parameters
Name Description
aclPolicyName string

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

When this method returns, the parsed AclPolicyName, 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}/aclPolicies/{acl_policy}

TryParse(string, bool, out AclPolicyName)

public static bool TryParse(string aclPolicyName, bool allowUnparsed, out AclPolicyName result)

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

Parameters
Name Description
aclPolicyName 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 AclPolicyName

When this method returns, the parsed AclPolicyName, 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}/aclPolicies/{acl_policy}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AclPolicyName, AclPolicyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AclPolicyName

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

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 !=(AclPolicyName, AclPolicyName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AclPolicyName

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

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.