App Hub v1 API - Class DiscoveredServiceName (1.0.0-beta02) 

public sealed class DiscoveredServiceName : IResourceName, IEquatable<DiscoveredServiceName>

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

Resource name for the DiscoveredService resource.

Inheritance

object > DiscoveredServiceName

Namespace

Google.Cloud.AppHub.V1

Assembly

Google.Cloud.AppHub.V1.dll

Constructors

DiscoveredServiceName(string, string, string)

public DiscoveredServiceName(string projectId, string locationId, string discoveredServiceId)

Constructs a new instance of a DiscoveredServiceName class from the component parts of pattern projects/{project}/locations/{location}/discoveredServices/{discovered_service}

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.
discoveredServiceId string

The DiscoveredService ID. Must not be null or empty.

Properties

DiscoveredServiceId

public string DiscoveredServiceId { get; }

The DiscoveredService 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 DiscoveredServiceName.ResourceNameType Type { get; }

The DiscoveredServiceName.ResourceNameType of the contained resource name.

Property Value
Type Description
DiscoveredServiceNameResourceNameType

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

Formats the IDs into the string representation of this DiscoveredServiceName with pattern projects/{project}/locations/{location}/discoveredServices/{discovered_service}.

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.
discoveredServiceId string

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

The string representation of this DiscoveredServiceName with pattern projects/{project}/locations/{location}/discoveredServices/{discovered_service}.

FormatProjectLocationDiscoveredService(string, string, string)

public static string FormatProjectLocationDiscoveredService(string projectId, string locationId, string discoveredServiceId)

Formats the IDs into the string representation of this DiscoveredServiceName with pattern projects/{project}/locations/{location}/discoveredServices/{discovered_service}.

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.
discoveredServiceId string

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

The string representation of this DiscoveredServiceName with pattern projects/{project}/locations/{location}/discoveredServices/{discovered_service}.

FromProjectLocationDiscoveredService(string, string, string)

public static DiscoveredServiceName FromProjectLocationDiscoveredService(string projectId, string locationId, string discoveredServiceId)

Creates a DiscoveredServiceName with the pattern projects/{project}/locations/{location}/discoveredServices/{discovered_service}.

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.
discoveredServiceId string

The DiscoveredService ID. Must not be null or empty.
Returns
Type Description
DiscoveredServiceName

A new instance of DiscoveredServiceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DiscoveredServiceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DiscoveredServiceName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
discoveredServiceName string

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

The parsed DiscoveredServiceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/discoveredServices/{discovered_service}

Parse(string, bool)

public static DiscoveredServiceName Parse(string discoveredServiceName, bool allowUnparsed)

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

Parameters
Name Description
discoveredServiceName 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
DiscoveredServiceName

The parsed DiscoveredServiceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/discoveredServices/{discovered_service}
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 DiscoveredServiceName)

public static bool TryParse(string discoveredServiceName, out DiscoveredServiceName result)

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

Parameters
Name Description
discoveredServiceName string

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

When this method returns, the parsed DiscoveredServiceName, 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}/discoveredServices/{discovered_service}

TryParse(string, bool, out DiscoveredServiceName)

public static bool TryParse(string discoveredServiceName, bool allowUnparsed, out DiscoveredServiceName result)

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

Parameters
Name Description
discoveredServiceName 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 DiscoveredServiceName

When this method returns, the parsed DiscoveredServiceName, 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}/discoveredServices/{discovered_service}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DiscoveredServiceName, DiscoveredServiceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DiscoveredServiceName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DiscoveredServiceName

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

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.