Cloud Controls Partner v1 API - Class CustomerName (1.0.0-beta02) 

public sealed class CustomerName : IResourceName, IEquatable<CustomerName>

Reference documentation and code samples for the Cloud Controls Partner v1 API class CustomerName.

Resource name for the Customer resource.

Inheritance

object > CustomerName

Namespace

Google.Cloud.CloudControlsPartner.V1

Assembly

Google.Cloud.CloudControlsPartner.V1.dll

Constructors

CustomerName(string, string, string)

public CustomerName(string organizationId, string locationId, string customerId)

Constructs a new instance of a CustomerName class from the component parts of pattern organizations/{organization}/locations/{location}/customers/{customer}

Parameters
Name Description
organizationId string

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

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

The Customer ID. Must not be null or empty.

Properties

CustomerId

public string CustomerId { get; }

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

OrganizationId

public string OrganizationId { get; }

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

Property Value
Type Description
string

Type

public CustomerName.ResourceNameType Type { get; }

The CustomerName.ResourceNameType of the contained resource name.

Property Value
Type Description
CustomerNameResourceNameType

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)

public static string Format(string organizationId, string locationId, string customerId)

Formats the IDs into the string representation of this CustomerName with pattern organizations/{organization}/locations/{location}/customers/{customer}.

Parameters
Name Description
organizationId string

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

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

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

The string representation of this CustomerName with pattern organizations/{organization}/locations/{location}/customers/{customer}.

FormatOrganizationLocationCustomer(string, string, string)

public static string FormatOrganizationLocationCustomer(string organizationId, string locationId, string customerId)

Formats the IDs into the string representation of this CustomerName with pattern organizations/{organization}/locations/{location}/customers/{customer}.

Parameters
Name Description
organizationId string

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

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

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

The string representation of this CustomerName with pattern organizations/{organization}/locations/{location}/customers/{customer}.

FromOrganizationLocationCustomer(string, string, string)

public static CustomerName FromOrganizationLocationCustomer(string organizationId, string locationId, string customerId)

Creates a CustomerName with the pattern organizations/{organization}/locations/{location}/customers/{customer}.

Parameters
Name Description
organizationId string

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

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

The Customer ID. Must not be null or empty.
Returns
Type Description
CustomerName

A new instance of CustomerName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CustomerName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CustomerName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
customerName string

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

The parsed CustomerName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/customers/{customer}

Parse(string, bool)

public static CustomerName Parse(string customerName, bool allowUnparsed)

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

Parameters
Name Description
customerName 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
CustomerName

The parsed CustomerName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/customers/{customer}
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 CustomerName)

public static bool TryParse(string customerName, out CustomerName result)

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

Parameters
Name Description
customerName string

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

When this method returns, the parsed CustomerName, 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:

  • organizations/{organization}/locations/{location}/customers/{customer}

TryParse(string, bool, out CustomerName)

public static bool TryParse(string customerName, bool allowUnparsed, out CustomerName result)

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

Parameters
Name Description
customerName 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 CustomerName

When this method returns, the parsed CustomerName, 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:

  • organizations/{organization}/locations/{location}/customers/{customer}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(CustomerName, CustomerName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CustomerName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CustomerName

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

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.