BigQuery Reservation v1 API - Class AssignmentName (2.2.0) 

public sealed class AssignmentName : IResourceName, IEquatable<AssignmentName>

Reference documentation and code samples for the BigQuery Reservation v1 API class AssignmentName.

Resource name for the Assignment resource.

Inheritance

object > AssignmentName

Namespace

GoogleGoogle.CloudGoogle.Cloud.BigQueryGoogle.Cloud.BigQuery.ReservationV1

Assembly

Google.Cloud.BigQuery.Reservation.V1.dll

Constructors

AssignmentName(string, string, string, string)

public AssignmentName(string projectId, string locationId, string reservationId, string assignmentId)

Constructs a new instance of a AssignmentName class from the component parts of pattern projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}

Parameters
Name Description
projectId string

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

The Location ID. Must not be null or empty.
reservationId string

The Reservation ID. Must not be null or empty.
assignmentId string

The Assignment ID. Must not be null or empty.

Properties

AssignmentId

public string AssignmentId { get; }

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

LocationId

public string LocationId { get; }

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

ReservationId

public string ReservationId { get; }

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

Property Value
Type Description
string

Type

public AssignmentName.ResourceNameType Type { get; }

The AssignmentName.ResourceNameType of the contained resource name.

Property Value
Type Description
AssignmentNameResourceNameType

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

public static string Format(string projectId, string locationId, string reservationId, string assignmentId)

Formats the IDs into the string representation of this AssignmentName with pattern projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}.

Parameters
Name Description
projectId string

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

The Location ID. Must not be null or empty.
reservationId string

The Reservation ID. Must not be null or empty.
assignmentId string

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

The string representation of this AssignmentName with pattern projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}.

FormatProjectLocationReservationAssignment(string, string, string, string)

public static string FormatProjectLocationReservationAssignment(string projectId, string locationId, string reservationId, string assignmentId)

Formats the IDs into the string representation of this AssignmentName with pattern projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}.

Parameters
Name Description
projectId string

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

The Location ID. Must not be null or empty.
reservationId string

The Reservation ID. Must not be null or empty.
assignmentId string

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

The string representation of this AssignmentName with pattern projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}.

FromProjectLocationReservationAssignment(string, string, string, string)

public static AssignmentName FromProjectLocationReservationAssignment(string projectId, string locationId, string reservationId, string assignmentId)

Creates a AssignmentName with the pattern projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}.

Parameters
Name Description
projectId string

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

The Location ID. Must not be null or empty.
reservationId string

The Reservation ID. Must not be null or empty.
assignmentId string

The Assignment ID. Must not be null or empty.
Returns
Type Description
AssignmentName

A new instance of AssignmentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AssignmentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AssignmentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
assignmentName string

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

The parsed AssignmentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}

Parse(string, bool)

public static AssignmentName Parse(string assignmentName, bool allowUnparsed)

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

Parameters
Name Description
assignmentName 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
AssignmentName

The parsed AssignmentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}
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 AssignmentName)

public static bool TryParse(string assignmentName, out AssignmentName result)

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

Parameters
Name Description
assignmentName string

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

When this method returns, the parsed AssignmentName, 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}/locations/{location}/reservations/{reservation}/assignments/{assignment}

TryParse(string, bool, out AssignmentName)

public static bool TryParse(string assignmentName, bool allowUnparsed, out AssignmentName result)

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

Parameters
Name Description
assignmentName 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 AssignmentName

When this method returns, the parsed AssignmentName, 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}/locations/{location}/reservations/{reservation}/assignments/{assignment}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AssignmentName, AssignmentName)

public static bool operator ==(AssignmentName a, AssignmentName b)
Parameters
Name Description
a AssignmentName
b AssignmentName
Returns
Type Description
bool

operator !=(AssignmentName, AssignmentName)

public static bool operator !=(AssignmentName a, AssignmentName b)
Parameters
Name Description
a AssignmentName
b AssignmentName
Returns
Type Description
bool