API hub v1 API - Class DependencyName (1.0.0-beta01) 

public sealed class DependencyName : IResourceName, IEquatable<DependencyName>

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

Resource name for the Dependency resource.

Inheritance

object > DependencyName

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

DependencyName(string, string, string)

public DependencyName(string projectId, string locationId, string dependencyId)

Constructs a new instance of a DependencyName class from the component parts of pattern projects/{project}/locations/{location}/dependencies/{dependency}

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

The Dependency ID. Must not be null or empty.

Properties

DependencyId

public string DependencyId { get; }

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

The DependencyName.ResourceNameType of the contained resource name.

Property Value
Type Description
DependencyNameResourceNameType

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

Formats the IDs into the string representation of this DependencyName with pattern projects/{project}/locations/{location}/dependencies/{dependency}.

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

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

The string representation of this DependencyName with pattern projects/{project}/locations/{location}/dependencies/{dependency}.

FormatProjectLocationDependency(string, string, string)

public static string FormatProjectLocationDependency(string projectId, string locationId, string dependencyId)

Formats the IDs into the string representation of this DependencyName with pattern projects/{project}/locations/{location}/dependencies/{dependency}.

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

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

The string representation of this DependencyName with pattern projects/{project}/locations/{location}/dependencies/{dependency}.

FromProjectLocationDependency(string, string, string)

public static DependencyName FromProjectLocationDependency(string projectId, string locationId, string dependencyId)

Creates a DependencyName with the pattern projects/{project}/locations/{location}/dependencies/{dependency}.

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

The Dependency ID. Must not be null or empty.
Returns
Type Description
DependencyName

A new instance of DependencyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DependencyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DependencyName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
dependencyName string

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

The parsed DependencyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dependencies/{dependency}

Parse(string, bool)

public static DependencyName Parse(string dependencyName, bool allowUnparsed)

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

Parameters
Name Description
dependencyName 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
DependencyName

The parsed DependencyName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dependencies/{dependency}
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 DependencyName)

public static bool TryParse(string dependencyName, out DependencyName result)

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

Parameters
Name Description
dependencyName string

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

When this method returns, the parsed DependencyName, 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}/dependencies/{dependency}

TryParse(string, bool, out DependencyName)

public static bool TryParse(string dependencyName, bool allowUnparsed, out DependencyName result)

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

Parameters
Name Description
dependencyName 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 DependencyName

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

Operators

operator ==(DependencyName, DependencyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DependencyName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DependencyName

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

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.