BigQuery Migration v2 API - Class MigrationWorkflowName (1.3.0)

public sealed class MigrationWorkflowName : IResourceName, IEquatable<MigrationWorkflowName>

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

Resource name for the MigrationWorkflow resource.

Inheritance

object > MigrationWorkflowName

Namespace

Google.Cloud.BigQuery.Migration.V2

Assembly

Google.Cloud.BigQuery.Migration.V2.dll

Constructors

MigrationWorkflowName(string, string, string)

public MigrationWorkflowName(string projectId, string locationId, string workflowId)

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

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.

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

Type

public MigrationWorkflowName.ResourceNameType Type { get; }

The MigrationWorkflowName.ResourceNameType of the contained resource name.

Property Value
Type Description
MigrationWorkflowNameResourceNameType

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)

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

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

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.

Returns
Type Description
string

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

FormatProjectLocationWorkflow(string, string, string)

public static string FormatProjectLocationWorkflow(string projectId, string locationId, string workflowId)

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

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.

Returns
Type Description
string

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

FromProjectLocationWorkflow(string, string, string)

public static MigrationWorkflowName FromProjectLocationWorkflow(string projectId, string locationId, string workflowId)

Creates a MigrationWorkflowName with the pattern projects/{project}/locations/{location}/workflows/{workflow}.

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.

Returns
Type Description
MigrationWorkflowName

A new instance of MigrationWorkflowName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MigrationWorkflowName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MigrationWorkflowName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
MigrationWorkflowName

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

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

Parameter
Name Description
migrationWorkflowName string

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

Returns
Type Description
MigrationWorkflowName

The parsed MigrationWorkflowName if successful.

Remarks

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

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

Parse(string, bool)

public static MigrationWorkflowName Parse(string migrationWorkflowName, bool allowUnparsed)

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

Parameters
Name Description
migrationWorkflowName 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
MigrationWorkflowName

The parsed MigrationWorkflowName if successful.

Remarks

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

  • projects/{project}/locations/{location}/workflows/{workflow}
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 MigrationWorkflowName)

public static bool TryParse(string migrationWorkflowName, out MigrationWorkflowName result)

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

Parameters
Name Description
migrationWorkflowName string

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

result MigrationWorkflowName

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

TryParse(string, bool, out MigrationWorkflowName)

public static bool TryParse(string migrationWorkflowName, bool allowUnparsed, out MigrationWorkflowName result)

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

Parameters
Name Description
migrationWorkflowName 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 MigrationWorkflowName

When this method returns, the parsed MigrationWorkflowName, 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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(MigrationWorkflowName, MigrationWorkflowName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a MigrationWorkflowName

The first resource name to compare, or null.

b MigrationWorkflowName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a MigrationWorkflowName

The first resource name to compare, or null.

b MigrationWorkflowName

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.