Network Connectivity v1 API - Class InternalRangeName (2.11.0) 

public sealed class InternalRangeName : IResourceName, IEquatable<InternalRangeName>

Reference documentation and code samples for the Network Connectivity v1 API class InternalRangeName.

Resource name for the InternalRange resource.

Inheritance

object > InternalRangeName

Namespace

Google.Cloud.NetworkConnectivity.V1

Assembly

Google.Cloud.NetworkConnectivity.V1.dll

Constructors

InternalRangeName(string, string, string)

public InternalRangeName(string projectId, string locationId, string internalRangeId)

Constructs a new instance of a InternalRangeName class from the component parts of pattern projects/{project}/locations/{location}/internalRanges/{internal_range}

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

The InternalRange ID. Must not be null or empty.

Properties

InternalRangeId

public string InternalRangeId { get; }

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

The InternalRangeName.ResourceNameType of the contained resource name.

Property Value
Type Description
InternalRangeNameResourceNameType

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

Formats the IDs into the string representation of this InternalRangeName with pattern projects/{project}/locations/{location}/internalRanges/{internal_range}.

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

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

The string representation of this InternalRangeName with pattern projects/{project}/locations/{location}/internalRanges/{internal_range}.

FormatProjectLocationInternalRange(string, string, string)

public static string FormatProjectLocationInternalRange(string projectId, string locationId, string internalRangeId)

Formats the IDs into the string representation of this InternalRangeName with pattern projects/{project}/locations/{location}/internalRanges/{internal_range}.

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

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

The string representation of this InternalRangeName with pattern projects/{project}/locations/{location}/internalRanges/{internal_range}.

FromProjectLocationInternalRange(string, string, string)

public static InternalRangeName FromProjectLocationInternalRange(string projectId, string locationId, string internalRangeId)

Creates a InternalRangeName with the pattern projects/{project}/locations/{location}/internalRanges/{internal_range}.

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

The InternalRange ID. Must not be null or empty.
Returns
Type Description
InternalRangeName

A new instance of InternalRangeName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static InternalRangeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InternalRangeName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
internalRangeName string

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

The parsed InternalRangeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/internalRanges/{internal_range}

Parse(string, bool)

public static InternalRangeName Parse(string internalRangeName, bool allowUnparsed)

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

Parameters
Name Description
internalRangeName 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
InternalRangeName

The parsed InternalRangeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/internalRanges/{internal_range}
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 InternalRangeName)

public static bool TryParse(string internalRangeName, out InternalRangeName result)

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

Parameters
Name Description
internalRangeName string

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

When this method returns, the parsed InternalRangeName, 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}/internalRanges/{internal_range}

TryParse(string, bool, out InternalRangeName)

public static bool TryParse(string internalRangeName, bool allowUnparsed, out InternalRangeName result)

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

Parameters
Name Description
internalRangeName 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 InternalRangeName

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

Operators

operator ==(InternalRangeName, InternalRangeName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a InternalRangeName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a InternalRangeName

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

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.