Class NamespaceName (2.0.0) 

public sealed class NamespaceName : IResourceName, IEquatable<NamespaceName>

Resource name for the Namespace resource.

Inheritance

Object > NamespaceName

Namespace

Google.Cloud.ServiceDirectory.V1

Assembly

Google.Cloud.ServiceDirectory.V1.dll

Constructors

NamespaceName(String, String, String)

public NamespaceName(string projectId, string locationId, string namespaceId)

Constructs a new instance of a NamespaceName class from the component parts of pattern projects/{project}/locations/{location}/namespaces/{namespace}

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.
namespaceId String

The Namespace 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
Boolean

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

NamespaceId

public string NamespaceId { get; }

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

Type

public NamespaceName.ResourceNameType Type { get; }

The NamespaceName.ResourceNameType of the contained resource name.

Property Value
Type Description
NamespaceName.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, String)

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

Formats the IDs into the string representation of this NamespaceName with pattern projects/{project}/locations/{location}/namespaces/{namespace}.

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.
namespaceId String

The Namespace ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this NamespaceName with pattern projects/{project}/locations/{location}/namespaces/{namespace}.

FormatProjectLocationNamespace(String, String, String)

public static string FormatProjectLocationNamespace(string projectId, string locationId, string namespaceId)

Formats the IDs into the string representation of this NamespaceName with pattern projects/{project}/locations/{location}/namespaces/{namespace}.

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.
namespaceId String

The Namespace ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this NamespaceName with pattern projects/{project}/locations/{location}/namespaces/{namespace}.

FromProjectLocationNamespace(String, String, String)

public static NamespaceName FromProjectLocationNamespace(string projectId, string locationId, string namespaceId)

Creates a NamespaceName with the pattern projects/{project}/locations/{location}/namespaces/{namespace}.

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.
namespaceId String

The Namespace ID. Must not be null or empty.
Returns
Type Description
NamespaceName

A new instance of NamespaceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static NamespaceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NamespaceName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of NamespaceName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
Int32
Overrides

Parse(String)

public static NamespaceName Parse(string namespaceName)

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

Parameter
Name Description
namespaceName String

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

The parsed NamespaceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/namespaces/{namespace}

Parse(String, Boolean)

public static NamespaceName Parse(string namespaceName, bool allowUnparsed)

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

Parameters
Name Description
namespaceName 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
NamespaceName

The parsed NamespaceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/namespaces/{namespace}
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 NamespaceName)

public static bool TryParse(string namespaceName, out NamespaceName result)

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

Parameters
Name Description
namespaceName String

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

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

  • projects/{project}/locations/{location}/namespaces/{namespace}

TryParse(String, Boolean, out NamespaceName)

public static bool TryParse(string namespaceName, bool allowUnparsed, out NamespaceName result)

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

Parameters
Name Description
namespaceName 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 NamespaceName

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

  • projects/{project}/locations/{location}/namespaces/{namespace}
Or may be in any format if allowUnparsed is true.

Operators

Equality(NamespaceName, NamespaceName)

public static bool operator ==(NamespaceName a, NamespaceName b)
Parameters
Name Description
a NamespaceName
b NamespaceName
Returns
Type Description
Boolean

Inequality(NamespaceName, NamespaceName)

public static bool operator !=(NamespaceName a, NamespaceName b)
Parameters
Name Description
a NamespaceName
b NamespaceName
Returns
Type Description
Boolean