API hub v1 API - Class DiscoveredApiObservationName (1.1.0) 

public sealed class DiscoveredApiObservationName : IResourceName, IEquatable<DiscoveredApiObservationName>

Reference documentation and code samples for the API hub v1 API class DiscoveredApiObservationName.

Resource name for the DiscoveredApiObservation resource.

Inheritance

object > DiscoveredApiObservationName

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

DiscoveredApiObservationName(string, string, string)

public DiscoveredApiObservationName(string projectId, string locationId, string discoveredApiObservationId)

Constructs a new instance of a DiscoveredApiObservationName class from the component parts of pattern projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}

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

The DiscoveredApiObservation ID. Must not be null or empty.

Properties

DiscoveredApiObservationId

public string DiscoveredApiObservationId { get; }

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

The DiscoveredApiObservationName.ResourceNameType of the contained resource name.

Property Value
Type Description
DiscoveredApiObservationNameResourceNameType

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

Formats the IDs into the string representation of this DiscoveredApiObservationName with pattern projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation} .

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

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

The string representation of this DiscoveredApiObservationName with pattern projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}.

FormatProjectLocationDiscoveredApiObservation(string, string, string)

public static string FormatProjectLocationDiscoveredApiObservation(string projectId, string locationId, string discoveredApiObservationId)

Formats the IDs into the string representation of this DiscoveredApiObservationName with pattern projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation} .

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

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

The string representation of this DiscoveredApiObservationName with pattern projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}.

FromProjectLocationDiscoveredApiObservation(string, string, string)

public static DiscoveredApiObservationName FromProjectLocationDiscoveredApiObservation(string projectId, string locationId, string discoveredApiObservationId)

Creates a DiscoveredApiObservationName with the pattern projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}.

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

The DiscoveredApiObservation ID. Must not be null or empty.
Returns
Type Description
DiscoveredApiObservationName

A new instance of DiscoveredApiObservationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DiscoveredApiObservationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DiscoveredApiObservationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
discoveredApiObservationName string

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

The parsed DiscoveredApiObservationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}

Parse(string, bool)

public static DiscoveredApiObservationName Parse(string discoveredApiObservationName, bool allowUnparsed)

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

Parameters
Name Description
discoveredApiObservationName 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
DiscoveredApiObservationName

The parsed DiscoveredApiObservationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/discoveredApiObservations/{discovered_api_observation}
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 DiscoveredApiObservationName)

public static bool TryParse(string discoveredApiObservationName, out DiscoveredApiObservationName result)

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

Parameters
Name Description
discoveredApiObservationName string

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

When this method returns, the parsed DiscoveredApiObservationName, 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}/discoveredApiObservations/{discovered_api_observation}

TryParse(string, bool, out DiscoveredApiObservationName)

public static bool TryParse(string discoveredApiObservationName, bool allowUnparsed, out DiscoveredApiObservationName result)

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

Parameters
Name Description
discoveredApiObservationName 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 DiscoveredApiObservationName

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

Operators

operator ==(DiscoveredApiObservationName, DiscoveredApiObservationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DiscoveredApiObservationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DiscoveredApiObservationName

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

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.