Class protos.google.cloud.channel.v1.Customer (3.6.0)

Represents a Customer.

Package

@google-cloud/channel

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.channel.v1.ICustomer);

Constructs a new Customer.

Parameter
Name Description
properties ICustomer

Properties to set

Properties

alternateEmail

public alternateEmail: string;

Customer alternateEmail.

channelPartnerId

public channelPartnerId: string;

Customer channelPartnerId.

cloudIdentityId

public cloudIdentityId: string;

Customer cloudIdentityId.

cloudIdentityInfo

public cloudIdentityInfo?: (google.cloud.channel.v1.ICloudIdentityInfo|null);

Customer cloudIdentityInfo.

correlationId

public correlationId: string;

Customer correlationId.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Customer createTime.

domain

public domain: string;

Customer domain.

languageCode

public languageCode: string;

Customer languageCode.

name

public name: string;

Customer name.

orgDisplayName

public orgDisplayName: string;

Customer orgDisplayName.

orgPostalAddress

public orgPostalAddress?: (google.type.IPostalAddress|null);

Customer orgPostalAddress.

primaryContactInfo

public primaryContactInfo?: (google.cloud.channel.v1.IContactInfo|null);

Customer primaryContactInfo.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Customer updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.channel.v1.ICustomer): google.cloud.channel.v1.Customer;

Creates a new Customer instance using the specified properties.

Parameter
Name Description
properties ICustomer

Properties to set

Returns
Type Description
Customer

Customer instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.channel.v1.Customer;

Decodes a Customer message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
Customer

Customer

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.channel.v1.Customer;

Decodes a Customer message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Customer

Customer

encode(message, writer)

public static encode(message: google.cloud.channel.v1.ICustomer, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Customer message. Does not implicitly messages.

Parameters
Name Description
message ICustomer

Customer message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.channel.v1.ICustomer, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Customer message, length delimited. Does not implicitly messages.

Parameters
Name Description
message ICustomer

Customer message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.channel.v1.Customer;

Creates a Customer message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
Customer

Customer

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Customer

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this Customer to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.channel.v1.Customer, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Customer message. Also converts values to other types if specified.

Parameters
Name Description
message Customer

Customer

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Customer message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not