Google Workspace Add-ons v1 API - Class DeploymentName (2.5.0)

Version latest

• 2.5.0 (latest)
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.1.0
• 1.0.0

public sealed class DeploymentName : IResourceName, IEquatable<DeploymentName>

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

Resource name for the Deployment resource.

Inheritance

object > DeploymentName

Implements

IResourceName, IEquatableDeploymentName

Inherited Members

object.GetType()

Namespace

Google.Cloud.GSuiteAddOns.V1

Assembly

Google.Cloud.GSuiteAddOns.V1.dll

Constructors

DeploymentName(string, string)

public DeploymentName(string projectId, string deploymentId)

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

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 DeploymentName.ResourceNameType Type { get; }

The DeploymentName.ResourceNameType of the contained resource name.

Property Value
Type	Description
DeploymentNameResourceNameType

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 DeploymentName with pattern projects/{project}/deployments/{deployment}.

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 DeploymentName with pattern projects/{project}/deployments/{deployment}.

FormatProjectDeployment(string, string)

public static string FormatProjectDeployment(string projectId, string deploymentId)

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

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 DeploymentName with pattern projects/{project}/deployments/{deployment}.

FromProjectDeployment(string, string)

public static DeploymentName FromProjectDeployment(string projectId, string deploymentId)

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

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
DeploymentName	A new instance of DeploymentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DeploymentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DeploymentName containing an unparsed resource name.

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

Returns
Type	Description
DeploymentName	A new instance of DeploymentName 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 DeploymentName Parse(string deploymentName)

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

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

Returns
Type	Description
DeploymentName	The parsed DeploymentName if successful.

Remarks

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

• projects/{project}/deployments/{deployment}

Parse(string, bool)

public static DeploymentName Parse(string deploymentName, bool allowUnparsed)

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

Parameters
Name	Description
deploymentName	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
DeploymentName	The parsed DeploymentName if successful.

Remarks

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

• projects/{project}/deployments/{deployment}

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

public static bool TryParse(string deploymentName, out DeploymentName result)

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

Parameters
Name	Description
deploymentName	string The resource name in string form. Must not be null.
result	DeploymentName When this method returns, the parsed DeploymentName, 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}

TryParse(string, bool, out DeploymentName)

public static bool TryParse(string deploymentName, bool allowUnparsed, out DeploymentName result)

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

Parameters
Name	Description
deploymentName	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	DeploymentName When this method returns, the parsed DeploymentName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DeploymentName, DeploymentName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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