Class ServiceName (1.0.0) 

public sealed class ServiceName : IResourceName, IEquatable<ServiceName>

Resource name for the Service resource.

Inheritance

System.Object > ServiceName

Implements

Google.Api.Gax.IResourceName, System.IEquatable<ServiceName>

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 System.String

The Project ID. Must not be null or empty.
locationId System.String

The Location ID. Must not be null or empty.
namespaceId System.String

The Namespace ID. Must not be null or empty.
serviceId System.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
System.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
System.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
System.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
System.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
System.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 Google.Api.Gax.UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
Google.Api.Gax.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 System.String

The Project ID. Must not be null or empty.
locationId System.String

The Location ID. Must not be null or empty.
namespaceId System.String

The Namespace ID. Must not be null or empty.
serviceId System.String

The Service ID. Must not be null or empty.
Returns
Type Description
System.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 System.String

The Project ID. Must not be null or empty.
locationId System.String

The Location ID. Must not be null or empty.
namespaceId System.String

The Namespace ID. Must not be null or empty.
serviceId System.String

The Service ID. Must not be null or empty.
Returns
Type Description
System.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 System.String

The Project ID. Must not be null or empty.
locationId System.String

The Location ID. Must not be null or empty.
namespaceId System.String

The Namespace ID. Must not be null or empty.
serviceId System.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 Google.Api.Gax.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
System.Int32
Overrides
System.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 System.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 System.String

The resource name in string form. Must not be null.
allowUnparsed System.Boolean

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.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
System.String

The string representation of the resource name.
Overrides
System.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 System.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
System.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 System.String

The resource name in string form. Must not be null.
allowUnparsed System.Boolean

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.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
System.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
System.Boolean

Inequality(ServiceName, ServiceName)

public static bool operator !=(ServiceName a, ServiceName b)
Parameters
Name Description
a ServiceName
b ServiceName
Returns
Type Description
System.Boolean