Assured Workloads v1 API - Class ViolationName (2.3.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

Implements

IResourceName, IEquatable<ViolationName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
`Boolean`

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
`ViolationName.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`

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
`Int32`

Overrides

Object.GetHashCode()

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

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`	`Boolean` 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

Object.ToString()

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
`Boolean`	`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, Boolean, 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`	`Boolean` 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
`Boolean`	`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

Equality(ViolationName, ViolationName)

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

Parameters
Name	Description
`a`	`ViolationName`
`b`	`ViolationName`

Returns
Type	Description
`Boolean`

Inequality(ViolationName, ViolationName)

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

Parameters
Name	Description
`a`	`ViolationName`
`b`	`ViolationName`

Returns
Type	Description
`Boolean`