Google Cloud Dialogflow v2beta1 API - Class SipTrunkName (1.0.0-beta21)

public sealed class SipTrunkName : IResourceName, IEquatable<SipTrunkName>

Reference documentation and code samples for the Google Cloud Dialogflow v2beta1 API class SipTrunkName.

Resource name for the SipTrunk resource.

Inheritance

object > SipTrunkName

Namespace

Google.Cloud.Dialogflow.V2Beta1

Assembly

Google.Cloud.Dialogflow.V2Beta1.dll

Constructors

SipTrunkName(string, string, string)

public SipTrunkName(string projectId, string locationId, string siptrunkId)

Constructs a new instance of a SipTrunkName class from the component parts of pattern projects/{project}/locations/{location}/sipTrunks/{siptrunk}

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.

siptrunkId string

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

SiptrunkId

public string SiptrunkId { get; }

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

Property Value
Type Description
string

Type

public SipTrunkName.ResourceNameType Type { get; }

The SipTrunkName.ResourceNameType of the contained resource name.

Property Value
Type Description
SipTrunkNameResourceNameType

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

Formats the IDs into the string representation of this SipTrunkName with pattern projects/{project}/locations/{location}/sipTrunks/{siptrunk}.

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.

siptrunkId string

The Siptrunk ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this SipTrunkName with pattern projects/{project}/locations/{location}/sipTrunks/{siptrunk}.

FormatProjectLocationSiptrunk(string, string, string)

public static string FormatProjectLocationSiptrunk(string projectId, string locationId, string siptrunkId)

Formats the IDs into the string representation of this SipTrunkName with pattern projects/{project}/locations/{location}/sipTrunks/{siptrunk}.

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.

siptrunkId string

The Siptrunk ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this SipTrunkName with pattern projects/{project}/locations/{location}/sipTrunks/{siptrunk}.

FromProjectLocationSiptrunk(string, string, string)

public static SipTrunkName FromProjectLocationSiptrunk(string projectId, string locationId, string siptrunkId)

Creates a SipTrunkName with the pattern projects/{project}/locations/{location}/sipTrunks/{siptrunk}.

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.

siptrunkId string

The Siptrunk ID. Must not be null or empty.

Returns
Type Description
SipTrunkName

A new instance of SipTrunkName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SipTrunkName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SipTrunkName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
SipTrunkName

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

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

Parameter
Name Description
sipTrunkName string

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

Returns
Type Description
SipTrunkName

The parsed SipTrunkName if successful.

Remarks

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

  • projects/{project}/locations/{location}/sipTrunks/{siptrunk}

Parse(string, bool)

public static SipTrunkName Parse(string sipTrunkName, bool allowUnparsed)

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

Parameters
Name Description
sipTrunkName 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
SipTrunkName

The parsed SipTrunkName if successful.

Remarks

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

  • projects/{project}/locations/{location}/sipTrunks/{siptrunk}
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 SipTrunkName)

public static bool TryParse(string sipTrunkName, out SipTrunkName result)

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

Parameters
Name Description
sipTrunkName string

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

result SipTrunkName

When this method returns, the parsed SipTrunkName, 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}/sipTrunks/{siptrunk}

TryParse(string, bool, out SipTrunkName)

public static bool TryParse(string sipTrunkName, bool allowUnparsed, out SipTrunkName result)

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

Parameters
Name Description
sipTrunkName 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 SipTrunkName

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

Operators

operator ==(SipTrunkName, SipTrunkName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SipTrunkName

The first resource name to compare, or null.

b SipTrunkName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SipTrunkName

The first resource name to compare, or null.

b SipTrunkName

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.