Network Connectivity v1 API - Class ServiceClassName (2.10.0) 

public sealed class ServiceClassName : IResourceName, IEquatable<ServiceClassName>

Reference documentation and code samples for the Network Connectivity v1 API class ServiceClassName.

Resource name for the ServiceClass resource.

Inheritance

object > ServiceClassName

Namespace

Google.Cloud.NetworkConnectivity.V1

Assembly

Google.Cloud.NetworkConnectivity.V1.dll

Constructors

ServiceClassName(string, string, string)

public ServiceClassName(string projectId, string locationId, string serviceClassId)

Constructs a new instance of a ServiceClassName class from the component parts of pattern projects/{project}/locations/{location}/serviceClasses/{service_class}

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.
serviceClassId string

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

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

ServiceClassId

public string ServiceClassId { get; }

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

Property Value
Type Description
string

Type

public ServiceClassName.ResourceNameType Type { get; }

The ServiceClassName.ResourceNameType of the contained resource name.

Property Value
Type Description
ServiceClassNameResourceNameType

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)

public static string Format(string projectId, string locationId, string serviceClassId)

Formats the IDs into the string representation of this ServiceClassName with pattern projects/{project}/locations/{location}/serviceClasses/{service_class}.

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.
serviceClassId string

The ServiceClass ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ServiceClassName with pattern projects/{project}/locations/{location}/serviceClasses/{service_class}.

FormatProjectLocationServiceClass(string, string, string)

public static string FormatProjectLocationServiceClass(string projectId, string locationId, string serviceClassId)

Formats the IDs into the string representation of this ServiceClassName with pattern projects/{project}/locations/{location}/serviceClasses/{service_class}.

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.
serviceClassId string

The ServiceClass ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ServiceClassName with pattern projects/{project}/locations/{location}/serviceClasses/{service_class}.

FromProjectLocationServiceClass(string, string, string)

public static ServiceClassName FromProjectLocationServiceClass(string projectId, string locationId, string serviceClassId)

Creates a ServiceClassName with the pattern projects/{project}/locations/{location}/serviceClasses/{service_class}.

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.
serviceClassId string

The ServiceClass ID. Must not be null or empty.
Returns
Type Description
ServiceClassName

A new instance of ServiceClassName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ServiceClassName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ServiceClassName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
ServiceClassName

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

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

Parameter
Name Description
serviceClassName string

The resource name in string form. Must not be null.
Returns
Type Description
ServiceClassName

The parsed ServiceClassName if successful.
Remarks

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

  • projects/{project}/locations/{location}/serviceClasses/{service_class}

Parse(string, bool)

public static ServiceClassName Parse(string serviceClassName, bool allowUnparsed)

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

Parameters
Name Description
serviceClassName 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
ServiceClassName

The parsed ServiceClassName if successful.
Remarks

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

  • projects/{project}/locations/{location}/serviceClasses/{service_class}
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 ServiceClassName)

public static bool TryParse(string serviceClassName, out ServiceClassName result)

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

Parameters
Name Description
serviceClassName string

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

When this method returns, the parsed ServiceClassName, 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}/serviceClasses/{service_class}

TryParse(string, bool, out ServiceClassName)

public static bool TryParse(string serviceClassName, bool allowUnparsed, out ServiceClassName result)

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

Parameters
Name Description
serviceClassName 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 ServiceClassName

When this method returns, the parsed ServiceClassName, 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}/serviceClasses/{service_class}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ServiceClassName, ServiceClassName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ServiceClassName

The first resource name to compare, or null.
b ServiceClassName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ServiceClassName

The first resource name to compare, or null.
b ServiceClassName

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.