Developer Connect v1 API - Class DeploymentEventName (1.0.0-beta04)

public sealed class DeploymentEventName : IResourceName, IEquatable<DeploymentEventName>

Reference documentation and code samples for the Developer Connect v1 API class DeploymentEventName.

Resource name for the DeploymentEvent resource.

Inheritance

object > DeploymentEventName

Namespace

Google.Cloud.DeveloperConnect.V1

Assembly

Google.Cloud.DeveloperConnect.V1.dll

Constructors

DeploymentEventName(string, string, string, string)

public DeploymentEventName(string projectId, string locationId, string insightsConfigId, string deploymentEventId)

Constructs a new instance of a DeploymentEventName class from the component parts of pattern projects/{project}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{deployment_event}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

insightsConfigId string

The InsightsConfig ID. Must not be null or empty.

deploymentEventId string

The DeploymentEvent ID. Must not be null or empty.

Properties

DeploymentEventId

public string DeploymentEventId { get; }

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

Property Value
Type Description
string

InsightsConfigId

public string InsightsConfigId { get; }

The InsightsConfig 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

LocationId

public string LocationId { get; }

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

Property Value
Type Description
string

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

The DeploymentEventName.ResourceNameType of the contained resource name.

Property Value
Type Description
DeploymentEventNameResourceNameType

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, string, string)

public static string Format(string projectId, string locationId, string insightsConfigId, string deploymentEventId)

Formats the IDs into the string representation of this DeploymentEventName with pattern projects/{project}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{deployment_event} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

insightsConfigId string

The InsightsConfig ID. Must not be null or empty.

deploymentEventId string

The DeploymentEvent ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DeploymentEventName with pattern projects/{project}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{deployment_event} .

FormatProjectLocationInsightsConfigDeploymentEvent(string, string, string, string)

public static string FormatProjectLocationInsightsConfigDeploymentEvent(string projectId, string locationId, string insightsConfigId, string deploymentEventId)

Formats the IDs into the string representation of this DeploymentEventName with pattern projects/{project}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{deployment_event} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

insightsConfigId string

The InsightsConfig ID. Must not be null or empty.

deploymentEventId string

The DeploymentEvent ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this DeploymentEventName with pattern projects/{project}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{deployment_event} .

FromProjectLocationInsightsConfigDeploymentEvent(string, string, string, string)

public static DeploymentEventName FromProjectLocationInsightsConfigDeploymentEvent(string projectId, string locationId, string insightsConfigId, string deploymentEventId)

Creates a DeploymentEventName with the pattern projects/{project}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{deployment_event} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

insightsConfigId string

The InsightsConfig ID. Must not be null or empty.

deploymentEventId string

The DeploymentEvent ID. Must not be null or empty.

Returns
Type Description
DeploymentEventName

A new instance of DeploymentEventName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DeploymentEventName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DeploymentEventName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
DeploymentEventName

A new instance of DeploymentEventName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static DeploymentEventName Parse(string deploymentEventName)

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

Parameter
Name Description
deploymentEventName string

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

Returns
Type Description
DeploymentEventName

The parsed DeploymentEventName if successful.

Remarks

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

  • projects/{project}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{deployment_event}

Parse(string, bool)

public static DeploymentEventName Parse(string deploymentEventName, bool allowUnparsed)

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

Parameters
Name Description
deploymentEventName 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
DeploymentEventName

The parsed DeploymentEventName if successful.

Remarks

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

  • projects/{project}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{deployment_event}
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

TryParse(string, out DeploymentEventName)

public static bool TryParse(string deploymentEventName, out DeploymentEventName result)

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

Parameters
Name Description
deploymentEventName string

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

result DeploymentEventName

When this method returns, the parsed DeploymentEventName, 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}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{deployment_event}

TryParse(string, bool, out DeploymentEventName)

public static bool TryParse(string deploymentEventName, bool allowUnparsed, out DeploymentEventName result)

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

Parameters
Name Description
deploymentEventName 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 DeploymentEventName

When this method returns, the parsed DeploymentEventName, 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}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{deployment_event}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DeploymentEventName, DeploymentEventName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DeploymentEventName

The first resource name to compare, or null.

b DeploymentEventName

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 !=(DeploymentEventName, DeploymentEventName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DeploymentEventName

The first resource name to compare, or null.

b DeploymentEventName

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.