VM Migration v1 API - Class TargetProjectName (2.3.0)

public sealed class TargetProjectName : IResourceName, IEquatable<TargetProjectName>

Reference documentation and code samples for the VM Migration v1 API class TargetProjectName.

Resource name for the TargetProject resource.

Inheritance

Object > TargetProjectName

Implements

IResourceName, IEquatable<TargetProjectName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.VMMigration.V1

Assembly

Google.Cloud.VMMigration.V1.dll

Constructors

TargetProjectName(String, String, String)

public TargetProjectName(string projectId, string locationId, string targetProjectId)

Constructs a new instance of a TargetProjectName class from the component parts of pattern projects/{project}/locations/{location}/targetProjects/{target_project}

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.
`targetProjectId`	`String` The `TargetProject` 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
`Boolean`

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`

TargetProjectId

public string TargetProjectId { get; }

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

Property Value
Type	Description
`String`

Type

public TargetProjectName.ResourceNameType Type { get; }

The TargetProjectName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`TargetProjectName.ResourceNameType`

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 locationId, string targetProjectId)

Formats the IDs into the string representation of this TargetProjectName with pattern projects/{project}/locations/{location}/targetProjects/{target_project}.

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.
`targetProjectId`	`String` The `TargetProject` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this TargetProjectName with pattern `projects/{project}/locations/{location}/targetProjects/{target_project}`.

FormatProjectLocationTargetProject(String, String, String)

public static string FormatProjectLocationTargetProject(string projectId, string locationId, string targetProjectId)

Formats the IDs into the string representation of this TargetProjectName with pattern projects/{project}/locations/{location}/targetProjects/{target_project}.

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.
`targetProjectId`	`String` The `TargetProject` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this TargetProjectName with pattern `projects/{project}/locations/{location}/targetProjects/{target_project}`.

FromProjectLocationTargetProject(String, String, String)

public static TargetProjectName FromProjectLocationTargetProject(string projectId, string locationId, string targetProjectId)

Creates a TargetProjectName with the pattern projects/{project}/locations/{location}/targetProjects/{target_project}.

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.
`targetProjectId`	`String` The `TargetProject` ID. Must not be `null` or empty.

Returns
Type	Description
`TargetProjectName`	A new instance of TargetProjectName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TargetProjectName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TargetProjectName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`TargetProjectName`	A new instance of TargetProjectName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static TargetProjectName Parse(string targetProjectName)

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

Parameter
Name	Description
`targetProjectName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`TargetProjectName`	The parsed TargetProjectName if successful.

Remarks

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

projects/{project}/locations/{location}/targetProjects/{target_project}

Parse(String, Boolean)

public static TargetProjectName Parse(string targetProjectName, bool allowUnparsed)

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

Parameters
Name	Description
`targetProjectName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`TargetProjectName`	The parsed TargetProjectName if successful.

Remarks

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

projects/{project}/locations/{location}/targetProjects/{target_project}

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

Object.ToString()

TryParse(String, out TargetProjectName)

public static bool TryParse(string targetProjectName, out TargetProjectName result)

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

Parameters
Name	Description
`targetProjectName`	`String` The resource name in string form. Must not be `null`.
`result`	`TargetProjectName` When this method returns, the parsed TargetProjectName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`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}/targetProjects/{target_project}

TryParse(String, Boolean, out TargetProjectName)

public static bool TryParse(string targetProjectName, bool allowUnparsed, out TargetProjectName result)

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

Parameters
Name	Description
`targetProjectName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`TargetProjectName` When this method returns, the parsed TargetProjectName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`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}/targetProjects/{target_project}

Or may be in any format if allowUnparsed is true.

Operators

Equality(TargetProjectName, TargetProjectName)

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

Parameters
Name	Description
`a`	`TargetProjectName`
`b`	`TargetProjectName`

Returns
Type	Description
`Boolean`

Inequality(TargetProjectName, TargetProjectName)

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

Parameters
Name	Description
`a`	`TargetProjectName`
`b`	`TargetProjectName`

Returns
Type	Description
`Boolean`