Class WorkspaceName

Resource name for the Workspace resource.

Inheritance

object

WorkspaceName

Implements

IResourceName

IEquatable<WorkspaceName>

Inherited Members

object.GetType()

Namespace: Google.Area120.Tables.V1Alpha1

Assembly: Google.Area120.Tables.V1Alpha1.dll

Syntax

public sealed class WorkspaceName : IResourceName, IEquatable<WorkspaceName>

Constructors

WorkspaceName(string)

Constructs a new instance of a WorkspaceName class from the component parts of pattern workspaces/{workspace}

Declaration

public WorkspaceName(string workspaceId)

Parameters

Type	Name	Description
string	workspaceId	The `Workspace` 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

Type

The WorkspaceName.ResourceNameType of the contained resource name.

Declaration

public WorkspaceName.ResourceNameType Type { get; }

Property Value

Type	Description
WorkspaceName.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

WorkspaceId

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

Declaration

public string WorkspaceId { get; }

Property Value

Type	Description
string

Methods

Format(string)

Formats the IDs into the string representation of this WorkspaceName with pattern workspaces/{workspace}.

Declaration

public static string Format(string workspaceId)

Parameters

Type	Name	Description
string	workspaceId	The `Workspace` ID. Must not be `null` or empty.

Returns

Type	Description
string	The string representation of this WorkspaceName with pattern `workspaces/{workspace}`.

FormatWorkspace(string)

Formats the IDs into the string representation of this WorkspaceName with pattern workspaces/{workspace}.

Declaration

public static string FormatWorkspace(string workspaceId)

Parameters

Type	Name	Description
string	workspaceId	The `Workspace` ID. Must not be `null` or empty.

Returns

Type	Description
string	The string representation of this WorkspaceName with pattern `workspaces/{workspace}`.

FromUnparsed(UnparsedResourceName)

Creates a WorkspaceName containing an unparsed resource name.

Declaration

public static WorkspaceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
WorkspaceName	A new instance of WorkspaceName containing the provided `unparsedResourceName`.

FromWorkspace(string)

Creates a WorkspaceName with the pattern workspaces/{workspace}.

Declaration

public static WorkspaceName FromWorkspace(string workspaceId)

Parameters

Type	Name	Description
string	workspaceId	The `Workspace` ID. Must not be `null` or empty.

Returns

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

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 WorkspaceName instance.

Declaration

public static WorkspaceName Parse(string workspaceName)

Parameters

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

Returns

Type	Description
WorkspaceName	The parsed WorkspaceName if successful.

Remarks

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

workspaces/{workspace}

Parse(string, bool)

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

Declaration

public static WorkspaceName Parse(string workspaceName, bool allowUnparsed)

Parameters

Type	Name	Description
string	workspaceName	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
WorkspaceName	The parsed WorkspaceName if successful.

Remarks

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

workspaces/{workspace}

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

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

Declaration

public static bool TryParse(string workspaceName, out WorkspaceName result)

Parameters

Type	Name	Description
string	workspaceName	The resource name in string form. Must not be `null`.
WorkspaceName	result	When this method returns, the parsed WorkspaceName, 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:

workspaces/{workspace}

TryParse(string, bool, out WorkspaceName)

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

Declaration

public static bool TryParse(string workspaceName, bool allowUnparsed, out WorkspaceName result)

Parameters

Type	Name	Description
string	workspaceName	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.
WorkspaceName	result	When this method returns, the parsed WorkspaceName, 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:

workspaces/{workspace}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(WorkspaceName, WorkspaceName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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