Cloud Channel v1 API - Class ReportName (2.4.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class ReportName : IResourceName, IEquatable<ReportName>

Reference documentation and code samples for the Cloud Channel v1 API class ReportName.

Resource name for the Report resource.

Inheritance

Object > ReportName

Namespace

Google.Cloud.Channel.V1

Assembly

Google.Cloud.Channel.V1.dll

Constructors

ReportName(String, String)

public ReportName(string accountId, string reportId)

Constructs a new instance of a ReportName class from the component parts of pattern accounts/{account}/reports/{report}

Parameters
NameDescription
accountIdString

The Account ID. Must not be null or empty.

reportIdString

The Report ID. Must not be null or empty.

Properties

AccountId

public string AccountId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

ReportId

public string ReportId { get; }

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

Property Value
TypeDescription
String

Type

public ReportName.ResourceNameType Type { get; }

The ReportName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ReportName.ResourceNameType

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)

public static string Format(string accountId, string reportId)

Formats the IDs into the string representation of this ReportName with pattern accounts/{account}/reports/{report}.

Parameters
NameDescription
accountIdString

The Account ID. Must not be null or empty.

reportIdString

The Report ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ReportName with pattern accounts/{account}/reports/{report}.

FormatAccountReport(String, String)

public static string FormatAccountReport(string accountId, string reportId)

Formats the IDs into the string representation of this ReportName with pattern accounts/{account}/reports/{report}.

Parameters
NameDescription
accountIdString

The Account ID. Must not be null or empty.

reportIdString

The Report ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ReportName with pattern accounts/{account}/reports/{report}.

FromAccountReport(String, String)

public static ReportName FromAccountReport(string accountId, string reportId)

Creates a ReportName with the pattern accounts/{account}/reports/{report}.

Parameters
NameDescription
accountIdString

The Account ID. Must not be null or empty.

reportIdString

The Report ID. Must not be null or empty.

Returns
TypeDescription
ReportName

A new instance of ReportName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ReportName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ReportName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ReportName

A new instance of ReportName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static ReportName Parse(string reportName)

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

Parameter
NameDescription
reportNameString

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

Returns
TypeDescription
ReportName

The parsed ReportName if successful.

Remarks

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

  • accounts/{account}/reports/{report}

Parse(String, Boolean)

public static ReportName Parse(string reportName, bool allowUnparsed)

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

Parameters
NameDescription
reportNameString

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

allowUnparsedBoolean

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
ReportName

The parsed ReportName if successful.

Remarks

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

  • accounts/{account}/reports/{report}
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 ReportName)

public static bool TryParse(string reportName, out ReportName result)

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

Parameters
NameDescription
reportNameString

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

resultReportName

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

Returns
TypeDescription
Boolean

true if the name was parsed successfully; false otherwise.

Remarks

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

  • accounts/{account}/reports/{report}

TryParse(String, Boolean, out ReportName)

public static bool TryParse(string reportName, bool allowUnparsed, out ReportName result)

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

Parameters
NameDescription
reportNameString

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

allowUnparsedBoolean

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.

resultReportName

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

Returns
TypeDescription
Boolean

true if the name was parsed successfully; false otherwise.

Remarks

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

  • accounts/{account}/reports/{report}
Or may be in any format if allowUnparsed is true.

Operators

Equality(ReportName, ReportName)

public static bool operator ==(ReportName a, ReportName b)
Parameters
NameDescription
aReportName
bReportName
Returns
TypeDescription
Boolean

Inequality(ReportName, ReportName)

public static bool operator !=(ReportName a, ReportName b)
Parameters
NameDescription
aReportName
bReportName
Returns
TypeDescription
Boolean