Organization Policy v2 API - Class PolicyName (2.1.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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

policyIdString

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
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

OrganizationId

public string OrganizationId { get; }

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

Property Value
TypeDescription
String

PolicyId

public string PolicyId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public PolicyName.ResourceNameType Type { get; }

The PolicyName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
PolicyName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

policyIdString

The Policy ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
folderIdString

The Folder ID. Must not be null or empty.

policyIdString

The Policy ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

policyIdString

The Policy ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

policyIdString

The Policy ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
folderIdString

The Folder ID. Must not be null or empty.

policyIdString

The Policy ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

policyIdString

The Policy ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

policyIdString

The Policy ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
PolicyName

A new instance of PolicyName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
System.Int32
Overrides

Parse(String)

public static PolicyName Parse(string policyName)

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

Parameter
NameDescription
policyNameString

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

Returns
TypeDescription
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, Boolean)

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
NameDescription
policyNameString

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

allowUnparsedBoolean

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

Returns
TypeDescription
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
TypeDescription
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
NameDescription
policyNameString

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

resultPolicyName

When this method returns, the parsed PolicyName, or null if parsing failed.

Returns
TypeDescription
Boolean

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, Boolean, 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
NameDescription
policyNameString

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

allowUnparsedBoolean

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

resultPolicyName

When this method returns, the parsed PolicyName, or null if parsing failed.

Returns
TypeDescription
Boolean

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

Equality(PolicyName, PolicyName)

public static bool operator ==(PolicyName a, PolicyName b)
Parameters
NameDescription
aPolicyName
bPolicyName
Returns
TypeDescription
Boolean

Inequality(PolicyName, PolicyName)

public static bool operator !=(PolicyName a, PolicyName b)
Parameters
NameDescription
aPolicyName
bPolicyName
Returns
TypeDescription
Boolean