VM Migration v1 API - Class ImageImportJobName (2.8.0) 

public sealed class ImageImportJobName : IResourceName, IEquatable<ImageImportJobName>

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

Resource name for the ImageImportJob resource.

Inheritance

object > ImageImportJobName

Namespace

Google.Cloud.VMMigration.V1

Assembly

Google.Cloud.VMMigration.V1.dll

Constructors

ImageImportJobName(string, string, string, string)

public ImageImportJobName(string projectId, string locationId, string jobId, string resultId)

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

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.
resultId string

The Result 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

ResultId

public string ResultId { get; }

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

Property Value
Type Description
string

Type

public ImageImportJobName.ResourceNameType Type { get; }

The ImageImportJobName.ResourceNameType of the contained resource name.

Property Value
Type Description
ImageImportJobNameResourceNameType

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

public static string Format(string projectId, string locationId, string jobId, string resultId)

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

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.
resultId string

The Result ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ImageImportJobName with pattern projects/{project}/locations/{location}/imageImports/{job}/imageImportJobs/{result}.

FormatProjectLocationJobResult(string, string, string, string)

public static string FormatProjectLocationJobResult(string projectId, string locationId, string jobId, string resultId)

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

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.
resultId string

The Result ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ImageImportJobName with pattern projects/{project}/locations/{location}/imageImports/{job}/imageImportJobs/{result}.

FromProjectLocationJobResult(string, string, string, string)

public static ImageImportJobName FromProjectLocationJobResult(string projectId, string locationId, string jobId, string resultId)

Creates a ImageImportJobName with the pattern projects/{project}/locations/{location}/imageImports/{job}/imageImportJobs/{result}.

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.
resultId string

The Result ID. Must not be null or empty.
Returns
Type Description
ImageImportJobName

A new instance of ImageImportJobName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ImageImportJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ImageImportJobName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
ImageImportJobName

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

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

Parameter
Name Description
imageImportJobName string

The resource name in string form. Must not be null.
Returns
Type Description
ImageImportJobName

The parsed ImageImportJobName if successful.
Remarks

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

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

Parse(string, bool)

public static ImageImportJobName Parse(string imageImportJobName, bool allowUnparsed)

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

Parameters
Name Description
imageImportJobName 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
ImageImportJobName

The parsed ImageImportJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/imageImports/{job}/imageImportJobs/{result}
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 ImageImportJobName)

public static bool TryParse(string imageImportJobName, out ImageImportJobName result)

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

Parameters
Name Description
imageImportJobName string

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

When this method returns, the parsed ImageImportJobName, 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}/imageImportJobs/{result}

TryParse(string, bool, out ImageImportJobName)

public static bool TryParse(string imageImportJobName, bool allowUnparsed, out ImageImportJobName result)

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

Parameters
Name Description
imageImportJobName 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 ImageImportJobName

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

Operators

operator ==(ImageImportJobName, ImageImportJobName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ImageImportJobName

The first resource name to compare, or null.
b ImageImportJobName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ImageImportJobName

The first resource name to compare, or null.
b ImageImportJobName

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.