Cloud Channel v1 API - Class ReportJobName (2.3.0)

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

Implements

IResourceName, IEquatable<ReportJobName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
Name	Description
`accountId`	`String` The `Account` ID. Must not be `null` or empty.
`reportJobId`	`String` 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
Type	Description
`String`

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type	Description
`Boolean`

ReportJobId

public string ReportJobId { get; }

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

Property Value
Type	Description
`String`

Type

public ReportJobName.ResourceNameType Type { get; }

The ReportJobName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ReportJobName.ResourceNameType`

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

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

Parameters
Name	Description
`accountId`	`String` The `Account` ID. Must not be `null` or empty.
`reportJobId`	`String` The `ReportJob` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`accountId`	`String` The `Account` ID. Must not be `null` or empty.
`reportJobId`	`String` The `ReportJob` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`accountId`	`String` The `Account` ID. Must not be `null` or empty.
`reportJobId`	`String` The `ReportJob` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`ReportJobName`	A new instance of ReportJobName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static ReportJobName Parse(string reportJobName)

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

Parameter
Name	Description
`reportJobName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`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
Name	Description
`reportJobName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`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
Type	Description
`String`	The string representation of the resource name.

Overrides

Object.ToString()

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
Name	Description
`reportJobName`	`String` The resource name in string form. Must not be `null`.
`result`	`ReportJobName` When this method returns, the parsed ReportJobName, or `null` if parsing failed.

Returns
Type	Description
`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
Name	Description
`reportJobName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`ReportJobName` When this method returns, the parsed ReportJobName, or `null` if parsing failed.

Returns
Type	Description
`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
Name	Description
`a`	`ReportJobName`
`b`	`ReportJobName`

Returns
Type	Description
`Boolean`

Inequality(ReportJobName, ReportJobName)

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

Parameters
Name	Description
`a`	`ReportJobName`
`b`	`ReportJobName`

Returns
Type	Description
`Boolean`