Cloud Controls Partner v1 API - Class WorkloadName (1.1.0)

public sealed class WorkloadName : IResourceName, IEquatable<WorkloadName>

Reference documentation and code samples for the Cloud Controls Partner v1 API class WorkloadName.

Resource name for the Workload resource.

Inheritance

object > WorkloadName

Implements

IResourceName, IEquatable WorkloadName

Inherited Members

object.GetType()

Namespace

Google.Cloud.CloudControlsPartner.V1

Assembly

Google.Cloud.CloudControlsPartner.V1.dll

Constructors

WorkloadName(string, string, string, string)

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

Constructs a new instance of a WorkloadName class from the component parts of pattern organizations/{organization}/locations/{location}/customers/{customer}/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.
`customerId`	`string` The `Customer` ID. Must not be `null` or empty.
`workloadId`	`string` The `Workload` ID. Must not be `null` or empty.

Properties

CustomerId

public string CustomerId { get; }

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

Property Value
Type	Description
`string`

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

The WorkloadName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`WorkloadNameResourceNameType`

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

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

Formats the IDs into the string representation of this WorkloadName with pattern organizations/{organization}/locations/{location}/customers/{customer}/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.
`customerId`	`string` The `Customer` 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}/customers/{customer}/workloads/{workload}`.

FormatOrganizationLocationCustomerWorkload(string, string, string, string)

public static string FormatOrganizationLocationCustomerWorkload(string organizationId, string locationId, string customerId, string workloadId)

Formats the IDs into the string representation of this WorkloadName with pattern organizations/{organization}/locations/{location}/customers/{customer}/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.
`customerId`	`string` The `Customer` 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}/customers/{customer}/workloads/{workload}`.

FromOrganizationLocationCustomerWorkload(string, string, string, string)

public static WorkloadName FromOrganizationLocationCustomerWorkload(string organizationId, string locationId, string customerId, string workloadId)

Creates a WorkloadName with the pattern organizations/{organization}/locations/{location}/customers/{customer}/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.
`customerId`	`string` The `Customer` 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
`int`

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}/customers/{customer}/workloads/{workload}

Parse(string, bool)

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`	`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
`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}/customers/{customer}/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
`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}/customers/{customer}/workloads/{workload}

TryParse(string, bool, 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`	`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`	`WorkloadName` When this method returns, the parsed WorkloadName, 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}/customers/{customer}/workloads/{workload}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(WorkloadName, WorkloadName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`WorkloadName` The first resource name to compare, or null.
`b`	`WorkloadName` 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 !=(WorkloadName, WorkloadName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`WorkloadName` The first resource name to compare, or null.
`b`	`WorkloadName` 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.