BigQuery Migration v2 API - Class MigrationSubtaskName (1.1.0)

public sealed class MigrationSubtaskName : IResourceName, IEquatable<MigrationSubtaskName>

Reference documentation and code samples for the BigQuery Migration v2 API class MigrationSubtaskName.

Resource name for the MigrationSubtask resource.

Inheritance

object > MigrationSubtaskName

Namespace

GoogleGoogle.CloudGoogle.Cloud.BigQueryGoogle.Cloud.BigQuery.MigrationV2

Assembly

Google.Cloud.BigQuery.Migration.V2.dll

Constructors

MigrationSubtaskName(string, string, string, string)

public MigrationSubtaskName(string projectId, string locationId, string workflowId, string subtaskId)

Constructs a new instance of a MigrationSubtaskName class from the component parts of pattern projects/{project}/locations/{location}/workflows/{workflow}/subtasks/{subtask}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

workflowIdstring

The Workflow ID. Must not be null or empty.

subtaskIdstring

The Subtask 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
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

SubtaskId

public string SubtaskId { get; }

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

Property Value
TypeDescription
string

Type

public MigrationSubtaskName.ResourceNameType Type { get; }

The MigrationSubtaskName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
MigrationSubtaskNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

WorkflowId

public string WorkflowId { get; }

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

Property Value
TypeDescription
string

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string workflowId, string subtaskId)

Formats the IDs into the string representation of this MigrationSubtaskName with pattern projects/{project}/locations/{location}/workflows/{workflow}/subtasks/{subtask}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

workflowIdstring

The Workflow ID. Must not be null or empty.

subtaskIdstring

The Subtask ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this MigrationSubtaskName with pattern projects/{project}/locations/{location}/workflows/{workflow}/subtasks/{subtask}.

FormatProjectLocationWorkflowSubtask(string, string, string, string)

public static string FormatProjectLocationWorkflowSubtask(string projectId, string locationId, string workflowId, string subtaskId)

Formats the IDs into the string representation of this MigrationSubtaskName with pattern projects/{project}/locations/{location}/workflows/{workflow}/subtasks/{subtask}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

workflowIdstring

The Workflow ID. Must not be null or empty.

subtaskIdstring

The Subtask ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this MigrationSubtaskName with pattern projects/{project}/locations/{location}/workflows/{workflow}/subtasks/{subtask}.

FromProjectLocationWorkflowSubtask(string, string, string, string)

public static MigrationSubtaskName FromProjectLocationWorkflowSubtask(string projectId, string locationId, string workflowId, string subtaskId)

Creates a MigrationSubtaskName with the pattern projects/{project}/locations/{location}/workflows/{workflow}/subtasks/{subtask}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

workflowIdstring

The Workflow ID. Must not be null or empty.

subtaskIdstring

The Subtask ID. Must not be null or empty.

Returns
TypeDescription
MigrationSubtaskName

A new instance of MigrationSubtaskName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MigrationSubtaskName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MigrationSubtaskName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
MigrationSubtaskName

A new instance of MigrationSubtaskName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static MigrationSubtaskName Parse(string migrationSubtaskName)

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

Parameter
NameDescription
migrationSubtaskNamestring

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

Returns
TypeDescription
MigrationSubtaskName

The parsed MigrationSubtaskName if successful.

Remarks

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

  • projects/{project}/locations/{location}/workflows/{workflow}/subtasks/{subtask}

Parse(string, bool)

public static MigrationSubtaskName Parse(string migrationSubtaskName, bool allowUnparsed)

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

Parameters
NameDescription
migrationSubtaskNamestring

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

allowUnparsedbool

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
TypeDescription
MigrationSubtaskName

The parsed MigrationSubtaskName if successful.

Remarks

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

  • projects/{project}/locations/{location}/workflows/{workflow}/subtasks/{subtask}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out MigrationSubtaskName)

public static bool TryParse(string migrationSubtaskName, out MigrationSubtaskName result)

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

Parameters
NameDescription
migrationSubtaskNamestring

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

resultMigrationSubtaskName

When this method returns, the parsed MigrationSubtaskName, or null if parsing failed.

Returns
TypeDescription
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}/workflows/{workflow}/subtasks/{subtask}

TryParse(string, bool, out MigrationSubtaskName)

public static bool TryParse(string migrationSubtaskName, bool allowUnparsed, out MigrationSubtaskName result)

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

Parameters
NameDescription
migrationSubtaskNamestring

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

allowUnparsedbool

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.

resultMigrationSubtaskName

When this method returns, the parsed MigrationSubtaskName, or null if parsing failed.

Returns
TypeDescription
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}/workflows/{workflow}/subtasks/{subtask}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(MigrationSubtaskName, MigrationSubtaskName)

public static bool operator ==(MigrationSubtaskName a, MigrationSubtaskName b)
Parameters
NameDescription
aMigrationSubtaskName
bMigrationSubtaskName
Returns
TypeDescription
bool

operator !=(MigrationSubtaskName, MigrationSubtaskName)

public static bool operator !=(MigrationSubtaskName a, MigrationSubtaskName b)
Parameters
NameDescription
aMigrationSubtaskName
bMigrationSubtaskName
Returns
TypeDescription
bool