App Hub v1 API - Class BoundaryName (1.3.0) 

public sealed class BoundaryName : IResourceName, IEquatable<BoundaryName>

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

Resource name for the Boundary resource.

Inheritance

object > BoundaryName

Namespace

Google.Cloud.AppHub.V1

Assembly

Google.Cloud.AppHub.V1.dll

Constructors

BoundaryName(string, string)

public BoundaryName(string projectId, string locationId)

Constructs a new instance of a BoundaryName class from the component parts of pattern projects/{project}/locations/{location}/boundary

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.

Properties

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

The BoundaryName.ResourceNameType of the contained resource name.

Property Value
Type Description
BoundaryNameResourceNameType

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)

public static string Format(string projectId, string locationId)

Formats the IDs into the string representation of this BoundaryName with pattern projects/{project}/locations/{location}/boundary.

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.
Returns
Type Description
string

The string representation of this BoundaryName with pattern projects/{project}/locations/{location}/boundary.

FormatProjectLocation(string, string)

public static string FormatProjectLocation(string projectId, string locationId)

Formats the IDs into the string representation of this BoundaryName with pattern projects/{project}/locations/{location}/boundary.

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.
Returns
Type Description
string

The string representation of this BoundaryName with pattern projects/{project}/locations/{location}/boundary.

FromProjectLocation(string, string)

public static BoundaryName FromProjectLocation(string projectId, string locationId)

Creates a BoundaryName with the pattern projects/{project}/locations/{location}/boundary .

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.
Returns
Type Description
BoundaryName

A new instance of BoundaryName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static BoundaryName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BoundaryName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
boundaryName string

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

The parsed BoundaryName if successful.
Remarks

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

  • projects/{project}/locations/{location}/boundary

Parse(string, bool)

public static BoundaryName Parse(string boundaryName, bool allowUnparsed)

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

Parameters
Name Description
boundaryName 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
BoundaryName

The parsed BoundaryName if successful.
Remarks

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

  • projects/{project}/locations/{location}/boundary

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

public static bool TryParse(string boundaryName, out BoundaryName result)

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

Parameters
Name Description
boundaryName string

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

When this method returns, the parsed BoundaryName, 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}/boundary

TryParse(string, bool, out BoundaryName)

public static bool TryParse(string boundaryName, bool allowUnparsed, out BoundaryName result)

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

Parameters
Name Description
boundaryName 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 BoundaryName

When this method returns, the parsed BoundaryName, 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}/boundary

Or may be in any format if allowUnparsed is true.

Operators

operator ==(BoundaryName, BoundaryName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a BoundaryName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a BoundaryName

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

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.