Cloud Build v1 API - Class BuildTriggerName (2.9.0)

public sealed class BuildTriggerName : IResourceName, IEquatable<BuildTriggerName>

Reference documentation and code samples for the Cloud Build v1 API class BuildTriggerName.

Resource name for the BuildTrigger resource.

Inheritance

object > BuildTriggerName

Implements

IResourceName, IEquatable BuildTriggerName

Inherited Members

object.GetType()

Namespace

Google.Cloud.CloudBuild.V1

Assembly

Google.Cloud.CloudBuild.V1.dll

Constructors

BuildTriggerName(string, string)

public BuildTriggerName(string projectId, string triggerId)

Constructs a new instance of a BuildTriggerName class from the component parts of pattern projects/{project}/triggers/{trigger}

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

LocationId

public string LocationId { get; }

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

Property Value
Type	Description
`string`

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`

TriggerId

public string TriggerId { get; }

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

Property Value
Type	Description
`string`

Type

public BuildTriggerName.ResourceNameType Type { get; }

The BuildTriggerName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`BuildTriggerNameResourceNameType`

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

Formats the IDs into the string representation of this BuildTriggerName with pattern projects/{project}/triggers/{trigger}.

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

Returns
Type	Description
`string`	The string representation of this BuildTriggerName with pattern `projects/{project}/triggers/{trigger}`.

FormatProjectLocationTrigger(string, string, string)

public static string FormatProjectLocationTrigger(string projectId, string locationId, string triggerId)

Formats the IDs into the string representation of this BuildTriggerName with pattern projects/{project}/locations/{location}/triggers/{trigger}.

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.
`triggerId`	`string` The `Trigger` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this BuildTriggerName with pattern `projects/{project}/locations/{location}/triggers/{trigger}`.

FormatProjectTrigger(string, string)

public static string FormatProjectTrigger(string projectId, string triggerId)

Formats the IDs into the string representation of this BuildTriggerName with pattern projects/{project}/triggers/{trigger}.

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

Returns
Type	Description
`string`	The string representation of this BuildTriggerName with pattern `projects/{project}/triggers/{trigger}`.

FromProjectLocationTrigger(string, string, string)

public static BuildTriggerName FromProjectLocationTrigger(string projectId, string locationId, string triggerId)

Creates a BuildTriggerName with the pattern projects/{project}/locations/{location}/triggers/{trigger}.

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.
`triggerId`	`string` The `Trigger` ID. Must not be `null` or empty.

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

FromProjectTrigger(string, string)

public static BuildTriggerName FromProjectTrigger(string projectId, string triggerId)

Creates a BuildTriggerName with the pattern projects/{project}/triggers/{trigger}.

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

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

FromUnparsed(UnparsedResourceName)

public static BuildTriggerName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BuildTriggerName containing an unparsed resource name.

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

Returns
Type	Description
`BuildTriggerName`	A new instance of BuildTriggerName 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 BuildTriggerName Parse(string buildTriggerName)

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

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

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

Remarks

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

projects/{project}/triggers/{trigger}
projects/{project}/locations/{location}/triggers/{trigger}

Parse(string, bool)

public static BuildTriggerName Parse(string buildTriggerName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/triggers/{trigger}
projects/{project}/locations/{location}/triggers/{trigger}

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

public static bool TryParse(string buildTriggerName, out BuildTriggerName result)

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

Parameters
Name	Description
`buildTriggerName`	`string` The resource name in string form. Must not be `null`.
`result`	`BuildTriggerName` When this method returns, the parsed BuildTriggerName, 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}/triggers/{trigger}
projects/{project}/locations/{location}/triggers/{trigger}

TryParse(string, bool, out BuildTriggerName)

public static bool TryParse(string buildTriggerName, bool allowUnparsed, out BuildTriggerName result)

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

Parameters
Name	Description
`buildTriggerName`	`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`	`BuildTriggerName` When this method returns, the parsed BuildTriggerName, 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}/triggers/{trigger}
projects/{project}/locations/{location}/triggers/{trigger}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(BuildTriggerName, BuildTriggerName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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