VM Migration v1 API - Class ImageName (2.7.0) 

public sealed class ImageName : IResourceName, IEquatable<ImageName>

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

Resource name for the Image resource.

Inheritance

object > ImageName

Namespace

Google.Cloud.VMMigration.V1

Assembly

Google.Cloud.VMMigration.V1.dll

Constructors

ImageName(string, string)

public ImageName(string projectId, string imageId)

Constructs a new instance of a ImageName class from the component parts of pattern projects/{project}/global/images/{image}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
imageId string

The Image ID. Must not be null or empty.

Properties

ImageId

public string ImageId { get; }

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

Property Value
Type Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
bool

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

The ImageName.ResourceNameType of the contained resource name.

Property Value
Type Description
ImageNameResourceNameType

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)

public static string Format(string projectId, string imageId)

Formats the IDs into the string representation of this ImageName with pattern projects/{project}/global/images/{image}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
imageId string

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

The string representation of this ImageName with pattern projects/{project}/global/images/{image}.

FormatProjectImage(string, string)

public static string FormatProjectImage(string projectId, string imageId)

Formats the IDs into the string representation of this ImageName with pattern projects/{project}/global/images/{image}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
imageId string

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

The string representation of this ImageName with pattern projects/{project}/global/images/{image}.

FromProjectImage(string, string)

public static ImageName FromProjectImage(string projectId, string imageId)

Creates a ImageName with the pattern projects/{project}/global/images/{image}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
imageId string

The Image ID. Must not be null or empty.
Returns
Type Description
ImageName

A new instance of ImageName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ImageName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ImageName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
imageName string

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

The parsed ImageName if successful.
Remarks

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

  • projects/{project}/global/images/{image}

Parse(string, bool)

public static ImageName Parse(string imageName, bool allowUnparsed)

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

Parameters
Name Description
imageName 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
ImageName

The parsed ImageName if successful.
Remarks

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

  • projects/{project}/global/images/{image}
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 ImageName)

public static bool TryParse(string imageName, out ImageName result)

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

Parameters
Name Description
imageName string

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

When this method returns, the parsed ImageName, 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}/global/images/{image}

TryParse(string, bool, out ImageName)

public static bool TryParse(string imageName, bool allowUnparsed, out ImageName result)

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

Parameters
Name Description
imageName 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 ImageName

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

Operators

operator ==(ImageName, ImageName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ImageName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ImageName

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

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.