Policy Simulator v1 API - Class OrgPolicyViolationName (1.3.0) 

public sealed class OrgPolicyViolationName : IResourceName, IEquatable<OrgPolicyViolationName>

Reference documentation and code samples for the Policy Simulator v1 API class OrgPolicyViolationName.

Resource name for the OrgPolicyViolation resource.

Inheritance

object > OrgPolicyViolationName

Namespace

Google.Cloud.PolicySimulator.V1

Assembly

Google.Cloud.PolicySimulator.V1.dll

Constructors

OrgPolicyViolationName(string, string, string, string)

public OrgPolicyViolationName(string organizationId, string locationId, string orgPolicyViolationsPreviewId, string orgPolicyViolationId)

Constructs a new instance of a OrgPolicyViolationName class from the component parts of pattern organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{org_policy_violations_preview}/orgPolicyViolations/{org_policy_violation}

Parameters
Name Description
organizationId string

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

The Location ID. Must not be null or empty.
orgPolicyViolationsPreviewId string

The OrgPolicyViolationsPreview ID. Must not be null or empty.
orgPolicyViolationId string

The OrgPolicyViolation ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

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

Property Value
Type Description
string

OrgPolicyViolationId

public string OrgPolicyViolationId { get; }

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

Property Value
Type Description
string

OrgPolicyViolationsPreviewId

public string OrgPolicyViolationsPreviewId { get; }

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

Property Value
Type Description
string

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

The OrgPolicyViolationName.ResourceNameType of the contained resource name.

Property Value
Type Description
OrgPolicyViolationNameResourceNameType

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

public static string Format(string organizationId, string locationId, string orgPolicyViolationsPreviewId, string orgPolicyViolationId)

Formats the IDs into the string representation of this OrgPolicyViolationName with pattern organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{org_policy_violations_preview}/orgPolicyViolations/{org_policy_violation} .

Parameters
Name Description
organizationId string

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

The Location ID. Must not be null or empty.
orgPolicyViolationsPreviewId string

The OrgPolicyViolationsPreview ID. Must not be null or empty.
orgPolicyViolationId string

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

The string representation of this OrgPolicyViolationName with pattern organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{org_policy_violations_preview}/orgPolicyViolations/{org_policy_violation} .

FormatOrganizationLocationOrgPolicyViolationsPreviewOrgPolicyViolation(string, string, string, string)

public static string FormatOrganizationLocationOrgPolicyViolationsPreviewOrgPolicyViolation(string organizationId, string locationId, string orgPolicyViolationsPreviewId, string orgPolicyViolationId)

Formats the IDs into the string representation of this OrgPolicyViolationName with pattern organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{org_policy_violations_preview}/orgPolicyViolations/{org_policy_violation} .

Parameters
Name Description
organizationId string

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

The Location ID. Must not be null or empty.
orgPolicyViolationsPreviewId string

The OrgPolicyViolationsPreview ID. Must not be null or empty.
orgPolicyViolationId string

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

The string representation of this OrgPolicyViolationName with pattern organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{org_policy_violations_preview}/orgPolicyViolations/{org_policy_violation} .

FromOrganizationLocationOrgPolicyViolationsPreviewOrgPolicyViolation(string, string, string, string)

public static OrgPolicyViolationName FromOrganizationLocationOrgPolicyViolationsPreviewOrgPolicyViolation(string organizationId, string locationId, string orgPolicyViolationsPreviewId, string orgPolicyViolationId)

Creates a OrgPolicyViolationName with the pattern organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{org_policy_violations_preview}/orgPolicyViolations/{org_policy_violation} .

Parameters
Name Description
organizationId string

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

The Location ID. Must not be null or empty.
orgPolicyViolationsPreviewId string

The OrgPolicyViolationsPreview ID. Must not be null or empty.
orgPolicyViolationId string

The OrgPolicyViolation ID. Must not be null or empty.
Returns
Type Description
OrgPolicyViolationName

A new instance of OrgPolicyViolationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static OrgPolicyViolationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OrgPolicyViolationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
orgPolicyViolationName string

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

The parsed OrgPolicyViolationName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{org_policy_violations_preview}/orgPolicyViolations/{org_policy_violation}

Parse(string, bool)

public static OrgPolicyViolationName Parse(string orgPolicyViolationName, bool allowUnparsed)

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

Parameters
Name Description
orgPolicyViolationName 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
OrgPolicyViolationName

The parsed OrgPolicyViolationName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{org_policy_violations_preview}/orgPolicyViolations/{org_policy_violation}
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 OrgPolicyViolationName)

public static bool TryParse(string orgPolicyViolationName, out OrgPolicyViolationName result)

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

Parameters
Name Description
orgPolicyViolationName string

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

When this method returns, the parsed OrgPolicyViolationName, 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}/locations/{location}/orgPolicyViolationsPreviews/{org_policy_violations_preview}/orgPolicyViolations/{org_policy_violation}

TryParse(string, bool, out OrgPolicyViolationName)

public static bool TryParse(string orgPolicyViolationName, bool allowUnparsed, out OrgPolicyViolationName result)

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

Parameters
Name Description
orgPolicyViolationName 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 OrgPolicyViolationName

When this method returns, the parsed OrgPolicyViolationName, 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}/locations/{location}/orgPolicyViolationsPreviews/{org_policy_violations_preview}/orgPolicyViolations/{org_policy_violation}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(OrgPolicyViolationName, OrgPolicyViolationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a OrgPolicyViolationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a OrgPolicyViolationName

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

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.