Cloud Channel v1 API - Class CustomerName (2.2.0)

public sealed class CustomerName : IResourceName, IEquatable<CustomerName>

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

Resource name for the Customer resource.

Inheritance

Object > CustomerName

Implements

IResourceName, IEquatable<CustomerName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Channel.V1

Assembly

Google.Cloud.Channel.V1.dll

Constructors

CustomerName(String, String)

public CustomerName(string accountId, string customerId)

Constructs a new instance of a CustomerName class from the component parts of pattern accounts/{account}/customers/{customer}

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

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
`Boolean`

Type

public CustomerName.ResourceNameType Type { get; }

The CustomerName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`CustomerName.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 customerId)

Formats the IDs into the string representation of this CustomerName with pattern accounts/{account}/customers/{customer}.

Parameters
Name	Description
`accountId`	`String` The `Account` 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 `accounts/{account}/customers/{customer}`.

FormatAccountCustomer(String, String)

public static string FormatAccountCustomer(string accountId, string customerId)

Formats the IDs into the string representation of this CustomerName with pattern accounts/{account}/customers/{customer}.

Parameters
Name	Description
`accountId`	`String` The `Account` 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 `accounts/{account}/customers/{customer}`.

FromAccountCustomer(String, String)

public static CustomerName FromAccountCustomer(string accountId, string customerId)

Creates a CustomerName with the pattern accounts/{account}/customers/{customer}.

Parameters
Name	Description
`accountId`	`String` The `Account` 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
`Int32`

Overrides

Object.GetHashCode()

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:

accounts/{account}/customers/{customer}

Parse(String, Boolean)

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`	`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
`CustomerName`	The parsed CustomerName if successful.

Remarks

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

accounts/{account}/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

Object.ToString()

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
`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}/customers/{customer}

TryParse(String, Boolean, 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`	`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`	`CustomerName` When this method returns, the parsed CustomerName, 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}/customers/{customer}

Or may be in any format if allowUnparsed is true.

Operators

Equality(CustomerName, CustomerName)

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

Parameters
Name	Description
`a`	`CustomerName`
`b`	`CustomerName`

Returns
Type	Description
`Boolean`

Inequality(CustomerName, CustomerName)

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

Parameters
Name	Description
`a`	`CustomerName`
`b`	`CustomerName`

Returns
Type	Description
`Boolean`