VM Migration v1 API - Class UtilizationReportName (2.8.0) 

public sealed class UtilizationReportName : IResourceName, IEquatable<UtilizationReportName>

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

Resource name for the UtilizationReport resource.

Inheritance

object > UtilizationReportName

Namespace

Google.Cloud.VMMigration.V1

Assembly

Google.Cloud.VMMigration.V1.dll

Constructors

UtilizationReportName(string, string, string, string)

public UtilizationReportName(string projectId, string locationId, string sourceId, string utilizationReportId)

Constructs a new instance of a UtilizationReportName class from the component parts of pattern projects/{project}/locations/{location}/sources/{source}/utilizationReports/{utilization_report}

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

The Source ID. Must not be null or empty.
utilizationReportId string

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

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

SourceId

public string SourceId { get; }

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

Property Value
Type Description
string

Type

public UtilizationReportName.ResourceNameType Type { get; }

The UtilizationReportName.ResourceNameType of the contained resource name.

Property Value
Type Description
UtilizationReportNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

UtilizationReportId

public string UtilizationReportId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string sourceId, string utilizationReportId)

Formats the IDs into the string representation of this UtilizationReportName with pattern projects/{project}/locations/{location}/sources/{source}/utilizationReports/{utilization_report}.

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

The Source ID. Must not be null or empty.
utilizationReportId string

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

The string representation of this UtilizationReportName with pattern projects/{project}/locations/{location}/sources/{source}/utilizationReports/{utilization_report}.

FormatProjectLocationSourceUtilizationReport(string, string, string, string)

public static string FormatProjectLocationSourceUtilizationReport(string projectId, string locationId, string sourceId, string utilizationReportId)

Formats the IDs into the string representation of this UtilizationReportName with pattern projects/{project}/locations/{location}/sources/{source}/utilizationReports/{utilization_report}.

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

The Source ID. Must not be null or empty.
utilizationReportId string

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

The string representation of this UtilizationReportName with pattern projects/{project}/locations/{location}/sources/{source}/utilizationReports/{utilization_report}.

FromProjectLocationSourceUtilizationReport(string, string, string, string)

public static UtilizationReportName FromProjectLocationSourceUtilizationReport(string projectId, string locationId, string sourceId, string utilizationReportId)

Creates a UtilizationReportName with the pattern projects/{project}/locations/{location}/sources/{source}/utilizationReports/{utilization_report}.

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

The Source ID. Must not be null or empty.
utilizationReportId string

The UtilizationReport ID. Must not be null or empty.
Returns
Type Description
UtilizationReportName

A new instance of UtilizationReportName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static UtilizationReportName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a UtilizationReportName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
utilizationReportName string

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

The parsed UtilizationReportName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sources/{source}/utilizationReports/{utilization_report}

Parse(string, bool)

public static UtilizationReportName Parse(string utilizationReportName, bool allowUnparsed)

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

Parameters
Name Description
utilizationReportName 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
UtilizationReportName

The parsed UtilizationReportName if successful.
Remarks

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

  • projects/{project}/locations/{location}/sources/{source}/utilizationReports/{utilization_report}
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 UtilizationReportName)

public static bool TryParse(string utilizationReportName, out UtilizationReportName result)

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

Parameters
Name Description
utilizationReportName string

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

When this method returns, the parsed UtilizationReportName, 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}/sources/{source}/utilizationReports/{utilization_report}

TryParse(string, bool, out UtilizationReportName)

public static bool TryParse(string utilizationReportName, bool allowUnparsed, out UtilizationReportName result)

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

Parameters
Name Description
utilizationReportName 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 UtilizationReportName

When this method returns, the parsed UtilizationReportName, 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}/sources/{source}/utilizationReports/{utilization_report}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(UtilizationReportName, UtilizationReportName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a UtilizationReportName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a UtilizationReportName

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

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.