Class protos.google.cloud.domains.v1.Registration (3.1.0)

Represents a Registration.

Package

@google-cloud/domains

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.domains.v1.IRegistration);

Constructs a new Registration.

Parameter
NameDescription
properties IRegistration

Properties to set

Properties

contactSettings

public contactSettings?: (google.cloud.domains.v1.IContactSettings|null);

Registration contactSettings.

createTime

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

Registration createTime.

dnsSettings

public dnsSettings?: (google.cloud.domains.v1.IDnsSettings|null);

Registration dnsSettings.

domainName

public domainName: string;

Registration domainName.

expireTime

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

Registration expireTime.

issues

public issues: google.cloud.domains.v1.Registration.Issue[];

Registration issues.

labels

public labels: { [k: string]: string };

Registration labels.

managementSettings

public managementSettings?: (google.cloud.domains.v1.IManagementSettings|null);

Registration managementSettings.

name

public name: string;

Registration name.

pendingContactSettings

public pendingContactSettings?: (google.cloud.domains.v1.IContactSettings|null);

Registration pendingContactSettings.

state

public state: (google.cloud.domains.v1.Registration.State|keyof typeof google.cloud.domains.v1.Registration.State);

Registration state.

supportedPrivacy

public supportedPrivacy: google.cloud.domains.v1.ContactPrivacy[];

Registration supportedPrivacy.

Methods

create(properties)

public static create(properties?: google.cloud.domains.v1.IRegistration): google.cloud.domains.v1.Registration;

Creates a new Registration instance using the specified properties.

Parameter
NameDescription
properties IRegistration

Properties to set

Returns
TypeDescription
Registration

Registration instance

decode(reader, length)

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

Decodes a Registration message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
Registration

Registration

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Registration

Registration

encode(message, writer)

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

Encodes the specified Registration message. Does not implicitly messages.

Parameters
NameDescription
message IRegistration

Registration message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IRegistration

Registration message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
Registration

Registration

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Registration

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this Registration to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message Registration

Registration

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a Registration message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not