Organization Policy v2 API - Class PolicyName (2.6.0) 

public sealed class PolicyName : IResourceName, IEquatable<PolicyName>

Reference documentation and code samples for the Organization Policy v2 API class PolicyName.

Resource name for the Policy resource.

Inheritance

object > PolicyName

Namespace

Google.Cloud.OrgPolicy.V2

Assembly

Google.Cloud.OrgPolicy.V2.dll

Constructors

PolicyName(string, string)

public PolicyName(string projectId, string policyId)

Constructs a new instance of a PolicyName class from the component parts of pattern projects/{project}/policies/{policy}

Parameters
Name Description
projectId string

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

The Policy ID. Must not be null or empty.

Properties

FolderId

public string FolderId { get; }

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

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

OrganizationId

public string OrganizationId { get; }

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

Property Value
Type Description
string

PolicyId

public string PolicyId { get; }

The Policy 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

Type

public PolicyName.ResourceNameType Type { get; }

The PolicyName.ResourceNameType of the contained resource name.

Property Value
Type Description
PolicyNameResourceNameType

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)

public static string Format(string projectId, string policyId)

Formats the IDs into the string representation of this PolicyName with pattern projects/{project}/policies/{policy}.

Parameters
Name Description
projectId string

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

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

The string representation of this PolicyName with pattern projects/{project}/policies/{policy}.

FormatFolderPolicy(string, string)

public static string FormatFolderPolicy(string folderId, string policyId)

Formats the IDs into the string representation of this PolicyName with pattern folders/{folder}/policies/{policy}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
policyId string

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

The string representation of this PolicyName with pattern folders/{folder}/policies/{policy}.

FormatOrganizationPolicy(string, string)

public static string FormatOrganizationPolicy(string organizationId, string policyId)

Formats the IDs into the string representation of this PolicyName with pattern organizations/{organization}/policies/{policy}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
policyId string

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

The string representation of this PolicyName with pattern organizations/{organization}/policies/{policy}.

FormatProjectPolicy(string, string)

public static string FormatProjectPolicy(string projectId, string policyId)

Formats the IDs into the string representation of this PolicyName with pattern projects/{project}/policies/{policy}.

Parameters
Name Description
projectId string

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

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

The string representation of this PolicyName with pattern projects/{project}/policies/{policy}.

FromFolderPolicy(string, string)

public static PolicyName FromFolderPolicy(string folderId, string policyId)

Creates a PolicyName with the pattern folders/{folder}/policies/{policy}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
policyId string

The Policy ID. Must not be null or empty.
Returns
Type Description
PolicyName

A new instance of PolicyName constructed from the provided ids.

FromOrganizationPolicy(string, string)

public static PolicyName FromOrganizationPolicy(string organizationId, string policyId)

Creates a PolicyName with the pattern organizations/{organization}/policies/{policy}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
policyId string

The Policy ID. Must not be null or empty.
Returns
Type Description
PolicyName

A new instance of PolicyName constructed from the provided ids.

FromProjectPolicy(string, string)

public static PolicyName FromProjectPolicy(string projectId, string policyId)

Creates a PolicyName with the pattern projects/{project}/policies/{policy}.

Parameters
Name Description
projectId string

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

The Policy ID. Must not be null or empty.
Returns
Type Description
PolicyName

A new instance of PolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PolicyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
policyName string

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

The parsed PolicyName if successful.
Remarks

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

  • projects/{project}/policies/{policy}
  • folders/{folder}/policies/{policy}
  • organizations/{organization}/policies/{policy}

Parse(string, bool)

public static PolicyName Parse(string policyName, bool allowUnparsed)

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

Parameters
Name Description
policyName 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
PolicyName

The parsed PolicyName if successful.
Remarks

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

  • projects/{project}/policies/{policy}
  • folders/{folder}/policies/{policy}
  • organizations/{organization}/policies/{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 PolicyName)

public static bool TryParse(string policyName, out PolicyName result)

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

Parameters
Name Description
policyName string

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

When this method returns, the parsed PolicyName, 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}/policies/{policy}
  • folders/{folder}/policies/{policy}
  • organizations/{organization}/policies/{policy}

TryParse(string, bool, out PolicyName)

public static bool TryParse(string policyName, bool allowUnparsed, out PolicyName result)

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

Parameters
Name Description
policyName 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 PolicyName

When this method returns, the parsed PolicyName, 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}/policies/{policy}
  • folders/{folder}/policies/{policy}
  • organizations/{organization}/policies/{policy}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(PolicyName, PolicyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a PolicyName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a PolicyName

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

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.