Dialogflow v3 API - Class ServiceName (2.3.0)

Version 2.3.0

• 2.20.0 (latest)
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class ServiceName : IResourceName, IEquatable<ServiceName>

Reference documentation and code samples for the Dialogflow v3 API class ServiceName.

Resource name for the Service resource.

Inheritance

Object > ServiceName

Implements

IResourceName, IEquatable<ServiceName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

ServiceName(String, String, String, String)

public ServiceName(string projectId, string locationId, string namespaceId, string serviceId)

Constructs a new instance of a ServiceName class from the component parts of pattern projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}

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.
namespaceId	String The Namespace ID. Must not be null or empty.
serviceId	String The Service 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
Boolean

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

NamespaceId

public string NamespaceId { get; }

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

ServiceId

public string ServiceId { get; }

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

Property Value
Type	Description
String

Type

public ServiceName.ResourceNameType Type { get; }

The ServiceName.ResourceNameType of the contained resource name.

Property Value
Type	Description
ServiceName.ResourceNameType

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, String)

public static string Format(string projectId, string locationId, string namespaceId, string serviceId)

Formats the IDs into the string representation of this ServiceName with pattern projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.

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.
namespaceId	String The Namespace ID. Must not be null or empty.
serviceId	String The Service ID. Must not be null or empty.

Returns
Type	Description
String	The string representation of this ServiceName with pattern projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.

FormatProjectLocationNamespaceService(String, String, String, String)

public static string FormatProjectLocationNamespaceService(string projectId, string locationId, string namespaceId, string serviceId)

Formats the IDs into the string representation of this ServiceName with pattern projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.

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.
namespaceId	String The Namespace ID. Must not be null or empty.
serviceId	String The Service ID. Must not be null or empty.

Returns
Type	Description
String	The string representation of this ServiceName with pattern projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.

FromProjectLocationNamespaceService(String, String, String, String)

public static ServiceName FromProjectLocationNamespaceService(string projectId, string locationId, string namespaceId, string serviceId)

Creates a ServiceName with the pattern projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.

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.
namespaceId	String The Namespace ID. Must not be null or empty.
serviceId	String The Service ID. Must not be null or empty.

Returns
Type	Description
ServiceName	A new instance of ServiceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ServiceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ServiceName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
ServiceName	A new instance of ServiceName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
Int32

Overrides

Object.GetHashCode()

Parse(String)

public static ServiceName Parse(string serviceName)

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

Parameter
Name	Description
serviceName	String The resource name in string form. Must not be null.

Returns
Type	Description
ServiceName	The parsed ServiceName if successful.

Remarks

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

• projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}

Parse(String, Boolean)

public static ServiceName Parse(string serviceName, bool allowUnparsed)

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

Parameters
Name	Description
serviceName	String The resource name in string form. Must not be null.
allowUnparsed	Boolean 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
ServiceName	The parsed ServiceName if successful.

Remarks

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

• projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}

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

Object.ToString()

TryParse(String, out ServiceName)

public static bool TryParse(string serviceName, out ServiceName result)

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

Parameters
Name	Description
serviceName	String The resource name in string form. Must not be null.
result	ServiceName When this method returns, the parsed ServiceName, or null if parsing failed.

Returns
Type	Description
Boolean	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}/namespaces/{namespace}/services/{service}

TryParse(String, Boolean, out ServiceName)

public static bool TryParse(string serviceName, bool allowUnparsed, out ServiceName result)

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

Parameters
Name	Description
serviceName	String The resource name in string form. Must not be null.
allowUnparsed	Boolean 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	ServiceName When this method returns, the parsed ServiceName, or null if parsing failed.

Returns
Type	Description
Boolean	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}/namespaces/{namespace}/services/{service}

Or may be in any format if allowUnparsed is true.

Operators

Equality(ServiceName, ServiceName)

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

Parameters
Name	Description
a	ServiceName
b	ServiceName

Returns
Type	Description
Boolean

Inequality(ServiceName, ServiceName)

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

Parameters
Name	Description
a	ServiceName
b	ServiceName

Returns
Type	Description
Boolean