Google Workspace Add-ons v1 API - Class InstallStatusName (2.4.0)

public sealed class InstallStatusName : IResourceName, IEquatable<InstallStatusName>

Reference documentation and code samples for the Google Workspace Add-ons v1 API class InstallStatusName.

Resource name for the InstallStatus resource.

Inheritance

object > InstallStatusName

Implements

IResourceName, IEquatable InstallStatusName

Inherited Members

object.GetType()

Namespace

Google.Cloud.GSuiteAddOns.V1

Assembly

Google.Cloud.GSuiteAddOns.V1.dll

Constructors

InstallStatusName(string, string)

public InstallStatusName(string projectId, string deploymentId)

Constructs a new instance of a InstallStatusName class from the component parts of pattern projects/{project}/deployments/{deployment}/installStatus

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`deploymentId`	`string` The `Deployment` ID. Must not be `null` or empty.

Properties

DeploymentId

public string DeploymentId { get; }

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

Property Value
Type	Description
`string`

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. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

Type

public InstallStatusName.ResourceNameType Type { get; }

The InstallStatusName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`InstallStatusNameResourceNameType`

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)

public static string Format(string projectId, string deploymentId)

Formats the IDs into the string representation of this InstallStatusName with pattern projects/{project}/deployments/{deployment}/installStatus.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`deploymentId`	`string` The `Deployment` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this InstallStatusName with pattern `projects/{project}/deployments/{deployment}/installStatus`.

FormatProjectDeployment(string, string)

public static string FormatProjectDeployment(string projectId, string deploymentId)

Formats the IDs into the string representation of this InstallStatusName with pattern projects/{project}/deployments/{deployment}/installStatus.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`deploymentId`	`string` The `Deployment` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this InstallStatusName with pattern `projects/{project}/deployments/{deployment}/installStatus`.

FromProjectDeployment(string, string)

public static InstallStatusName FromProjectDeployment(string projectId, string deploymentId)

Creates a InstallStatusName with the pattern projects/{project}/deployments/{deployment}/installStatus.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`deploymentId`	`string` The `Deployment` ID. Must not be `null` or empty.

Returns
Type	Description
`InstallStatusName`	A new instance of InstallStatusName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static InstallStatusName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InstallStatusName containing an unparsed resource name.

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

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static InstallStatusName Parse(string installStatusName)

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

Parameter
Name	Description
`installStatusName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`InstallStatusName`	The parsed InstallStatusName if successful.

Remarks

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

projects/{project}/deployments/{deployment}/installStatus

Parse(string, bool)

public static InstallStatusName Parse(string installStatusName, bool allowUnparsed)

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

Parameters
Name	Description
`installStatusName`	`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
`InstallStatusName`	The parsed InstallStatusName if successful.

Remarks

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

projects/{project}/deployments/{deployment}/installStatus

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

public static bool TryParse(string installStatusName, out InstallStatusName result)

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

Parameters
Name	Description
`installStatusName`	`string` The resource name in string form. Must not be `null`.
`result`	`InstallStatusName` When this method returns, the parsed InstallStatusName, 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}/deployments/{deployment}/installStatus

TryParse(string, bool, out InstallStatusName)

public static bool TryParse(string installStatusName, bool allowUnparsed, out InstallStatusName result)

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

Parameters
Name	Description
`installStatusName`	`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`	`InstallStatusName` When this method returns, the parsed InstallStatusName, 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}/deployments/{deployment}/installStatus

Or may be in any format if allowUnparsed is true.

Operators

operator ==(InstallStatusName, InstallStatusName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`InstallStatusName` The first resource name to compare, or null.
`b`	`InstallStatusName` 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.