Migration Center v1 API - Class ReportConfigName (1.1.0)

public sealed class ReportConfigName : IResourceName, IEquatable<ReportConfigName>

Reference documentation and code samples for the Migration Center v1 API class ReportConfigName.

Resource name for the ReportConfig resource.

Inheritance

object > ReportConfigName

Namespace

Google.Cloud.MigrationCenter.V1

Assembly

Google.Cloud.MigrationCenter.V1.dll

Constructors

ReportConfigName(string, string, string)

public ReportConfigName(string projectId, string locationId, string reportConfigId)

Constructs a new instance of a ReportConfigName class from the component parts of pattern projects/{project}/locations/{location}/reportConfigs/{report_config}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

reportConfigIdstring

The ReportConfig 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
bool

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

ReportConfigId

public string ReportConfigId { get; }

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

Property Value
TypeDescription
string

Type

public ReportConfigName.ResourceNameType Type { get; }

The ReportConfigName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ReportConfigNameResourceNameType

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

Formats the IDs into the string representation of this ReportConfigName with pattern projects/{project}/locations/{location}/reportConfigs/{report_config}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

reportConfigIdstring

The ReportConfig ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ReportConfigName with pattern projects/{project}/locations/{location}/reportConfigs/{report_config}.

FormatProjectLocationReportConfig(string, string, string)

public static string FormatProjectLocationReportConfig(string projectId, string locationId, string reportConfigId)

Formats the IDs into the string representation of this ReportConfigName with pattern projects/{project}/locations/{location}/reportConfigs/{report_config}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

reportConfigIdstring

The ReportConfig ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this ReportConfigName with pattern projects/{project}/locations/{location}/reportConfigs/{report_config}.

FromProjectLocationReportConfig(string, string, string)

public static ReportConfigName FromProjectLocationReportConfig(string projectId, string locationId, string reportConfigId)

Creates a ReportConfigName with the pattern projects/{project}/locations/{location}/reportConfigs/{report_config}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

reportConfigIdstring

The ReportConfig ID. Must not be null or empty.

Returns
TypeDescription
ReportConfigName

A new instance of ReportConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ReportConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ReportConfigName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ReportConfigName

A new instance of ReportConfigName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static ReportConfigName Parse(string reportConfigName)

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

Parameter
NameDescription
reportConfigNamestring

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

Returns
TypeDescription
ReportConfigName

The parsed ReportConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/reportConfigs/{report_config}

Parse(string, bool)

public static ReportConfigName Parse(string reportConfigName, bool allowUnparsed)

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

Parameters
NameDescription
reportConfigNamestring

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

allowUnparsedbool

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
ReportConfigName

The parsed ReportConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/reportConfigs/{report_config}
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 ReportConfigName)

public static bool TryParse(string reportConfigName, out ReportConfigName result)

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

Parameters
NameDescription
reportConfigNamestring

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

resultReportConfigName

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

Returns
TypeDescription
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}/reportConfigs/{report_config}

TryParse(string, bool, out ReportConfigName)

public static bool TryParse(string reportConfigName, bool allowUnparsed, out ReportConfigName result)

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

Parameters
NameDescription
reportConfigNamestring

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

allowUnparsedbool

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.

resultReportConfigName

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

Returns
TypeDescription
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}/reportConfigs/{report_config}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ReportConfigName, ReportConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aReportConfigName

The first resource name to compare, or null.

bReportConfigName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(ReportConfigName, ReportConfigName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aReportConfigName

The first resource name to compare, or null.

bReportConfigName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.