Class DeploymentName

public sealed class DeploymentName : IResourceName, IEquatable<DeploymentName>

Resource name for the Deployment resource.

Inheritance

Object > DeploymentName

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

DeploymentName(String, String, String, String, String)

public DeploymentName(string projectId, string locationId, string agentId, string environmentId, string deploymentId)

Constructs a new instance of a DeploymentName class from the component parts of pattern projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/deployments/{deployment}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

agentIdString

The Agent ID. Must not be null or empty.

environmentIdString

The Environment ID. Must not be null or empty.

deploymentIdString

The Deployment ID. Must not be null or empty.

Properties

AgentId

public string AgentId { get; }

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

Property Value
TypeDescription
String

DeploymentId

public string DeploymentId { get; }

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

Property Value
TypeDescription
String

EnvironmentId

public string EnvironmentId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public DeploymentName.ResourceNameType Type { get; }

The DeploymentName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
DeploymentName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String, String, String, String, String)

public static string Format(string projectId, string locationId, string agentId, string environmentId, string deploymentId)

Formats the IDs into the string representation of this DeploymentName with pattern projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/deployments/{deployment} .

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

agentIdString

The Agent ID. Must not be null or empty.

environmentIdString

The Environment ID. Must not be null or empty.

deploymentIdString

The Deployment ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this DeploymentName with pattern projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/deployments/{deployment} .

FormatProjectLocationAgentEnvironmentDeployment(String, String, String, String, String)

public static string FormatProjectLocationAgentEnvironmentDeployment(string projectId, string locationId, string agentId, string environmentId, string deploymentId)

Formats the IDs into the string representation of this DeploymentName with pattern projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/deployments/{deployment} .

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

agentIdString

The Agent ID. Must not be null or empty.

environmentIdString

The Environment ID. Must not be null or empty.

deploymentIdString

The Deployment ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this DeploymentName with pattern projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/deployments/{deployment} .

FromProjectLocationAgentEnvironmentDeployment(String, String, String, String, String)

public static DeploymentName FromProjectLocationAgentEnvironmentDeployment(string projectId, string locationId, string agentId, string environmentId, string deploymentId)

Creates a DeploymentName with the pattern projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/deployments/{deployment} .

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

agentIdString

The Agent ID. Must not be null or empty.

environmentIdString

The Environment ID. Must not be null or empty.

deploymentIdString

The Deployment ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
DeploymentName

A new instance of DeploymentName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static DeploymentName Parse(string deploymentName)

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

Parameter
NameDescription
deploymentNameString

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

Returns
TypeDescription
DeploymentName

The parsed DeploymentName if successful.

Remarks

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

  • projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/deployments/{deployment}

Parse(String, Boolean)

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
NameDescription
deploymentNameString

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
DeploymentName

The parsed DeploymentName if successful.

Remarks

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

  • projects/{project}/locations/{location}/agents/{agent}/environments/{environment}/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
TypeDescription
String

The string representation of the resource name.

Overrides

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
NameDescription
deploymentNameString

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

resultDeploymentName

When this method returns, the parsed DeploymentName, 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}/locations/{location}/agents/{agent}/environments/{environment}/deployments/{deployment}

TryParse(String, Boolean, 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
NameDescription
deploymentNameString

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.

resultDeploymentName

When this method returns, the parsed DeploymentName, 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}/locations/{location}/agents/{agent}/environments/{environment}/deployments/{deployment}
Or may be in any format if allowUnparsed is true.

Operators

Equality(DeploymentName, DeploymentName)

public static bool operator ==(DeploymentName a, DeploymentName b)
Parameters
NameDescription
aDeploymentName
bDeploymentName
Returns
TypeDescription
Boolean

Inequality(DeploymentName, DeploymentName)

public static bool operator !=(DeploymentName a, DeploymentName b)
Parameters
NameDescription
aDeploymentName
bDeploymentName
Returns
TypeDescription
Boolean