Cloud Build v1 API - Class BuildName (2.3.0)

Version 2.3.0

• 2.13.0 (latest)
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class BuildName : IResourceName, IEquatable<BuildName>

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

Resource name for the Build resource.

Inheritance

object > BuildName

Implements

IResourceName, IEquatableBuildName

Inherited Members

object.GetType()

Namespace

GoogleCloudGoogle.Cloud.CloudBuildV1

Assembly

Google.Cloud.CloudBuild.V1.dll

Constructors

BuildName(string, string)

public BuildName(string projectId, string buildId)

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

Parameters
Name	Description
projectId	string The Project 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. May be null, depending on which resource name is contained by this instance.

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. 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

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)

public static string Format(string projectId, string buildId)

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

Parameters
Name	Description
projectId	string The Project 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}/builds/{build} .

FormatProjectBuild(string, string)

public static string FormatProjectBuild(string projectId, string buildId)

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

Parameters
Name	Description
projectId	string The Project 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}/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}.

FromProjectBuild(string, string)

public static BuildName FromProjectBuild(string projectId, string buildId)

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

Parameters
Name	Description
projectId	string The Project 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.

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}/builds/{build}
• 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}/builds/{build}
• 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}/builds/{build}
• 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}/builds/{build}
• 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)

Parameters
Name	Description
a	BuildName
b	BuildName

Returns
Type	Description
bool

operator !=(BuildName, BuildName)

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

Parameters
Name	Description
a	BuildName
b	BuildName

Returns
Type	Description
bool