Domain

google.cloud.managedidentities.v1. Domain

Represents a Domain.

Constructor

new Domain(propertiesopt)

Constructs a new Domain.

Parameters:
Name Type Attributes Description
properties google.cloud.managedidentities.v1.IDomain <optional>

Properties to set

Implements:
  • IDomain

Members

admin

Domain admin.

authorizedNetworks

Domain authorizedNetworks.

createTime

Domain createTime.

fqdn

Domain fqdn.

labels

Domain labels.

locations

Domain locations.

name

Domain name.

reservedIpRange

Domain reservedIpRange.

state

Domain state.

statusMessage

Domain statusMessage.

trusts

Domain trusts.

updateTime

Domain updateTime.

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

CREATING number

CREATING value

READY number

READY value

UPDATING number

UPDATING value

DELETING number

DELETING value

REPAIRING number

REPAIRING value

PERFORMING_MAINTENANCE number

PERFORMING_MAINTENANCE value

UNAVAILABLE number

UNAVAILABLE value

Methods

toJSON() → {Object.<string, *>}

Converts this Domain to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.managedidentities.v1.Domain}

Creates a new Domain instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.managedidentities.v1.IDomain <optional>

Properties to set

Returns:
Type Description
google.cloud.managedidentities.v1.Domain

Domain instance

(static) decode(reader, lengthopt) → {google.cloud.managedidentities.v1.Domain}

Decodes a Domain message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.managedidentities.v1.Domain

Domain

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.managedidentities.v1.Domain}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.managedidentities.v1.Domain

Domain

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Domain message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.managedidentities.v1.IDomain

Domain message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.managedidentities.v1.IDomain

Domain message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.managedidentities.v1.Domain}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.managedidentities.v1.Domain

Domain

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Domain

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.managedidentities.v1.Domain

Domain

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Domain message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not