Cloud Channel v1 API - Class ReportJobName (2.4.0)

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

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

Resource name for the ReportJob resource.

Inheritance

Object > ReportJobName

Namespace

Google.Cloud.Channel.V1

Assembly

Google.Cloud.Channel.V1.dll

Constructors

ReportJobName(String, String)

public ReportJobName(string accountId, string reportJobId)

Constructs a new instance of a ReportJobName class from the component parts of pattern accounts/{account}/reportJobs/{report_job}

Parameters
NameDescription
accountIdString

The Account ID. Must not be null or empty.

reportJobIdString

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

ReportJobId

public string ReportJobId { get; }

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

Property Value
TypeDescription
String

Type

public ReportJobName.ResourceNameType Type { get; }

The ReportJobName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ReportJobName.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 reportJobId)

Formats the IDs into the string representation of this ReportJobName with pattern accounts/{account}/reportJobs/{report_job}.

Parameters
NameDescription
accountIdString

The Account ID. Must not be null or empty.

reportJobIdString

The ReportJob ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ReportJobName with pattern accounts/{account}/reportJobs/{report_job}.

FormatAccountReportJob(String, String)

public static string FormatAccountReportJob(string accountId, string reportJobId)

Formats the IDs into the string representation of this ReportJobName with pattern accounts/{account}/reportJobs/{report_job}.

Parameters
NameDescription
accountIdString

The Account ID. Must not be null or empty.

reportJobIdString

The ReportJob ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ReportJobName with pattern accounts/{account}/reportJobs/{report_job}.

FromAccountReportJob(String, String)

public static ReportJobName FromAccountReportJob(string accountId, string reportJobId)

Creates a ReportJobName with the pattern accounts/{account}/reportJobs/{report_job}.

Parameters
NameDescription
accountIdString

The Account ID. Must not be null or empty.

reportJobIdString

The ReportJob ID. Must not be null or empty.

Returns
TypeDescription
ReportJobName

A new instance of ReportJobName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ReportJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ReportJobName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ReportJobName

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

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

Parameter
NameDescription
reportJobNameString

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

Returns
TypeDescription
ReportJobName

The parsed ReportJobName if successful.

Remarks

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

  • accounts/{account}/reportJobs/{report_job}

Parse(String, Boolean)

public static ReportJobName Parse(string reportJobName, bool allowUnparsed)

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

Parameters
NameDescription
reportJobNameString

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
ReportJobName

The parsed ReportJobName if successful.

Remarks

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

  • accounts/{account}/reportJobs/{report_job}
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 ReportJobName)

public static bool TryParse(string reportJobName, out ReportJobName result)

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

Parameters
NameDescription
reportJobNameString

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

resultReportJobName

When this method returns, the parsed ReportJobName, 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}/reportJobs/{report_job}

TryParse(String, Boolean, out ReportJobName)

public static bool TryParse(string reportJobName, bool allowUnparsed, out ReportJobName result)

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

Parameters
NameDescription
reportJobNameString

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.

resultReportJobName

When this method returns, the parsed ReportJobName, 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}/reportJobs/{report_job}
Or may be in any format if allowUnparsed is true.

Operators

Equality(ReportJobName, ReportJobName)

public static bool operator ==(ReportJobName a, ReportJobName b)
Parameters
NameDescription
aReportJobName
bReportJobName
Returns
TypeDescription
Boolean

Inequality(ReportJobName, ReportJobName)

public static bool operator !=(ReportJobName a, ReportJobName b)
Parameters
NameDescription
aReportJobName
bReportJobName
Returns
TypeDescription
Boolean