Google Cloud Monitoring v3 API - Class WorkspaceName (3.5.0)

public sealed class WorkspaceName : IResourceName, IEquatable<WorkspaceName>

Reference documentation and code samples for the Google Cloud Monitoring v3 API class WorkspaceName.

Resource name for the Workspace resource.

Inheritance

object > WorkspaceName

Implements

IResourceName, IEquatable WorkspaceName

Inherited Members

object.GetType()

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
Name	Description
`projectId`	`string` 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
Type	Description
`bool`

ProjectId

public string ProjectId { get; }

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

Property Value
Type	Description
`string`

Type

public WorkspaceName.ResourceNameType Type { get; }

The WorkspaceName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`WorkspaceNameResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type	Description
`UnparsedResourceName`

WorkspaceId

public string WorkspaceId { get; }

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

Property Value
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`workspaceId`	`string` The `Workspace` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.

Returns
Type	Description
`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
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)

public static WorkspaceName FromWorkspace(string workspaceId)

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

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

Returns
Type	Description
`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
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static WorkspaceName Parse(string workspaceName)

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

Parameter
Name	Description
`workspaceName`	`string` 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:

projects/{project}
workspaces/{workspace}

Parse(string, bool)

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
Name	Description
`workspaceName`	`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
`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
Type	Description
`string`	The string representation of the resource name.

Overrides

object.ToString()

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
Name	Description
`workspaceName`	`string` The resource name in string form. Must not be `null`.
`result`	`WorkspaceName` 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:

projects/{project}
workspaces/{workspace}

TryParse(string, bool, 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
Name	Description
`workspaceName`	`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`	`WorkspaceName` 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:

projects/{project}
workspaces/{workspace}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(WorkspaceName, WorkspaceName)

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

Parameters
Name	Description
`a`	`WorkspaceName`
`b`	`WorkspaceName`

Returns
Type	Description
`bool`

operator !=(WorkspaceName, WorkspaceName)

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

Parameters
Name	Description
`a`	`WorkspaceName`
`b`	`WorkspaceName`

Returns
Type	Description
`bool`