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.
Namespace
Google.Cloud.Channel.V1Assembly
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 | |
---|---|
Name | Description |
accountId | string The |
reportId | string The |
Properties
AccountId
public string AccountId { get; }
The Account
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 |
ReportId
public string ReportId { get; }
The Report
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
string |
Type
public ReportName.ResourceNameType Type { get; }
The ReportName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
ReportNameResourceNameType |
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 accountId, string reportId)
Formats the IDs into the string representation of this ReportName with pattern
accounts/{account}/reports/{report}
.
Parameters | |
---|---|
Name | Description |
accountId | string The |
reportId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this ReportName with pattern
|
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 | |
---|---|
Name | Description |
accountId | string The |
reportId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this ReportName with pattern
|
FromAccountReport(string, string)
public static ReportName FromAccountReport(string accountId, string reportId)
Creates a ReportName with the pattern accounts/{account}/reports/{report}
.
Parameters | |
---|---|
Name | Description |
accountId | string The |
reportId | string The |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
ReportName | A new instance of ReportName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static ReportName Parse(string reportName)
Parses the given resource name string into a new ReportName instance.
Parameter | |
---|---|
Name | Description |
reportName | string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
ReportName | The parsed ReportName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
accounts/{account}/reports/{report}
Parse(string, bool)
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 | |
---|---|
Name | Description |
reportName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
ReportName | The parsed ReportName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
accounts/{account}/reports/{report}
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. |
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 | |
---|---|
Name | Description |
reportName | string The resource name in string form. Must not be |
result | ReportName When this method returns, the parsed ReportName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
accounts/{account}/reports/{report}
TryParse(string, bool, 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 | |
---|---|
Name | Description |
reportName | string The resource name in string form. Must not be |
allowUnparsed | bool If |
result | ReportName When this method returns, the parsed ReportName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
accounts/{account}/reports/{report}
allowUnparsed
is true
.
Operators
operator ==(ReportName, ReportName)
public static bool operator ==(ReportName a, ReportName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a | ReportName The first resource name to compare, or null. |
b | ReportName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool | true if the value of |
operator !=(ReportName, ReportName)
public static bool operator !=(ReportName a, ReportName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a | ReportName The first resource name to compare, or null. |
b | ReportName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool | true if the value of |