Database Migration v1 API - Class ConversionWorkspaceName (2.4.0)

public sealed class ConversionWorkspaceName : IResourceName, IEquatable<ConversionWorkspaceName>

Reference documentation and code samples for the Database Migration v1 API class ConversionWorkspaceName.

Resource name for the ConversionWorkspace resource.

Inheritance

object > ConversionWorkspaceName

Namespace

Google.Cloud.CloudDms.V1

Assembly

Google.Cloud.CloudDms.V1.dll

Constructors

ConversionWorkspaceName(string, string, string)

public ConversionWorkspaceName(string projectId, string locationId, string conversionWorkspaceId)

Constructs a new instance of a ConversionWorkspaceName class from the component parts of pattern projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

conversionWorkspaceIdstring

The ConversionWorkspace ID. Must not be null or empty.

Properties

ConversionWorkspaceId

public string ConversionWorkspaceId { get; }

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

Property Value
TypeDescription
string

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

Type

public ConversionWorkspaceName.ResourceNameType Type { get; }

The ConversionWorkspaceName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ConversionWorkspaceNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string)

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

Formats the IDs into the string representation of this ConversionWorkspaceName with pattern projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

conversionWorkspaceIdstring

The ConversionWorkspace ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ConversionWorkspaceName with pattern projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

FormatProjectLocationConversionWorkspace(string, string, string)

public static string FormatProjectLocationConversionWorkspace(string projectId, string locationId, string conversionWorkspaceId)

Formats the IDs into the string representation of this ConversionWorkspaceName with pattern projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

conversionWorkspaceIdstring

The ConversionWorkspace ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ConversionWorkspaceName with pattern projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

FromProjectLocationConversionWorkspace(string, string, string)

public static ConversionWorkspaceName FromProjectLocationConversionWorkspace(string projectId, string locationId, string conversionWorkspaceId)

Creates a ConversionWorkspaceName with the pattern projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

conversionWorkspaceIdstring

The ConversionWorkspace ID. Must not be null or empty.

Returns
TypeDescription
ConversionWorkspaceName

A new instance of ConversionWorkspaceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ConversionWorkspaceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ConversionWorkspaceName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ConversionWorkspaceName

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

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

Parameter
NameDescription
conversionWorkspaceNamestring

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

Returns
TypeDescription
ConversionWorkspaceName

The parsed ConversionWorkspaceName if successful.

Remarks

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

  • projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}

Parse(string, bool)

public static ConversionWorkspaceName Parse(string conversionWorkspaceName, bool allowUnparsed)

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

Parameters
NameDescription
conversionWorkspaceNamestring

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
ConversionWorkspaceName

The parsed ConversionWorkspaceName if successful.

Remarks

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

  • projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}
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 ConversionWorkspaceName)

public static bool TryParse(string conversionWorkspaceName, out ConversionWorkspaceName result)

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

Parameters
NameDescription
conversionWorkspaceNamestring

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

resultConversionWorkspaceName

When this method returns, the parsed ConversionWorkspaceName, 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}/conversionWorkspaces/{conversion_workspace}

TryParse(string, bool, out ConversionWorkspaceName)

public static bool TryParse(string conversionWorkspaceName, bool allowUnparsed, out ConversionWorkspaceName result)

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

Parameters
NameDescription
conversionWorkspaceNamestring

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.

resultConversionWorkspaceName

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

Operators

operator ==(ConversionWorkspaceName, ConversionWorkspaceName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aConversionWorkspaceName

The first resource name to compare, or null.

bConversionWorkspaceName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(ConversionWorkspaceName, ConversionWorkspaceName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aConversionWorkspaceName

The first resource name to compare, or null.

bConversionWorkspaceName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.