Analytics Hub v1 API - Class OrderName (1.10.0) 

public sealed class OrderName : IResourceName, IEquatable<OrderName>

Reference documentation and code samples for the Analytics Hub v1 API class OrderName.

Resource name for the Order resource.

Inheritance

object > OrderName

Namespace

Google.Cloud.BigQuery.AnalyticsHub.V1

Assembly

Google.Cloud.BigQuery.AnalyticsHub.V1.dll

Constructors

OrderName(string, string)

public OrderName(string projectId, string orderId)

Constructs a new instance of a OrderName class from the component parts of pattern projects/{project}/orders/{order}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
orderId string

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

OrderId

public string OrderId { get; }

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

Type

public OrderName.ResourceNameType Type { get; }

The OrderName.ResourceNameType of the contained resource name.

Property Value
Type Description
OrderNameResourceNameType

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 projectId, string orderId)

Formats the IDs into the string representation of this OrderName with pattern projects/{project}/orders/{order}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
orderId string

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

The string representation of this OrderName with pattern projects/{project}/orders/{order} .

FormatProjectOrder(string, string)

public static string FormatProjectOrder(string projectId, string orderId)

Formats the IDs into the string representation of this OrderName with pattern projects/{project}/orders/{order}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
orderId string

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

The string representation of this OrderName with pattern projects/{project}/orders/{order} .

FromProjectOrder(string, string)

public static OrderName FromProjectOrder(string projectId, string orderId)

Creates a OrderName with the pattern projects/{project}/orders/{order}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
orderId string

The Order ID. Must not be null or empty.
Returns
Type Description
OrderName

A new instance of OrderName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static OrderName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OrderName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
orderName string

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

The parsed OrderName if successful.
Remarks

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

  • projects/{project}/orders/{order}

Parse(string, bool)

public static OrderName Parse(string orderName, bool allowUnparsed)

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

Parameters
Name Description
orderName 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
OrderName

The parsed OrderName if successful.
Remarks

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

  • projects/{project}/orders/{order}
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 OrderName)

public static bool TryParse(string orderName, out OrderName result)

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

Parameters
Name Description
orderName string

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

When this method returns, the parsed OrderName, 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}/orders/{order}

TryParse(string, bool, out OrderName)

public static bool TryParse(string orderName, bool allowUnparsed, out OrderName result)

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

Parameters
Name Description
orderName 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 OrderName

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

Operators

operator ==(OrderName, OrderName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a OrderName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a OrderName

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

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.