VM Migration v1 API - Class ImageImportName (2.8.0)

Version latest

• 2.8.0 (latest)
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.0

public sealed class ImageImportName : IResourceName, IEquatable<ImageImportName>

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

Resource name for the ImageImport resource.

Inheritance

object > ImageImportName

Implements

IResourceName, IEquatableImageImportName

Inherited Members

object.GetType()

Namespace

Google.Cloud.VMMigration.V1

Assembly

Google.Cloud.VMMigration.V1.dll

Constructors

ImageImportName(string, string, string)

public ImageImportName(string projectId, string locationId, string jobId)

Constructs a new instance of a ImageImportName class from the component parts of pattern projects/{project}/locations/{location}/imageImports/{job}

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.
jobId	string The Job 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

JobId

public string JobId { get; }

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

Property Value
Type	Description
string

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 ImageImportName.ResourceNameType Type { get; }

The ImageImportName.ResourceNameType of the contained resource name.

Property Value
Type	Description
ImageImportNameResourceNameType

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

Formats the IDs into the string representation of this ImageImportName with pattern projects/{project}/locations/{location}/imageImports/{job}.

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.
jobId	string The Job ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ImageImportName with pattern projects/{project}/locations/{location}/imageImports/{job}.

FormatProjectLocationJob(string, string, string)

public static string FormatProjectLocationJob(string projectId, string locationId, string jobId)

Formats the IDs into the string representation of this ImageImportName with pattern projects/{project}/locations/{location}/imageImports/{job}.

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.
jobId	string The Job ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ImageImportName with pattern projects/{project}/locations/{location}/imageImports/{job}.

FromProjectLocationJob(string, string, string)

public static ImageImportName FromProjectLocationJob(string projectId, string locationId, string jobId)

Creates a ImageImportName with the pattern projects/{project}/locations/{location}/imageImports/{job}.

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.
jobId	string The Job ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static ImageImportName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ImageImportName containing an unparsed resource name.

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

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static ImageImportName Parse(string imageImportName)

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

Parameter
Name	Description
imageImportName	string The resource name in string form. Must not be null.

Returns
Type	Description
ImageImportName	The parsed ImageImportName if successful.

Remarks

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

• projects/{project}/locations/{location}/imageImports/{job}

Parse(string, bool)

public static ImageImportName Parse(string imageImportName, bool allowUnparsed)

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

Parameters
Name	Description
imageImportName	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
ImageImportName	The parsed ImageImportName if successful.

Remarks

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

• projects/{project}/locations/{location}/imageImports/{job}

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

public static bool TryParse(string imageImportName, out ImageImportName result)

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

Parameters
Name	Description
imageImportName	string The resource name in string form. Must not be null.
result	ImageImportName When this method returns, the parsed ImageImportName, 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}/imageImports/{job}

TryParse(string, bool, out ImageImportName)

public static bool TryParse(string imageImportName, bool allowUnparsed, out ImageImportName result)

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

Parameters
Name	Description
imageImportName	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	ImageImportName When this method returns, the parsed ImageImportName, 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}/imageImports/{job}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ImageImportName, ImageImportName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	ImageImportName The first resource name to compare, or null.
b	ImageImportName 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 !=(ImageImportName, ImageImportName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	ImageImportName The first resource name to compare, or null.
b	ImageImportName 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.