Policy Simulator v1 API - Class OrgPolicyViolationsPreviewName (1.3.0)

public sealed class OrgPolicyViolationsPreviewName : IResourceName, IEquatable<OrgPolicyViolationsPreviewName>

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

Resource name for the OrgPolicyViolationsPreview resource.

Inheritance

object > OrgPolicyViolationsPreviewName

Namespace

Google.Cloud.PolicySimulator.V1

Assembly

Google.Cloud.PolicySimulator.V1.dll

Constructors

OrgPolicyViolationsPreviewName(string, string, string)

public OrgPolicyViolationsPreviewName(string organizationId, string locationId, string orgPolicyViolationsPreviewId)

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

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.

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

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

The OrgPolicyViolationsPreviewName.ResourceNameType of the contained resource name.

Property Value
Type Description
OrgPolicyViolationsPreviewNameResourceNameType

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)

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

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

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.

Returns
Type Description
string

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

FormatOrganizationLocationOrgPolicyViolationsPreview(string, string, string)

public static string FormatOrganizationLocationOrgPolicyViolationsPreview(string organizationId, string locationId, string orgPolicyViolationsPreviewId)

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

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.

Returns
Type Description
string

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

FromOrganizationLocationOrgPolicyViolationsPreview(string, string, string)

public static OrgPolicyViolationsPreviewName FromOrganizationLocationOrgPolicyViolationsPreview(string organizationId, string locationId, string orgPolicyViolationsPreviewId)

Creates a OrgPolicyViolationsPreviewName with the pattern organizations/{organization}/locations/{location}/orgPolicyViolationsPreviews/{org_policy_violations_preview} .

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.

Returns
Type Description
OrgPolicyViolationsPreviewName

A new instance of OrgPolicyViolationsPreviewName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static OrgPolicyViolationsPreviewName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OrgPolicyViolationsPreviewName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
OrgPolicyViolationsPreviewName

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

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

Parameter
Name Description
orgPolicyViolationsPreviewName string

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

Returns
Type Description
OrgPolicyViolationsPreviewName

The parsed OrgPolicyViolationsPreviewName 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}

Parse(string, bool)

public static OrgPolicyViolationsPreviewName Parse(string orgPolicyViolationsPreviewName, bool allowUnparsed)

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

Parameters
Name Description
orgPolicyViolationsPreviewName 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
OrgPolicyViolationsPreviewName

The parsed OrgPolicyViolationsPreviewName 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}
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 OrgPolicyViolationsPreviewName)

public static bool TryParse(string orgPolicyViolationsPreviewName, out OrgPolicyViolationsPreviewName result)

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

Parameters
Name Description
orgPolicyViolationsPreviewName string

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

result OrgPolicyViolationsPreviewName

When this method returns, the parsed OrgPolicyViolationsPreviewName, 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}

TryParse(string, bool, out OrgPolicyViolationsPreviewName)

public static bool TryParse(string orgPolicyViolationsPreviewName, bool allowUnparsed, out OrgPolicyViolationsPreviewName result)

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

Parameters
Name Description
orgPolicyViolationsPreviewName 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 OrgPolicyViolationsPreviewName

When this method returns, the parsed OrgPolicyViolationsPreviewName, 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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(OrgPolicyViolationsPreviewName, OrgPolicyViolationsPreviewName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a OrgPolicyViolationsPreviewName

The first resource name to compare, or null.

b OrgPolicyViolationsPreviewName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a OrgPolicyViolationsPreviewName

The first resource name to compare, or null.

b OrgPolicyViolationsPreviewName

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.