Class TargetProjectName

public sealed class TargetProjectName : IResourceName, IEquatable<TargetProjectName>

Resource name for the TargetProject resource.

Inheritance

Object > TargetProjectName

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

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

targetProjectIdString

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

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

TargetProjectId

public string TargetProjectId { get; }

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

Property Value
TypeDescription
String

Type

public TargetProjectName.ResourceNameType Type { get; }

The TargetProjectName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TargetProjectName.ResourceNameType

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

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

targetProjectIdString

The TargetProject ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

targetProjectIdString

The TargetProject ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

targetProjectIdString

The TargetProject ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TargetProjectName

A new instance of TargetProjectName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static TargetProjectName Parse(string targetProjectName)

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

Parameter
NameDescription
targetProjectNameString

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

Returns
TypeDescription
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
NameDescription
targetProjectNameString

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

allowUnparsedBoolean

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

The string representation of the resource name.

Overrides

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

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

resultTargetProjectName

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

Returns
TypeDescription
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
NameDescription
targetProjectNameString

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

allowUnparsedBoolean

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.

resultTargetProjectName

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

Returns
TypeDescription
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
NameDescription
aTargetProjectName
bTargetProjectName
Returns
TypeDescription
Boolean

Inequality(TargetProjectName, TargetProjectName)

public static bool operator !=(TargetProjectName a, TargetProjectName b)
Parameters
NameDescription
aTargetProjectName
bTargetProjectName
Returns
TypeDescription
Boolean