Google BigQuery Data Transfer v1 API - Class RunName (4.10.0) 

public sealed class RunName : IResourceName, IEquatable<RunName>

Reference documentation and code samples for the Google BigQuery Data Transfer v1 API class RunName.

Resource name for the Run resource.

Inheritance

object > RunName

Namespace

Google.Cloud.BigQuery.DataTransfer.V1

Assembly

Google.Cloud.BigQuery.DataTransfer.V1.dll

Constructors

RunName(string, string, string)

public RunName(string projectId, string transferConfigId, string runId)

Constructs a new instance of a RunName class from the component parts of pattern projects/{project}/transferConfigs/{transfer_config}/runs/{run}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
transferConfigId string

The TransferConfig ID. Must not be null or empty.
runId string

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

RunId

public string RunId { get; }

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

Property Value
Type Description
string

TransferConfigId

public string TransferConfigId { get; }

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

Property Value
Type Description
string

Type

public RunName.ResourceNameType Type { get; }

The RunName.ResourceNameType of the contained resource name.

Property Value
Type Description
RunNameResourceNameType

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

Formats the IDs into the string representation of this RunName with pattern projects/{project}/transferConfigs/{transfer_config}/runs/{run}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
transferConfigId string

The TransferConfig ID. Must not be null or empty.
runId string

The Run ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this RunName with pattern projects/{project}/transferConfigs/{transfer_config}/runs/{run}.

FormatProjectLocationTransferConfigRun(string, string, string, string)

public static string FormatProjectLocationTransferConfigRun(string projectId, string locationId, string transferConfigId, string runId)

Formats the IDs into the string representation of this RunName with pattern projects/{project}/locations/{location}/transferConfigs/{transfer_config}/runs/{run}.

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

The TransferConfig ID. Must not be null or empty.
runId string

The Run ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this RunName with pattern projects/{project}/locations/{location}/transferConfigs/{transfer_config}/runs/{run}.

FormatProjectTransferConfigRun(string, string, string)

public static string FormatProjectTransferConfigRun(string projectId, string transferConfigId, string runId)

Formats the IDs into the string representation of this RunName with pattern projects/{project}/transferConfigs/{transfer_config}/runs/{run}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
transferConfigId string

The TransferConfig ID. Must not be null or empty.
runId string

The Run ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this RunName with pattern projects/{project}/transferConfigs/{transfer_config}/runs/{run}.

FromProjectLocationTransferConfigRun(string, string, string, string)

public static RunName FromProjectLocationTransferConfigRun(string projectId, string locationId, string transferConfigId, string runId)

Creates a RunName with the pattern projects/{project}/locations/{location}/transferConfigs/{transfer_config}/runs/{run}.

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

The TransferConfig ID. Must not be null or empty.
runId string

The Run ID. Must not be null or empty.
Returns
Type Description
RunName

A new instance of RunName constructed from the provided ids.

FromProjectTransferConfigRun(string, string, string)

public static RunName FromProjectTransferConfigRun(string projectId, string transferConfigId, string runId)

Creates a RunName with the pattern projects/{project}/transferConfigs/{transfer_config}/runs/{run}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
transferConfigId string

The TransferConfig ID. Must not be null or empty.
runId string

The Run ID. Must not be null or empty.
Returns
Type Description
RunName

A new instance of RunName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RunName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RunName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
RunName

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

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

Parameter
Name Description
runName string

The resource name in string form. Must not be null.
Returns
Type Description
RunName

The parsed RunName if successful.
Remarks

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

  • projects/{project}/transferConfigs/{transfer_config}/runs/{run}
  • projects/{project}/locations/{location}/transferConfigs/{transfer_config}/runs/{run}

Parse(string, bool)

public static RunName Parse(string runName, bool allowUnparsed)

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

Parameters
Name Description
runName 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
RunName

The parsed RunName if successful.
Remarks

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

  • projects/{project}/transferConfigs/{transfer_config}/runs/{run}
  • projects/{project}/locations/{location}/transferConfigs/{transfer_config}/runs/{run}
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 RunName)

public static bool TryParse(string runName, out RunName result)

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

Parameters
Name Description
runName string

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

When this method returns, the parsed RunName, 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}/transferConfigs/{transfer_config}/runs/{run}
  • projects/{project}/locations/{location}/transferConfigs/{transfer_config}/runs/{run}

TryParse(string, bool, out RunName)

public static bool TryParse(string runName, bool allowUnparsed, out RunName result)

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

Parameters
Name Description
runName 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 RunName

When this method returns, the parsed RunName, 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}/transferConfigs/{transfer_config}/runs/{run}
  • projects/{project}/locations/{location}/transferConfigs/{transfer_config}/runs/{run}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(RunName, RunName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RunName

The first resource name to compare, or null.
b RunName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RunName

The first resource name to compare, or null.
b RunName

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.