Google Cloud Managed Lustre v1 API - Class DirectoryPolicyName (1.1.0) 

public sealed class DirectoryPolicyName : IResourceName, IEquatable<DirectoryPolicyName>

Reference documentation and code samples for the Google Cloud Managed Lustre v1 API class DirectoryPolicyName.

Resource name for the DirectoryPolicy resource.

Inheritance

object > DirectoryPolicyName

Namespace

Google.Cloud.Lustre.V1

Assembly

Google.Cloud.Lustre.V1.dll

Constructors

DirectoryPolicyName(string, string, string, string)

public DirectoryPolicyName(string projectId, string locationId, string instanceId, string directoryPolicyId)

Constructs a new instance of a DirectoryPolicyName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/directoryPolicies/{directory_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.
instanceId string

The Instance ID. Must not be null or empty.
directoryPolicyId string

The DirectoryPolicy ID. Must not be null or empty.

Properties

DirectoryPolicyId

public string DirectoryPolicyId { get; }

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

Property Value
Type Description
string

InstanceId

public string InstanceId { get; }

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

The DirectoryPolicyName.ResourceNameType of the contained resource name.

Property Value
Type Description
DirectoryPolicyNameResourceNameType

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 instanceId, string directoryPolicyId)

Formats the IDs into the string representation of this DirectoryPolicyName with pattern projects/{project}/locations/{location}/instances/{instance}/directoryPolicies/{directory_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.
instanceId string

The Instance ID. Must not be null or empty.
directoryPolicyId string

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

The string representation of this DirectoryPolicyName with pattern projects/{project}/locations/{location}/instances/{instance}/directoryPolicies/{directory_policy}.

FormatProjectLocationInstanceDirectoryPolicy(string, string, string, string)

public static string FormatProjectLocationInstanceDirectoryPolicy(string projectId, string locationId, string instanceId, string directoryPolicyId)

Formats the IDs into the string representation of this DirectoryPolicyName with pattern projects/{project}/locations/{location}/instances/{instance}/directoryPolicies/{directory_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.
instanceId string

The Instance ID. Must not be null or empty.
directoryPolicyId string

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

The string representation of this DirectoryPolicyName with pattern projects/{project}/locations/{location}/instances/{instance}/directoryPolicies/{directory_policy}.

FromProjectLocationInstanceDirectoryPolicy(string, string, string, string)

public static DirectoryPolicyName FromProjectLocationInstanceDirectoryPolicy(string projectId, string locationId, string instanceId, string directoryPolicyId)

Creates a DirectoryPolicyName with the pattern projects/{project}/locations/{location}/instances/{instance}/directoryPolicies/{directory_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.
instanceId string

The Instance ID. Must not be null or empty.
directoryPolicyId string

The DirectoryPolicy ID. Must not be null or empty.
Returns
Type Description
DirectoryPolicyName

A new instance of DirectoryPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DirectoryPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DirectoryPolicyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
directoryPolicyName string

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

The parsed DirectoryPolicyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/directoryPolicies/{directory_policy}

Parse(string, bool)

public static DirectoryPolicyName Parse(string directoryPolicyName, bool allowUnparsed)

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

Parameters
Name Description
directoryPolicyName 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
DirectoryPolicyName

The parsed DirectoryPolicyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/directoryPolicies/{directory_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 DirectoryPolicyName)

public static bool TryParse(string directoryPolicyName, out DirectoryPolicyName result)

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

Parameters
Name Description
directoryPolicyName string

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

When this method returns, the parsed DirectoryPolicyName, 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}/instances/{instance}/directoryPolicies/{directory_policy}

TryParse(string, bool, out DirectoryPolicyName)

public static bool TryParse(string directoryPolicyName, bool allowUnparsed, out DirectoryPolicyName result)

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

Parameters
Name Description
directoryPolicyName 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 DirectoryPolicyName

When this method returns, the parsed DirectoryPolicyName, 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}/instances/{instance}/directoryPolicies/{directory_policy}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DirectoryPolicyName, DirectoryPolicyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DirectoryPolicyName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DirectoryPolicyName

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

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.