Assured Workloads v1 API - Class ViolationName (2.7.0) 

public sealed class ViolationName : IResourceName, IEquatable<ViolationName>

Reference documentation and code samples for the Assured Workloads v1 API class ViolationName.

Resource name for the Violation resource.

Inheritance

object > ViolationName

Namespace

Google.Cloud.AssuredWorkloads.V1

Assembly

Google.Cloud.AssuredWorkloads.V1.dll

Constructors

ViolationName(string, string, string, string)

public ViolationName(string organizationId, string locationId, string workloadId, string violationId)

Constructs a new instance of a ViolationName class from the component parts of pattern organizations/{organization}/locations/{location}/workloads/{workload}/violations/{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.
workloadId string

The Workload ID. Must not be null or empty.
violationId string

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

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

The ViolationName.ResourceNameType of the contained resource name.

Property Value
Type Description
ViolationNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

ViolationId

public string ViolationId { get; }

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

Property Value
Type Description
string

WorkloadId

public string WorkloadId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string, string)

public static string Format(string organizationId, string locationId, string workloadId, string violationId)

Formats the IDs into the string representation of this ViolationName with pattern organizations/{organization}/locations/{location}/workloads/{workload}/violations/{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.
workloadId string

The Workload ID. Must not be null or empty.
violationId string

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

The string representation of this ViolationName with pattern organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}.

FormatOrganizationLocationWorkloadViolation(string, string, string, string)

public static string FormatOrganizationLocationWorkloadViolation(string organizationId, string locationId, string workloadId, string violationId)

Formats the IDs into the string representation of this ViolationName with pattern organizations/{organization}/locations/{location}/workloads/{workload}/violations/{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.
workloadId string

The Workload ID. Must not be null or empty.
violationId string

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

The string representation of this ViolationName with pattern organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}.

FromOrganizationLocationWorkloadViolation(string, string, string, string)

public static ViolationName FromOrganizationLocationWorkloadViolation(string organizationId, string locationId, string workloadId, string violationId)

Creates a ViolationName with the pattern organizations/{organization}/locations/{location}/workloads/{workload}/violations/{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.
workloadId string

The Workload ID. Must not be null or empty.
violationId string

The Violation ID. Must not be null or empty.
Returns
Type Description
ViolationName

A new instance of ViolationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ViolationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ViolationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
violationName string

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

The parsed ViolationName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}

Parse(string, bool)

public static ViolationName Parse(string violationName, bool allowUnparsed)

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

Parameters
Name Description
violationName 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
ViolationName

The parsed ViolationName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/workloads/{workload}/violations/{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 ViolationName)

public static bool TryParse(string violationName, out ViolationName result)

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

Parameters
Name Description
violationName string

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

When this method returns, the parsed ViolationName, 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}/workloads/{workload}/violations/{violation}

TryParse(string, bool, out ViolationName)

public static bool TryParse(string violationName, bool allowUnparsed, out ViolationName result)

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

Parameters
Name Description
violationName 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 ViolationName

When this method returns, the parsed ViolationName, 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}/workloads/{workload}/violations/{violation}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ViolationName, ViolationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ViolationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ViolationName

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

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.