Google Cloud Storage Insights v1 API - Class ReportDetailName (1.3.0)

public sealed class ReportDetailName : IResourceName, IEquatable<ReportDetailName>

Reference documentation and code samples for the Google Cloud Storage Insights v1 API class ReportDetailName.

Resource name for the ReportDetail resource.

Inheritance

object > ReportDetailName

Namespace

Google.Cloud.StorageInsights.V1

Assembly

Google.Cloud.StorageInsights.V1.dll

Constructors

ReportDetailName(string, string, string, string)

public ReportDetailName(string projectId, string locationId, string reportConfigId, string reportDetailId)

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

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

The ReportConfig ID. Must not be null or empty.
reportDetailId string

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

ReportConfigId

public string ReportConfigId { get; }

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

Property Value
Type Description
string

ReportDetailId

public string ReportDetailId { get; }

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

Property Value
Type Description
string

Type

public ReportDetailName.ResourceNameType Type { get; }

The ReportDetailName.ResourceNameType of the contained resource name.

Property Value
Type Description
ReportDetailNameResourceNameType

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

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

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

The ReportConfig ID. Must not be null or empty.
reportDetailId string

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

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

FormatProjectLocationReportConfigReportDetail(string, string, string, string)

public static string FormatProjectLocationReportConfigReportDetail(string projectId, string locationId, string reportConfigId, string reportDetailId)

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

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

The ReportConfig ID. Must not be null or empty.
reportDetailId string

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

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

FromProjectLocationReportConfigReportDetail(string, string, string, string)

public static ReportDetailName FromProjectLocationReportConfigReportDetail(string projectId, string locationId, string reportConfigId, string reportDetailId)

Creates a ReportDetailName with the pattern projects/{project}/locations/{location}/reportConfigs/{report_config}/reportDetails/{report_detail}.

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

The ReportConfig ID. Must not be null or empty.
reportDetailId string

The ReportDetail ID. Must not be null or empty.
Returns
Type Description
ReportDetailName

A new instance of ReportDetailName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ReportDetailName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ReportDetailName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
reportDetailName string

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

The parsed ReportDetailName if successful.
Remarks

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

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

Parse(string, bool)

public static ReportDetailName Parse(string reportDetailName, bool allowUnparsed)

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

Parameters
Name Description
reportDetailName 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
ReportDetailName

The parsed ReportDetailName if successful.
Remarks

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

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

public static bool TryParse(string reportDetailName, out ReportDetailName result)

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

Parameters
Name Description
reportDetailName string

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

When this method returns, the parsed ReportDetailName, 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}/reportConfigs/{report_config}/reportDetails/{report_detail}

TryParse(string, bool, out ReportDetailName)

public static bool TryParse(string reportDetailName, bool allowUnparsed, out ReportDetailName result)

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

Parameters
Name Description
reportDetailName 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 ReportDetailName

When this method returns, the parsed ReportDetailName, 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}/reportConfigs/{report_config}/reportDetails/{report_detail}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ReportDetailName, ReportDetailName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ReportDetailName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ReportDetailName

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

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.