Network Connectivity v1 API - Class ServiceConnectionMapName (2.10.0)

public sealed class ServiceConnectionMapName : IResourceName, IEquatable<ServiceConnectionMapName>

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

Resource name for the ServiceConnectionMap resource.

Inheritance

object > ServiceConnectionMapName

Namespace

Google.Cloud.NetworkConnectivity.V1

Assembly

Google.Cloud.NetworkConnectivity.V1.dll

Constructors

ServiceConnectionMapName(string, string, string)

public ServiceConnectionMapName(string projectId, string locationId, string serviceConnectionMapId)

Constructs a new instance of a ServiceConnectionMapName class from the component parts of pattern projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map}

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.

serviceConnectionMapId string

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

ServiceConnectionMapId

public string ServiceConnectionMapId { get; }

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

Property Value
Type Description
string

Type

public ServiceConnectionMapName.ResourceNameType Type { get; }

The ServiceConnectionMapName.ResourceNameType of the contained resource name.

Property Value
Type Description
ServiceConnectionMapNameResourceNameType

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 serviceConnectionMapId)

Formats the IDs into the string representation of this ServiceConnectionMapName with pattern projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map}.

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.

serviceConnectionMapId string

The ServiceConnectionMap ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ServiceConnectionMapName with pattern projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map}.

FormatProjectLocationServiceConnectionMap(string, string, string)

public static string FormatProjectLocationServiceConnectionMap(string projectId, string locationId, string serviceConnectionMapId)

Formats the IDs into the string representation of this ServiceConnectionMapName with pattern projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map}.

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.

serviceConnectionMapId string

The ServiceConnectionMap ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ServiceConnectionMapName with pattern projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map}.

FromProjectLocationServiceConnectionMap(string, string, string)

public static ServiceConnectionMapName FromProjectLocationServiceConnectionMap(string projectId, string locationId, string serviceConnectionMapId)

Creates a ServiceConnectionMapName with the pattern projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map}.

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.

serviceConnectionMapId string

The ServiceConnectionMap ID. Must not be null or empty.

Returns
Type Description
ServiceConnectionMapName

A new instance of ServiceConnectionMapName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ServiceConnectionMapName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ServiceConnectionMapName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
ServiceConnectionMapName

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

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

Parameter
Name Description
serviceConnectionMapName string

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

Returns
Type Description
ServiceConnectionMapName

The parsed ServiceConnectionMapName if successful.

Remarks

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

  • projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map}

Parse(string, bool)

public static ServiceConnectionMapName Parse(string serviceConnectionMapName, bool allowUnparsed)

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

Parameters
Name Description
serviceConnectionMapName 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
ServiceConnectionMapName

The parsed ServiceConnectionMapName if successful.

Remarks

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

  • projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map}
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 ServiceConnectionMapName)

public static bool TryParse(string serviceConnectionMapName, out ServiceConnectionMapName result)

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

Parameters
Name Description
serviceConnectionMapName string

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

result ServiceConnectionMapName

When this method returns, the parsed ServiceConnectionMapName, 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}/serviceConnectionMaps/{service_connection_map}

TryParse(string, bool, out ServiceConnectionMapName)

public static bool TryParse(string serviceConnectionMapName, bool allowUnparsed, out ServiceConnectionMapName result)

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

Parameters
Name Description
serviceConnectionMapName 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 ServiceConnectionMapName

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

Operators

operator ==(ServiceConnectionMapName, ServiceConnectionMapName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ServiceConnectionMapName

The first resource name to compare, or null.

b ServiceConnectionMapName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ServiceConnectionMapName

The first resource name to compare, or null.

b ServiceConnectionMapName

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.