API Gateway v1 API - Class ManagedServiceName (2.4.0)

public sealed class ManagedServiceName : IResourceName, IEquatable<ManagedServiceName>

Reference documentation and code samples for the API Gateway v1 API class ManagedServiceName.

Resource name for the ManagedService resource.

Inheritance

object > ManagedServiceName

Namespace

Google.Cloud.ApiGateway.V1

Assembly

Google.Cloud.ApiGateway.V1.dll

Constructors

ManagedServiceName(string)

public ManagedServiceName(string serviceId)

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

Parameter
Name Description
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

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 ManagedServiceName.ResourceNameType Type { get; }

The ManagedServiceName.ResourceNameType of the contained resource name.

Property Value
Type Description
ManagedServiceNameResourceNameType

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)

public static string Format(string serviceId)

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

Parameter
Name Description
serviceId string

The Service ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ManagedServiceName with pattern services/{service}.

FormatService(string)

public static string FormatService(string serviceId)

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

Parameter
Name Description
serviceId string

The Service ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ManagedServiceName with pattern services/{service}.

FromService(string)

public static ManagedServiceName FromService(string serviceId)

Creates a ManagedServiceName with the pattern services/{service}.

Parameter
Name Description
serviceId string

The Service ID. Must not be null or empty.

Returns
Type Description
ManagedServiceName

A new instance of ManagedServiceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ManagedServiceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ManagedServiceName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
ManagedServiceName

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

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

Parameter
Name Description
managedServiceName string

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

Returns
Type Description
ManagedServiceName

The parsed ManagedServiceName if successful.

Remarks

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

  • services/{service}

Parse(string, bool)

public static ManagedServiceName Parse(string managedServiceName, bool allowUnparsed)

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

Parameters
Name Description
managedServiceName 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
ManagedServiceName

The parsed ManagedServiceName if successful.

Remarks

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

  • 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

TryParse(string, out ManagedServiceName)

public static bool TryParse(string managedServiceName, out ManagedServiceName result)

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

Parameters
Name Description
managedServiceName string

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

result ManagedServiceName

When this method returns, the parsed ManagedServiceName, 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:

  • services/{service}

TryParse(string, bool, out ManagedServiceName)

public static bool TryParse(string managedServiceName, bool allowUnparsed, out ManagedServiceName result)

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

Parameters
Name Description
managedServiceName 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 ManagedServiceName

When this method returns, the parsed ManagedServiceName, 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:

  • services/{service}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ManagedServiceName, ManagedServiceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ManagedServiceName

The first resource name to compare, or null.

b ManagedServiceName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ManagedServiceName

The first resource name to compare, or null.

b ManagedServiceName

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.