Organization Policy v2 API - Class CustomConstraintName (2.8.0) 

public sealed class CustomConstraintName : IResourceName, IEquatable<CustomConstraintName>

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

Resource name for the CustomConstraint resource.

Inheritance

object > CustomConstraintName

Namespace

Google.Cloud.OrgPolicy.V2

Assembly

Google.Cloud.OrgPolicy.V2.dll

Constructors

CustomConstraintName(string, string)

public CustomConstraintName(string organizationId, string customConstraintId)

Constructs a new instance of a CustomConstraintName class from the component parts of pattern organizations/{organization}/customConstraints/{custom_constraint}

Parameters
Name Description
organizationId string

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

The CustomConstraint ID. Must not be null or empty.

Properties

CustomConstraintId

public string CustomConstraintId { get; }

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

OrganizationId

public string OrganizationId { get; }

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

Property Value
Type Description
string

Type

public CustomConstraintName.ResourceNameType Type { get; }

The CustomConstraintName.ResourceNameType of the contained resource name.

Property Value
Type Description
CustomConstraintNameResourceNameType

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 organizationId, string customConstraintId)

Formats the IDs into the string representation of this CustomConstraintName with pattern organizations/{organization}/customConstraints/{custom_constraint}.

Parameters
Name Description
organizationId string

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

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

The string representation of this CustomConstraintName with pattern organizations/{organization}/customConstraints/{custom_constraint}.

FormatOrganizationCustomConstraint(string, string)

public static string FormatOrganizationCustomConstraint(string organizationId, string customConstraintId)

Formats the IDs into the string representation of this CustomConstraintName with pattern organizations/{organization}/customConstraints/{custom_constraint}.

Parameters
Name Description
organizationId string

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

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

The string representation of this CustomConstraintName with pattern organizations/{organization}/customConstraints/{custom_constraint}.

FromOrganizationCustomConstraint(string, string)

public static CustomConstraintName FromOrganizationCustomConstraint(string organizationId, string customConstraintId)

Creates a CustomConstraintName with the pattern organizations/{organization}/customConstraints/{custom_constraint}.

Parameters
Name Description
organizationId string

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

The CustomConstraint ID. Must not be null or empty.
Returns
Type Description
CustomConstraintName

A new instance of CustomConstraintName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CustomConstraintName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CustomConstraintName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
customConstraintName string

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

The parsed CustomConstraintName if successful.
Remarks

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

  • organizations/{organization}/customConstraints/{custom_constraint}

Parse(string, bool)

public static CustomConstraintName Parse(string customConstraintName, bool allowUnparsed)

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

Parameters
Name Description
customConstraintName 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
CustomConstraintName

The parsed CustomConstraintName if successful.
Remarks

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

  • organizations/{organization}/customConstraints/{custom_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 CustomConstraintName)

public static bool TryParse(string customConstraintName, out CustomConstraintName result)

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

Parameters
Name Description
customConstraintName string

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

When this method returns, the parsed CustomConstraintName, 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:

  • organizations/{organization}/customConstraints/{custom_constraint}

TryParse(string, bool, out CustomConstraintName)

public static bool TryParse(string customConstraintName, bool allowUnparsed, out CustomConstraintName result)

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

Parameters
Name Description
customConstraintName 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 CustomConstraintName

When this method returns, the parsed CustomConstraintName, 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:

  • organizations/{organization}/customConstraints/{custom_constraint}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(CustomConstraintName, CustomConstraintName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CustomConstraintName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CustomConstraintName

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

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.