Class WorkspaceName (3.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class WorkspaceName : IResourceName, IEquatable<WorkspaceName>

Resource name for the Workspace resource.

Inheritance

Object > WorkspaceName

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

WorkspaceName(String)

public WorkspaceName(string projectId)

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

Parameter
NameDescription
projectIdString

The Project 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
TypeDescription
Boolean

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
String

Type

public WorkspaceName.ResourceNameType Type { get; }

The WorkspaceName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
WorkspaceName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

WorkspaceId

public string WorkspaceId { get; }

The Workspace ID. May be null, depending on which resource name is contained by this instance.

Property Value
TypeDescription
String

Methods

Format(String)

public static string Format(string projectId)

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

Parameter
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this WorkspaceName with pattern projects/{project}.

FormatProject(String)

public static string FormatProject(string projectId)

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

Parameter
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this WorkspaceName with pattern projects/{project}.

FormatWorkspace(String)

public static string FormatWorkspace(string workspaceId)

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

Parameter
NameDescription
workspaceIdString

The Workspace ID. Must not be null or empty.

Returns
TypeDescription
String

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

FromProject(String)

public static WorkspaceName FromProject(string projectId)

Creates a WorkspaceName with the pattern projects/{project}.

Parameter
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
WorkspaceName

A new instance of WorkspaceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static WorkspaceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a WorkspaceName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
WorkspaceName

A new instance of WorkspaceName containing the provided unparsedResourceName.

FromWorkspace(String)

public static WorkspaceName FromWorkspace(string workspaceId)

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

Parameter
NameDescription
workspaceIdString

The Workspace ID. Must not be null or empty.

Returns
TypeDescription
WorkspaceName

A new instance of WorkspaceName constructed from the provided ids.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static WorkspaceName Parse(string workspaceName)

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

Parameter
NameDescription
workspaceNameString

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

Returns
TypeDescription
WorkspaceName

The parsed WorkspaceName if successful.

Remarks

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

  • projects/{project}
  • workspaces/{workspace}

Parse(String, Boolean)

public static WorkspaceName Parse(string workspaceName, bool allowUnparsed)

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

Parameters
NameDescription
workspaceNameString

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

allowUnparsedBoolean

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

The parsed WorkspaceName if successful.

Remarks

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

  • projects/{project}
  • workspaces/{workspace}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

TryParse(String, out WorkspaceName)

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

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

Parameters
NameDescription
workspaceNameString

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

resultWorkspaceName

When this method returns, the parsed WorkspaceName, or null if parsing failed.

Returns
TypeDescription
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}
  • workspaces/{workspace}

TryParse(String, Boolean, out WorkspaceName)

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

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

Parameters
NameDescription
workspaceNameString

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

allowUnparsedBoolean

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.

resultWorkspaceName

When this method returns, the parsed WorkspaceName, or null if parsing failed.

Returns
TypeDescription
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}
  • workspaces/{workspace}
Or may be in any format if allowUnparsed is true.

Operators

Equality(WorkspaceName, WorkspaceName)

public static bool operator ==(WorkspaceName a, WorkspaceName b)
Parameters
NameDescription
aWorkspaceName
bWorkspaceName
Returns
TypeDescription
Boolean

Inequality(WorkspaceName, WorkspaceName)

public static bool operator !=(WorkspaceName a, WorkspaceName b)
Parameters
NameDescription
aWorkspaceName
bWorkspaceName
Returns
TypeDescription
Boolean