public sealed class ConstraintName : IResourceName, IEquatable<ConstraintName>
Resource name for the Constraint
resource.
Namespace
Google.Cloud.OrgPolicy.V2Assembly
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 |
constraintId | String The |
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 |
Boolean |
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 |
ConstraintName.ResourceNameType |
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 |
constraintId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this ConstraintName with pattern
|
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 |
constraintId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this ConstraintName with pattern
|
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 |
constraintId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this ConstraintName with pattern
|
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 |
constraintId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this ConstraintName with pattern
|
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 |
constraintId | String The |
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 |
constraintId | String The |
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 |
constraintId | String The |
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 |
Returns | |
---|---|
Type | Description |
ConstraintName | A new instance of ConstraintName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
Int32 |
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 |
Returns | |
---|---|
Type | Description |
ConstraintName | The parsed ConstraintName if successful. |
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, Boolean)
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 |
allowUnparsed | Boolean If |
Returns | |
---|---|
Type | Description |
ConstraintName | The parsed ConstraintName if successful. |
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}
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. |
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 |
result | ConstraintName When this method returns, the parsed ConstraintName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
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, Boolean, 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 |
allowUnparsed | Boolean If |
result | ConstraintName When this method returns, the parsed ConstraintName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
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}
allowUnparsed
is true
.
Operators
Equality(ConstraintName, ConstraintName)
public static bool operator ==(ConstraintName a, ConstraintName b)
Parameters | |
---|---|
Name | Description |
a | ConstraintName |
b | ConstraintName |
Returns | |
---|---|
Type | Description |
Boolean |
Inequality(ConstraintName, ConstraintName)
public static bool operator !=(ConstraintName a, ConstraintName b)
Parameters | |
---|---|
Name | Description |
a | ConstraintName |
b | ConstraintName |
Returns | |
---|---|
Type | Description |
Boolean |