Class MapConfigName

Resource name for the MapConfig resource.

Inheritance

object

MapConfigName

Implements

IResourceName

IEquatable<MapConfigName>

Inherited Members

object.GetType()

Namespace: Google.Maps.MapManagement.V2Beta

Assembly: Google.Maps.MapManagement.V2Beta.dll

Syntax

public sealed class MapConfigName : IResourceName, IEquatable<MapConfigName>

Constructors

MapConfigName(string, string)

Constructs a new instance of a MapConfigName class from the component parts of pattern projects/{project}/mapConfigs/{map_config}

Declaration

public MapConfigName(string projectId, string mapConfigId)

Parameters

Type	Name	Description
string	projectId	The Project ID. Must not be null or empty.
string	mapConfigId	The MapConfig ID. Must not be null or empty.

Properties

IsKnownPattern

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

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
bool

Implements

IResourceName.IsKnownPattern

MapConfigId

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

Declaration

public string MapConfigId { get; }

Property Value

Type	Description
string

ProjectId

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

Declaration

public string ProjectId { get; }

Property Value

Type	Description
string

Type

The MapConfigName.ResourceNameType of the contained resource name.

Declaration

public MapConfigName.ResourceNameType Type { get; }

Property Value

Type	Description
MapConfigName.ResourceNameType

UnparsedResource

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Format(string, string)

Formats the IDs into the string representation of this MapConfigName with pattern projects/{project}/mapConfigs/{map_config}.

Declaration

public static string Format(string projectId, string mapConfigId)

Parameters

Type	Name	Description
string	projectId	The Project ID. Must not be null or empty.
string	mapConfigId	The MapConfig ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this MapConfigName with pattern projects/{project}/mapConfigs/{map_config}.

FormatProjectMapConfig(string, string)

Formats the IDs into the string representation of this MapConfigName with pattern projects/{project}/mapConfigs/{map_config}.

Declaration

public static string FormatProjectMapConfig(string projectId, string mapConfigId)

Parameters

Type	Name	Description
string	projectId	The Project ID. Must not be null or empty.
string	mapConfigId	The MapConfig ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this MapConfigName with pattern projects/{project}/mapConfigs/{map_config}.

FromProjectMapConfig(string, string)

Creates a MapConfigName with the pattern projects/{project}/mapConfigs/{map_config}.

Declaration

public static MapConfigName FromProjectMapConfig(string projectId, string mapConfigId)

Parameters

Type	Name	Description
string	projectId	The Project ID. Must not be null or empty.
string	mapConfigId	The MapConfig ID. Must not be null or empty.

Returns

Type	Description
MapConfigName	A new instance of MapConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a MapConfigName containing an unparsed resource name.

Declaration

public static MapConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	Name	Description
UnparsedResourceName	unparsedResourceName	The unparsed resource name. Must not be null.

Returns

Type	Description
MapConfigName	A new instance of MapConfigName containing the provided unparsedResourceName.

GetHashCode()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

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

Declaration

public static MapConfigName Parse(string mapConfigName)

Parameters

Type	Name	Description
string	mapConfigName	The resource name in string form. Must not be null.

Returns

Type	Description
MapConfigName	The parsed MapConfigName if successful.

Remarks

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

• projects/{project}/mapConfigs/{map_config}

Parse(string, bool)

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

Declaration

public static MapConfigName Parse(string mapConfigName, bool allowUnparsed)

Parameters

Type	Name	Description
string	mapConfigName	The resource name in string form. Must not be null.
bool	allowUnparsed	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
MapConfigName	The parsed MapConfigName if successful.

Remarks

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

• projects/{project}/mapConfigs/{map_config}

Or may be in any format if allowUnparsed is true.

ToString()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
string	The string representation of the resource name.

Overrides

object.ToString()

Implements

IResourceName.ToString()

TryParse(string, out MapConfigName)

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

Declaration

public static bool TryParse(string mapConfigName, out MapConfigName result)

Parameters

Type	Name	Description
string	mapConfigName	The resource name in string form. Must not be null.
MapConfigName	result	When this method returns, the parsed MapConfigName, 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}/mapConfigs/{map_config}

TryParse(string, bool, out MapConfigName)

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

Declaration

public static bool TryParse(string mapConfigName, bool allowUnparsed, out MapConfigName result)

Parameters

Type	Name	Description
string	mapConfigName	The resource name in string form. Must not be null.
bool	allowUnparsed	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.
MapConfigName	result	When this method returns, the parsed MapConfigName, 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}/mapConfigs/{map_config}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(MapConfigName, MapConfigName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

Type	Name	Description
MapConfigName	a	The first resource name to compare, or null.
MapConfigName	b	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 !=(MapConfigName, MapConfigName)

Determines whether two specified resource names have different values.

Declaration

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

Parameters

Type	Name	Description
MapConfigName	a	The first resource name to compare, or null.
MapConfigName	b	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.