Deployment

google.cloud.apihub.v1. Deployment

Represents a Deployment.

Constructor

new Deployment(propertiesopt)

Constructs a new Deployment.

Parameters:
Name Type Attributes Description
properties google.cloud.apihub.v1.IDeployment <optional>

Properties to set

Implements:
  • IDeployment

Members

apiVersions

Deployment apiVersions.

attributes

Deployment attributes.

createTime

Deployment createTime.

deploymentType

Deployment deploymentType.

description

Deployment description.

displayName

Deployment displayName.

documentation

Deployment documentation.

endpoints

Deployment endpoints.

environment

Deployment environment.

name

Deployment name.

resourceUri

Deployment resourceUri.

slo

Deployment slo.

updateTime

Deployment updateTime.

Methods

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

Converts this Deployment to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.apihub.v1.Deployment}

Creates a new Deployment instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.apihub.v1.IDeployment <optional>

Properties to set

Returns:
Type Description
google.cloud.apihub.v1.Deployment

Deployment instance

(static) decode(reader, lengthopt) → {google.cloud.apihub.v1.Deployment}

Decodes a Deployment 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.apihub.v1.Deployment

Deployment

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.apihub.v1.Deployment}

Decodes a Deployment 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.apihub.v1.Deployment

Deployment

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 Deployment message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.apihub.v1.IDeployment

Deployment 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 Deployment message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.apihub.v1.IDeployment

Deployment 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.apihub.v1.Deployment}

Creates a Deployment 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.apihub.v1.Deployment

Deployment

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Deployment

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 Deployment message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.apihub.v1.Deployment

Deployment

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a Deployment 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