Network Services v1 API - Class LbTrafficExtensionName (1.0.0)

public sealed class LbTrafficExtensionName : IResourceName, IEquatable<LbTrafficExtensionName>

Reference documentation and code samples for the Network Services v1 API class LbTrafficExtensionName.

Resource name for the LbTrafficExtension resource.

Inheritance

object > LbTrafficExtensionName

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

LbTrafficExtensionName(string, string, string)

public LbTrafficExtensionName(string projectId, string locationId, string lbTrafficExtensionId)

Constructs a new instance of a LbTrafficExtensionName class from the component parts of pattern projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}

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.

lbTrafficExtensionId string

The LbTrafficExtension 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

LbTrafficExtensionId

public string LbTrafficExtensionId { get; }

The LbTrafficExtension ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

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

The LbTrafficExtensionName.ResourceNameType of the contained resource name.

Property Value
Type Description
LbTrafficExtensionNameResourceNameType

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

Formats the IDs into the string representation of this LbTrafficExtensionName with pattern projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}.

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.

lbTrafficExtensionId string

The LbTrafficExtension ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this LbTrafficExtensionName with pattern projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}.

FormatProjectLocationLbTrafficExtension(string, string, string)

public static string FormatProjectLocationLbTrafficExtension(string projectId, string locationId, string lbTrafficExtensionId)

Formats the IDs into the string representation of this LbTrafficExtensionName with pattern projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}.

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.

lbTrafficExtensionId string

The LbTrafficExtension ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this LbTrafficExtensionName with pattern projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}.

FromProjectLocationLbTrafficExtension(string, string, string)

public static LbTrafficExtensionName FromProjectLocationLbTrafficExtension(string projectId, string locationId, string lbTrafficExtensionId)

Creates a LbTrafficExtensionName with the pattern projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}.

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.

lbTrafficExtensionId string

The LbTrafficExtension ID. Must not be null or empty.

Returns
Type Description
LbTrafficExtensionName

A new instance of LbTrafficExtensionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static LbTrafficExtensionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LbTrafficExtensionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
LbTrafficExtensionName

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

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

Parameter
Name Description
lbTrafficExtensionName string

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

Returns
Type Description
LbTrafficExtensionName

The parsed LbTrafficExtensionName if successful.

Remarks

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

  • projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}

Parse(string, bool)

public static LbTrafficExtensionName Parse(string lbTrafficExtensionName, bool allowUnparsed)

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

Parameters
Name Description
lbTrafficExtensionName 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
LbTrafficExtensionName

The parsed LbTrafficExtensionName if successful.

Remarks

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

  • projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}
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 LbTrafficExtensionName)

public static bool TryParse(string lbTrafficExtensionName, out LbTrafficExtensionName result)

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

Parameters
Name Description
lbTrafficExtensionName string

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

result LbTrafficExtensionName

When this method returns, the parsed LbTrafficExtensionName, 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}/lbTrafficExtensions/{lb_traffic_extension}

TryParse(string, bool, out LbTrafficExtensionName)

public static bool TryParse(string lbTrafficExtensionName, bool allowUnparsed, out LbTrafficExtensionName result)

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

Parameters
Name Description
lbTrafficExtensionName 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 LbTrafficExtensionName

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

Operators

operator ==(LbTrafficExtensionName, LbTrafficExtensionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a LbTrafficExtensionName

The first resource name to compare, or null.

b LbTrafficExtensionName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a LbTrafficExtensionName

The first resource name to compare, or null.

b LbTrafficExtensionName

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.