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

public sealed class ResourcePolicyName : IResourceName, IEquatable<ResourcePolicyName>

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

Resource name for the ResourcePolicy resource.

Inheritance

object > ResourcePolicyName

Namespace

Google.Cloud.Lustre.V1

Assembly

Google.Cloud.Lustre.V1.dll

Constructors

ResourcePolicyName(string, string, string)

public ResourcePolicyName(string projectId, string regionId, string resourcePolicyId)

Constructs a new instance of a ResourcePolicyName class from the component parts of pattern projects/{project}/regions/{region}/resourcePolicies/{resource_policy}

Parameters
Name Description
projectId string

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

The Region ID. Must not be null or empty.
resourcePolicyId string

The ResourcePolicy ID. Must not be null or empty.

Properties

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

RegionId

public string RegionId { get; }

The Region ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

ResourcePolicyId

public string ResourcePolicyId { get; }

The ResourcePolicy ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public ResourcePolicyName.ResourceNameType Type { get; }

The ResourcePolicyName.ResourceNameType of the contained resource name.

Property Value
Type Description
ResourcePolicyNameResourceNameType

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 regionId, string resourcePolicyId)

Formats the IDs into the string representation of this ResourcePolicyName with pattern projects/{project}/regions/{region}/resourcePolicies/{resource_policy}.

Parameters
Name Description
projectId string

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

The Region ID. Must not be null or empty.
resourcePolicyId string

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

The string representation of this ResourcePolicyName with pattern projects/{project}/regions/{region}/resourcePolicies/{resource_policy}.

FormatProjectLocationResourcePolicy(string, string, string)

public static string FormatProjectLocationResourcePolicy(string projectId, string locationId, string resourcePolicyId)

Formats the IDs into the string representation of this ResourcePolicyName with pattern projects/{project}/locations/{location}/resourcePolicies/{resource_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.
resourcePolicyId string

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

The string representation of this ResourcePolicyName with pattern projects/{project}/locations/{location}/resourcePolicies/{resource_policy}.

FormatProjectRegionResourcePolicy(string, string, string)

public static string FormatProjectRegionResourcePolicy(string projectId, string regionId, string resourcePolicyId)

Formats the IDs into the string representation of this ResourcePolicyName with pattern projects/{project}/regions/{region}/resourcePolicies/{resource_policy}.

Parameters
Name Description
projectId string

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

The Region ID. Must not be null or empty.
resourcePolicyId string

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

The string representation of this ResourcePolicyName with pattern projects/{project}/regions/{region}/resourcePolicies/{resource_policy}.

FromProjectLocationResourcePolicy(string, string, string)

public static ResourcePolicyName FromProjectLocationResourcePolicy(string projectId, string locationId, string resourcePolicyId)

Creates a ResourcePolicyName with the pattern projects/{project}/locations/{location}/resourcePolicies/{resource_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.
resourcePolicyId string

The ResourcePolicy ID. Must not be null or empty.
Returns
Type Description
ResourcePolicyName

A new instance of ResourcePolicyName constructed from the provided ids.

FromProjectRegionResourcePolicy(string, string, string)

public static ResourcePolicyName FromProjectRegionResourcePolicy(string projectId, string regionId, string resourcePolicyId)

Creates a ResourcePolicyName with the pattern projects/{project}/regions/{region}/resourcePolicies/{resource_policy}.

Parameters
Name Description
projectId string

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

The Region ID. Must not be null or empty.
resourcePolicyId string

The ResourcePolicy ID. Must not be null or empty.
Returns
Type Description
ResourcePolicyName

A new instance of ResourcePolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ResourcePolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ResourcePolicyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
resourcePolicyName string

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

The parsed ResourcePolicyName if successful.
Remarks

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

  • projects/{project}/regions/{region}/resourcePolicies/{resource_policy}
  • projects/{project}/locations/{location}/resourcePolicies/{resource_policy}

Parse(string, bool)

public static ResourcePolicyName Parse(string resourcePolicyName, bool allowUnparsed)

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

Parameters
Name Description
resourcePolicyName 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
ResourcePolicyName

The parsed ResourcePolicyName if successful.
Remarks

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

  • projects/{project}/regions/{region}/resourcePolicies/{resource_policy}
  • projects/{project}/locations/{location}/resourcePolicies/{resource_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 ResourcePolicyName)

public static bool TryParse(string resourcePolicyName, out ResourcePolicyName result)

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

Parameters
Name Description
resourcePolicyName string

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

When this method returns, the parsed ResourcePolicyName, 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}/regions/{region}/resourcePolicies/{resource_policy}
  • projects/{project}/locations/{location}/resourcePolicies/{resource_policy}

TryParse(string, bool, out ResourcePolicyName)

public static bool TryParse(string resourcePolicyName, bool allowUnparsed, out ResourcePolicyName result)

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

Parameters
Name Description
resourcePolicyName 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 ResourcePolicyName

When this method returns, the parsed ResourcePolicyName, 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}/regions/{region}/resourcePolicies/{resource_policy}
  • projects/{project}/locations/{location}/resourcePolicies/{resource_policy}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ResourcePolicyName, ResourcePolicyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ResourcePolicyName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ResourcePolicyName

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

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.