Cloud Functions v2 API - Class BuildName (1.5.0)

public sealed class BuildName : IResourceName, IEquatable<BuildName>

Reference documentation and code samples for the Cloud Functions v2 API class BuildName.

Resource name for the Build resource.

Inheritance

object > BuildName

Implements

IResourceName, IEquatable BuildName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Functions.V2

Assembly

Google.Cloud.Functions.V2.dll

Constructors

BuildName(string, string, string)

public BuildName(string projectId, string locationId, string buildId)

Constructs a new instance of a BuildName class from the component parts of pattern projects/{project}/locations/{location}/builds/{build}

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

Properties

BuildId

public string BuildId { get; }

The Build 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 BuildName.ResourceNameType Type { get; }

The BuildName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`BuildNameResourceNameType`

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)

public static string Format(string projectId, string locationId, string buildId)

Formats the IDs into the string representation of this BuildName with pattern projects/{project}/locations/{location}/builds/{build}.

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

Returns
Type	Description
`string`	The string representation of this BuildName with pattern `projects/{project}/locations/{location}/builds/{build}`.

FormatProjectLocationBuild(string, string, string)

public static string FormatProjectLocationBuild(string projectId, string locationId, string buildId)

Formats the IDs into the string representation of this BuildName with pattern projects/{project}/locations/{location}/builds/{build}.

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

Returns
Type	Description
`string`	The string representation of this BuildName with pattern `projects/{project}/locations/{location}/builds/{build}`.

FromProjectLocationBuild(string, string, string)

public static BuildName FromProjectLocationBuild(string projectId, string locationId, string buildId)

Creates a BuildName with the pattern projects/{project}/locations/{location}/builds/{build} .

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

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

FromUnparsed(UnparsedResourceName)

public static BuildName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BuildName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/builds/{build}

Parse(string, bool)

public static BuildName Parse(string buildName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/builds/{build}

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

public static bool TryParse(string buildName, out BuildName result)

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

Parameters
Name	Description
`buildName`	`string` The resource name in string form. Must not be `null`.
`result`	`BuildName` When this method returns, the parsed BuildName, 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}/builds/{build}

TryParse(string, bool, out BuildName)

public static bool TryParse(string buildName, bool allowUnparsed, out BuildName result)

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

Parameters
Name	Description
`buildName`	`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`	`BuildName` When this method returns, the parsed BuildName, 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}/builds/{build}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(BuildName, BuildName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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