Telco Automation v1 API - Class EdgeSlmName (1.0.0)

public sealed class EdgeSlmName : IResourceName, IEquatable<EdgeSlmName>

Reference documentation and code samples for the Telco Automation v1 API class EdgeSlmName.

Resource name for the EdgeSlm resource.

Inheritance

object > EdgeSlmName

Namespace

Google.Cloud.TelcoAutomation.V1

Assembly

Google.Cloud.TelcoAutomation.V1.dll

Constructors

EdgeSlmName(string, string, string)

public EdgeSlmName(string projectId, string locationId, string edgeSlmId)

Constructs a new instance of a EdgeSlmName class from the component parts of pattern projects/{project}/locations/{location}/edgeSlms/{edge_slm}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

edgeSlmIdstring

The EdgeSlm ID. Must not be null or empty.

Properties

EdgeSlmId

public string EdgeSlmId { get; }

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

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

Type

public EdgeSlmName.ResourceNameType Type { get; }

The EdgeSlmName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
EdgeSlmNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string)

public static string Format(string projectId, string locationId, string edgeSlmId)

Formats the IDs into the string representation of this EdgeSlmName with pattern projects/{project}/locations/{location}/edgeSlms/{edge_slm}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

edgeSlmIdstring

The EdgeSlm ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this EdgeSlmName with pattern projects/{project}/locations/{location}/edgeSlms/{edge_slm}.

FormatProjectLocationEdgeSlm(string, string, string)

public static string FormatProjectLocationEdgeSlm(string projectId, string locationId, string edgeSlmId)

Formats the IDs into the string representation of this EdgeSlmName with pattern projects/{project}/locations/{location}/edgeSlms/{edge_slm}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

edgeSlmIdstring

The EdgeSlm ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this EdgeSlmName with pattern projects/{project}/locations/{location}/edgeSlms/{edge_slm}.

FromProjectLocationEdgeSlm(string, string, string)

public static EdgeSlmName FromProjectLocationEdgeSlm(string projectId, string locationId, string edgeSlmId)

Creates a EdgeSlmName with the pattern projects/{project}/locations/{location}/edgeSlms/{edge_slm}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

edgeSlmIdstring

The EdgeSlm ID. Must not be null or empty.

Returns
TypeDescription
EdgeSlmName

A new instance of EdgeSlmName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EdgeSlmName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EdgeSlmName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
EdgeSlmName

A new instance of EdgeSlmName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static EdgeSlmName Parse(string edgeSlmName)

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

Parameter
NameDescription
edgeSlmNamestring

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

Returns
TypeDescription
EdgeSlmName

The parsed EdgeSlmName if successful.

Remarks

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

  • projects/{project}/locations/{location}/edgeSlms/{edge_slm}

Parse(string, bool)

public static EdgeSlmName Parse(string edgeSlmName, bool allowUnparsed)

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

Parameters
NameDescription
edgeSlmNamestring

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

allowUnparsedbool

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
TypeDescription
EdgeSlmName

The parsed EdgeSlmName if successful.

Remarks

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

  • projects/{project}/locations/{location}/edgeSlms/{edge_slm}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out EdgeSlmName)

public static bool TryParse(string edgeSlmName, out EdgeSlmName result)

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

Parameters
NameDescription
edgeSlmNamestring

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

resultEdgeSlmName

When this method returns, the parsed EdgeSlmName, or null if parsing failed.

Returns
TypeDescription
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}/edgeSlms/{edge_slm}

TryParse(string, bool, out EdgeSlmName)

public static bool TryParse(string edgeSlmName, bool allowUnparsed, out EdgeSlmName result)

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

Parameters
NameDescription
edgeSlmNamestring

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

allowUnparsedbool

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.

resultEdgeSlmName

When this method returns, the parsed EdgeSlmName, or null if parsing failed.

Returns
TypeDescription
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}/edgeSlms/{edge_slm}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(EdgeSlmName, EdgeSlmName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aEdgeSlmName

The first resource name to compare, or null.

bEdgeSlmName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(EdgeSlmName, EdgeSlmName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aEdgeSlmName

The first resource name to compare, or null.

bEdgeSlmName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.