App Hub v1 API - Class DiscoveredWorkloadName (1.2.0) 

public sealed class DiscoveredWorkloadName : IResourceName, IEquatable<DiscoveredWorkloadName>

Reference documentation and code samples for the App Hub v1 API class DiscoveredWorkloadName.

Resource name for the DiscoveredWorkload resource.

Inheritance

object > DiscoveredWorkloadName

Namespace

Google.Cloud.AppHub.V1

Assembly

Google.Cloud.AppHub.V1.dll

Constructors

DiscoveredWorkloadName(string, string, string)

public DiscoveredWorkloadName(string projectId, string locationId, string discoveredWorkloadId)

Constructs a new instance of a DiscoveredWorkloadName class from the component parts of pattern projects/{project}/locations/{location}/discoveredWorkloads/{discovered_workload}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
discoveredWorkloadId string

The DiscoveredWorkload ID. Must not be null or empty.

Properties

DiscoveredWorkloadId

public string DiscoveredWorkloadId { get; }

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

ProjectId

public string ProjectId { get; }

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

Property Value
Type Description
string

Type

public DiscoveredWorkloadName.ResourceNameType Type { get; }

The DiscoveredWorkloadName.ResourceNameType of the contained resource name.

Property Value
Type Description
DiscoveredWorkloadNameResourceNameType

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 projectId, string locationId, string discoveredWorkloadId)

Formats the IDs into the string representation of this DiscoveredWorkloadName with pattern projects/{project}/locations/{location}/discoveredWorkloads/{discovered_workload}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
discoveredWorkloadId string

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

The string representation of this DiscoveredWorkloadName with pattern projects/{project}/locations/{location}/discoveredWorkloads/{discovered_workload}.

FormatProjectLocationDiscoveredWorkload(string, string, string)

public static string FormatProjectLocationDiscoveredWorkload(string projectId, string locationId, string discoveredWorkloadId)

Formats the IDs into the string representation of this DiscoveredWorkloadName with pattern projects/{project}/locations/{location}/discoveredWorkloads/{discovered_workload}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
discoveredWorkloadId string

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

The string representation of this DiscoveredWorkloadName with pattern projects/{project}/locations/{location}/discoveredWorkloads/{discovered_workload}.

FromProjectLocationDiscoveredWorkload(string, string, string)

public static DiscoveredWorkloadName FromProjectLocationDiscoveredWorkload(string projectId, string locationId, string discoveredWorkloadId)

Creates a DiscoveredWorkloadName with the pattern projects/{project}/locations/{location}/discoveredWorkloads/{discovered_workload}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
discoveredWorkloadId string

The DiscoveredWorkload ID. Must not be null or empty.
Returns
Type Description
DiscoveredWorkloadName

A new instance of DiscoveredWorkloadName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DiscoveredWorkloadName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DiscoveredWorkloadName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
discoveredWorkloadName string

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

The parsed DiscoveredWorkloadName if successful.
Remarks

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

  • projects/{project}/locations/{location}/discoveredWorkloads/{discovered_workload}

Parse(string, bool)

public static DiscoveredWorkloadName Parse(string discoveredWorkloadName, bool allowUnparsed)

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

Parameters
Name Description
discoveredWorkloadName 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
DiscoveredWorkloadName

The parsed DiscoveredWorkloadName if successful.
Remarks

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

  • projects/{project}/locations/{location}/discoveredWorkloads/{discovered_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

TryParse(string, out DiscoveredWorkloadName)

public static bool TryParse(string discoveredWorkloadName, out DiscoveredWorkloadName result)

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

Parameters
Name Description
discoveredWorkloadName string

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

When this method returns, the parsed DiscoveredWorkloadName, 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:

  • projects/{project}/locations/{location}/discoveredWorkloads/{discovered_workload}

TryParse(string, bool, out DiscoveredWorkloadName)

public static bool TryParse(string discoveredWorkloadName, bool allowUnparsed, out DiscoveredWorkloadName result)

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

Parameters
Name Description
discoveredWorkloadName 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 DiscoveredWorkloadName

When this method returns, the parsed DiscoveredWorkloadName, 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:

  • projects/{project}/locations/{location}/discoveredWorkloads/{discovered_workload}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DiscoveredWorkloadName, DiscoveredWorkloadName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DiscoveredWorkloadName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DiscoveredWorkloadName

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

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.