Assured Workloads v1beta1 API - Class WorkloadName (2.0.0-beta05)

public sealed class WorkloadName : IResourceName, IEquatable<WorkloadName>

Reference documentation and code samples for the Assured Workloads v1beta1 API class WorkloadName.

Resource name for the Workload resource.

Inheritance

Object > WorkloadName

Implements

IResourceName, IEquatable<WorkloadName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.AssuredWorkloads.V1Beta1

Assembly

Google.Cloud.AssuredWorkloads.V1Beta1.dll

Constructors

WorkloadName(String, String, String)

public WorkloadName(string organizationId, string locationId, string workloadId)

Constructs a new instance of a WorkloadName class from the component parts of pattern organizations/{organization}/locations/{location}/workloads/{workload}

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.

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

The WorkloadName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`WorkloadName.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`

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)

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

Formats the IDs into the string representation of this WorkloadName with pattern organizations/{organization}/locations/{location}/workloads/{workload}.

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.

Returns
Type	Description
`String`	The string representation of this WorkloadName with pattern `organizations/{organization}/locations/{location}/workloads/{workload}`.

FormatOrganizationLocationWorkload(String, String, String)

public static string FormatOrganizationLocationWorkload(string organizationId, string locationId, string workloadId)

Formats the IDs into the string representation of this WorkloadName with pattern organizations/{organization}/locations/{location}/workloads/{workload}.

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.

Returns
Type	Description
`String`	The string representation of this WorkloadName with pattern `organizations/{organization}/locations/{location}/workloads/{workload}`.

FromOrganizationLocationWorkload(String, String, String)

public static WorkloadName FromOrganizationLocationWorkload(string organizationId, string locationId, string workloadId)

Creates a WorkloadName with the pattern organizations/{organization}/locations/{location}/workloads/{workload}.

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.

Returns
Type	Description
`WorkloadName`	A new instance of WorkloadName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static WorkloadName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a WorkloadName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`WorkloadName`	A new instance of WorkloadName 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 WorkloadName Parse(string workloadName)

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

Parameter
Name	Description
`workloadName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`WorkloadName`	The parsed WorkloadName if successful.

Remarks

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

organizations/{organization}/locations/{location}/workloads/{workload}

Parse(String, Boolean)

public static WorkloadName Parse(string workloadName, bool allowUnparsed)

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

Parameters
Name	Description
`workloadName`	`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
`WorkloadName`	The parsed WorkloadName if successful.

Remarks

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

organizations/{organization}/locations/{location}/workloads/{workload}

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 WorkloadName)

public static bool TryParse(string workloadName, out WorkloadName result)

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

Parameters
Name	Description
`workloadName`	`String` The resource name in string form. Must not be `null`.
`result`	`WorkloadName` When this method returns, the parsed WorkloadName, 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}

TryParse(String, Boolean, out WorkloadName)

public static bool TryParse(string workloadName, bool allowUnparsed, out WorkloadName result)

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

Parameters
Name	Description
`workloadName`	`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`	`WorkloadName` When this method returns, the parsed WorkloadName, 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}

Or may be in any format if allowUnparsed is true.

Operators

Equality(WorkloadName, WorkloadName)

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

Parameters
Name	Description
`a`	`WorkloadName`
`b`	`WorkloadName`

Returns
Type	Description
`Boolean`

Inequality(WorkloadName, WorkloadName)

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

Parameters
Name	Description
`a`	`WorkloadName`
`b`	`WorkloadName`

Returns
Type	Description
`Boolean`