Organization Policy v2 API - Class ConstraintName (2.8.0) 

public sealed class ConstraintName : IResourceName, IEquatable<ConstraintName>

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

Resource name for the Constraint resource.

Inheritance

object > ConstraintName

Namespace

Google.Cloud.OrgPolicy.V2

Assembly

Google.Cloud.OrgPolicy.V2.dll

Constructors

ConstraintName(string, string)

public ConstraintName(string projectId, string constraintId)

Constructs a new instance of a ConstraintName class from the component parts of pattern projects/{project}/constraints/{constraint}

Parameters
Name Description
projectId string

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

The Constraint ID. Must not be null or empty.

Properties

ConstraintId

public string ConstraintId { get; }

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

Property Value
Type Description
string

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

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 ConstraintName.ResourceNameType Type { get; }

The ConstraintName.ResourceNameType of the contained resource name.

Property Value
Type Description
ConstraintNameResourceNameType

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

Formats the IDs into the string representation of this ConstraintName with pattern projects/{project}/constraints/{constraint}.

Parameters
Name Description
projectId string

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

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

The string representation of this ConstraintName with pattern projects/{project}/constraints/{constraint}.

FormatFolderConstraint(string, string)

public static string FormatFolderConstraint(string folderId, string constraintId)

Formats the IDs into the string representation of this ConstraintName with pattern folders/{folder}/constraints/{constraint}.

Parameters
Name Description
folderId string

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

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

The string representation of this ConstraintName with pattern folders/{folder}/constraints/{constraint}.

FormatOrganizationConstraint(string, string)

public static string FormatOrganizationConstraint(string organizationId, string constraintId)

Formats the IDs into the string representation of this ConstraintName with pattern organizations/{organization}/constraints/{constraint}.

Parameters
Name Description
organizationId string

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

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

The string representation of this ConstraintName with pattern organizations/{organization}/constraints/{constraint}.

FormatProjectConstraint(string, string)

public static string FormatProjectConstraint(string projectId, string constraintId)

Formats the IDs into the string representation of this ConstraintName with pattern projects/{project}/constraints/{constraint}.

Parameters
Name Description
projectId string

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

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

The string representation of this ConstraintName with pattern projects/{project}/constraints/{constraint}.

FromFolderConstraint(string, string)

public static ConstraintName FromFolderConstraint(string folderId, string constraintId)

Creates a ConstraintName with the pattern folders/{folder}/constraints/{constraint}.

Parameters
Name Description
folderId string

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

The Constraint ID. Must not be null or empty.
Returns
Type Description
ConstraintName

A new instance of ConstraintName constructed from the provided ids.

FromOrganizationConstraint(string, string)

public static ConstraintName FromOrganizationConstraint(string organizationId, string constraintId)

Creates a ConstraintName with the pattern organizations/{organization}/constraints/{constraint}.

Parameters
Name Description
organizationId string

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

The Constraint ID. Must not be null or empty.
Returns
Type Description
ConstraintName

A new instance of ConstraintName constructed from the provided ids.

FromProjectConstraint(string, string)

public static ConstraintName FromProjectConstraint(string projectId, string constraintId)

Creates a ConstraintName with the pattern projects/{project}/constraints/{constraint}.

Parameters
Name Description
projectId string

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

The Constraint ID. Must not be null or empty.
Returns
Type Description
ConstraintName

A new instance of ConstraintName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ConstraintName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ConstraintName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
constraintName string

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

The parsed ConstraintName if successful.
Remarks

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

  • projects/{project}/constraints/{constraint}
  • folders/{folder}/constraints/{constraint}
  • organizations/{organization}/constraints/{constraint}

Parse(string, bool)

public static ConstraintName Parse(string constraintName, bool allowUnparsed)

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

Parameters
Name Description
constraintName 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
ConstraintName

The parsed ConstraintName if successful.
Remarks

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

  • projects/{project}/constraints/{constraint}
  • folders/{folder}/constraints/{constraint}
  • organizations/{organization}/constraints/{constraint}
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 ConstraintName)

public static bool TryParse(string constraintName, out ConstraintName result)

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

Parameters
Name Description
constraintName string

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

When this method returns, the parsed ConstraintName, 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}/constraints/{constraint}
  • folders/{folder}/constraints/{constraint}
  • organizations/{organization}/constraints/{constraint}

TryParse(string, bool, out ConstraintName)

public static bool TryParse(string constraintName, bool allowUnparsed, out ConstraintName result)

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

Parameters
Name Description
constraintName 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 ConstraintName

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

Operators

operator ==(ConstraintName, ConstraintName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ConstraintName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ConstraintName

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

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.