Design Center v1 API - Class SpaceName (1.0.0-beta01) 

public sealed class SpaceName : IResourceName, IEquatable<SpaceName>

Reference documentation and code samples for the Design Center v1 API class SpaceName.

Resource name for the Space resource.

Inheritance

object > SpaceName

Namespace

Google.Cloud.DesignCenter.V1

Assembly

Google.Cloud.DesignCenter.V1.dll

Constructors

SpaceName(string, string, string)

public SpaceName(string projectId, string locationId, string spaceId)

Constructs a new instance of a SpaceName class from the component parts of pattern projects/{project}/locations/{location}/spaces/{space}

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

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

SpaceId

public string SpaceId { get; }

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

Property Value
Type Description
string

Type

public SpaceName.ResourceNameType Type { get; }

The SpaceName.ResourceNameType of the contained resource name.

Property Value
Type Description
SpaceNameResourceNameType

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

Formats the IDs into the string representation of this SpaceName with pattern projects/{project}/locations/{location}/spaces/{space}.

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

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

The string representation of this SpaceName with pattern projects/{project}/locations/{location}/spaces/{space}.

FormatProjectLocationSpace(string, string, string)

public static string FormatProjectLocationSpace(string projectId, string locationId, string spaceId)

Formats the IDs into the string representation of this SpaceName with pattern projects/{project}/locations/{location}/spaces/{space}.

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

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

The string representation of this SpaceName with pattern projects/{project}/locations/{location}/spaces/{space}.

FromProjectLocationSpace(string, string, string)

public static SpaceName FromProjectLocationSpace(string projectId, string locationId, string spaceId)

Creates a SpaceName with the pattern projects/{project}/locations/{location}/spaces/{space} .

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

The Space ID. Must not be null or empty.
Returns
Type Description
SpaceName

A new instance of SpaceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SpaceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SpaceName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
spaceName string

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

The parsed SpaceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/spaces/{space}

Parse(string, bool)

public static SpaceName Parse(string spaceName, bool allowUnparsed)

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

Parameters
Name Description
spaceName 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
SpaceName

The parsed SpaceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/spaces/{space}

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

public static bool TryParse(string spaceName, out SpaceName result)

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

Parameters
Name Description
spaceName string

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

When this method returns, the parsed SpaceName, 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}/spaces/{space}

TryParse(string, bool, out SpaceName)

public static bool TryParse(string spaceName, bool allowUnparsed, out SpaceName result)

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

Parameters
Name Description
spaceName 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 SpaceName

When this method returns, the parsed SpaceName, 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}/spaces/{space}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SpaceName, SpaceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SpaceName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SpaceName

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

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.