BigQuery Migration v2 API - Class MigrationSubtaskName (1.5.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

Google.Cloud.BigQuery.Migration.V2

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
Name Description
projectId string

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

The Location ID. Must not be null or empty.
workflowId string

The Workflow ID. Must not be null or empty.
subtaskId string

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

SubtaskId

public string SubtaskId { get; }

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

Property Value
Type Description
string

Type

public MigrationSubtaskName.ResourceNameType Type { get; }

The MigrationSubtaskName.ResourceNameType of the contained resource name.

Property Value
Type Description
MigrationSubtaskNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

WorkflowId

public string WorkflowId { get; }

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

Property Value
Type Description
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
Name Description
projectId string

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

The Location ID. Must not be null or empty.
workflowId string

The Workflow ID. Must not be null or empty.
subtaskId string

The Subtask ID. Must not be null or empty.
Returns
Type Description
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
Name Description
projectId string

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

The Location ID. Must not be null or empty.
workflowId string

The Workflow ID. Must not be null or empty.
subtaskId string

The Subtask ID. Must not be null or empty.
Returns
Type Description
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
Name Description
projectId string

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

The Location ID. Must not be null or empty.
workflowId string

The Workflow ID. Must not be null or empty.
subtaskId string

The Subtask ID. Must not be null or empty.
Returns
Type Description
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
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
migrationSubtaskName string

The resource name in string form. Must not be null.
Returns
Type Description
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
Name Description
migrationSubtaskName 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
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
Type Description
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
Name Description
migrationSubtaskName string

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

When this method returns, the parsed MigrationSubtaskName, 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}/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
Name Description
migrationSubtaskName 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 MigrationSubtaskName

When this method returns, the parsed MigrationSubtaskName, 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}/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)

Determines whether two specified resource names have the same value.

Parameters
Name Description
a MigrationSubtaskName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a MigrationSubtaskName

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

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.