Class ServiceName (1.1.0)

public sealed class ServiceName : IResourceName, IEquatable<ServiceName>

Resource name for the Service resource.

Inheritance

Object > ServiceName

Implements

IResourceName, IEquatable<ServiceName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.ApiGateway.V1

Assembly

Google.Cloud.ApiGateway.V1.dll

Constructors

ServiceName(String, String)

public ServiceName(string serviceId, string configId)

Constructs a new instance of a ServiceName class from the component parts of pattern services/{service}/configs/{config}

Parameters
Name	Description
`serviceId`	`String` The `Service` ID. Must not be `null` or empty.
`configId`	`String` The `Config` ID. Must not be `null` or empty.

Properties

ConfigId

public string ConfigId { get; }

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

Property Value
Type	Description
`String`

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type	Description
`Boolean`

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)

public static string Format(string serviceId, string configId)

Formats the IDs into the string representation of this ServiceName with pattern services/{service}/configs/{config}.

Parameters
Name	Description
`serviceId`	`String` The `Service` ID. Must not be `null` or empty.
`configId`	`String` The `Config` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this ServiceName with pattern `services/{service}/configs/{config}`.

FormatServiceConfig(String, String)

public static string FormatServiceConfig(string serviceId, string configId)

Formats the IDs into the string representation of this ServiceName with pattern services/{service}/configs/{config}.

Parameters
Name	Description
`serviceId`	`String` The `Service` ID. Must not be `null` or empty.
`configId`	`String` The `Config` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this ServiceName with pattern `services/{service}/configs/{config}`.

FromServiceConfig(String, String)

public static ServiceName FromServiceConfig(string serviceId, string configId)

Creates a ServiceName with the pattern services/{service}/configs/{config}.

Parameters
Name	Description
`serviceId`	`String` The `Service` ID. Must not be `null` or empty.
`configId`	`String` The `Config` 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:

services/{service}/configs/{config}

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:

services/{service}/configs/{config}

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:

services/{service}/configs/{config}

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:

services/{service}/configs/{config}

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`