Dataform v1beta1 API - Class CompilationResultName (1.0.0-beta06)

public sealed class CompilationResultName : IResourceName, IEquatable<CompilationResultName>

Reference documentation and code samples for the Dataform v1beta1 API class CompilationResultName.

Resource name for the CompilationResult resource.

Inheritance

object > CompilationResultName

Namespace

Google.Cloud.Dataform.V1Beta1

Assembly

Google.Cloud.Dataform.V1Beta1.dll

Constructors

CompilationResultName(string, string, string, string)

public CompilationResultName(string projectId, string locationId, string repositoryId, string compilationResultId)

Constructs a new instance of a CompilationResultName class from the component parts of pattern projects/{project}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result}

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.

repositoryId string

The Repository ID. Must not be null or empty.

compilationResultId string

The CompilationResult ID. Must not be null or empty.

Properties

CompilationResultId

public string CompilationResultId { get; }

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

RepositoryId

public string RepositoryId { get; }

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

Property Value
Type Description
string

Type

public CompilationResultName.ResourceNameType Type { get; }

The CompilationResultName.ResourceNameType of the contained resource name.

Property Value
Type Description
CompilationResultNameResourceNameType

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

Formats the IDs into the string representation of this CompilationResultName with pattern projects/{project}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result} .

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.

repositoryId string

The Repository ID. Must not be null or empty.

compilationResultId string

The CompilationResult ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this CompilationResultName with pattern projects/{project}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result} .

FormatProjectLocationRepositoryCompilationResult(string, string, string, string)

public static string FormatProjectLocationRepositoryCompilationResult(string projectId, string locationId, string repositoryId, string compilationResultId)

Formats the IDs into the string representation of this CompilationResultName with pattern projects/{project}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result} .

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.

repositoryId string

The Repository ID. Must not be null or empty.

compilationResultId string

The CompilationResult ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this CompilationResultName with pattern projects/{project}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result} .

FromProjectLocationRepositoryCompilationResult(string, string, string, string)

public static CompilationResultName FromProjectLocationRepositoryCompilationResult(string projectId, string locationId, string repositoryId, string compilationResultId)

Creates a CompilationResultName with the pattern projects/{project}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result} .

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.

repositoryId string

The Repository ID. Must not be null or empty.

compilationResultId string

The CompilationResult ID. Must not be null or empty.

Returns
Type Description
CompilationResultName

A new instance of CompilationResultName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CompilationResultName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CompilationResultName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
CompilationResultName

A new instance of CompilationResultName 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 CompilationResultName Parse(string compilationResultName)

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

Parameter
Name Description
compilationResultName string

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

Returns
Type Description
CompilationResultName

The parsed CompilationResultName if successful.

Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result}

Parse(string, bool)

public static CompilationResultName Parse(string compilationResultName, bool allowUnparsed)

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

Parameters
Name Description
compilationResultName 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
CompilationResultName

The parsed CompilationResultName if successful.

Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result}
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 CompilationResultName)

public static bool TryParse(string compilationResultName, out CompilationResultName result)

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

Parameters
Name Description
compilationResultName string

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

result CompilationResultName

When this method returns, the parsed CompilationResultName, 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}/repositories/{repository}/compilationResults/{compilation_result}

TryParse(string, bool, out CompilationResultName)

public static bool TryParse(string compilationResultName, bool allowUnparsed, out CompilationResultName result)

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

Parameters
Name Description
compilationResultName 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 CompilationResultName

When this method returns, the parsed CompilationResultName, 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}/repositories/{repository}/compilationResults/{compilation_result}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(CompilationResultName, CompilationResultName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CompilationResultName

The first resource name to compare, or null.

b CompilationResultName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CompilationResultName

The first resource name to compare, or null.

b CompilationResultName

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.