Service Directory v1 API - Class ServiceName (2.3.0)

public sealed class ServiceName : IResourceName, IEquatable<ServiceName>

Reference documentation and code samples for the Service Directory v1 API class ServiceName.

Resource name for the Service resource.

Inheritance

object > ServiceName

Implements

IResourceName, IEquatable ServiceName

Inherited Members

object.GetType()

Namespace

Google.Cloud.ServiceDirectory.V1

Assembly

Google.Cloud.ServiceDirectory.V1.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
`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`

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
`ServiceNameResourceNameType`

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
`int`

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

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`	`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
`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
`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}/namespaces/{namespace}/services/{service}

TryParse(string, bool, 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`	`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`	`ServiceName` When this method returns, the parsed ServiceName, 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}/namespaces/{namespace}/services/{service}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ServiceName, ServiceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`ServiceName` The first resource name to compare, or null.
`b`	`ServiceName` 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 !=(ServiceName, ServiceName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`ServiceName` The first resource name to compare, or null.
`b`	`ServiceName` 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.