Represents an Environment.
Package
@google-cloud/dataplexConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dataplex.v1.IEnvironment);Constructs a new Environment.
| Parameter | |
|---|---|
| Name | Description |
properties |
IEnvironment
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);Environment createTime.
description
public description: string;Environment description.
displayName
public displayName: string;Environment displayName.
endpoints
public endpoints?: (google.cloud.dataplex.v1.Environment.IEndpoints|null);Environment endpoints.
infrastructureSpec
public infrastructureSpec?: (google.cloud.dataplex.v1.Environment.IInfrastructureSpec|null);Environment infrastructureSpec.
labels
public labels: { [k: string]: string };Environment labels.
name
public name: string;Environment name.
sessionSpec
public sessionSpec?: (google.cloud.dataplex.v1.Environment.ISessionSpec|null);Environment sessionSpec.
sessionStatus
public sessionStatus?: (google.cloud.dataplex.v1.Environment.ISessionStatus|null);Environment sessionStatus.
state
public state: (google.cloud.dataplex.v1.State|keyof typeof google.cloud.dataplex.v1.State);Environment state.
uid
public uid: string;Environment uid.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Environment updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.dataplex.v1.IEnvironment): google.cloud.dataplex.v1.Environment;Creates a new Environment instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IEnvironment
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Environment |
Environment instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataplex.v1.Environment;Decodes an Environment 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 |
Environment |
Environment |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataplex.v1.Environment;Decodes an Environment message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Environment |
Environment |
encode(message, writer)
public static encode(message: google.cloud.dataplex.v1.IEnvironment, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Environment message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IEnvironment
Environment 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.dataplex.v1.IEnvironment, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Environment message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IEnvironment
Environment 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.dataplex.v1.Environment;Creates an Environment 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 |
Environment |
Environment |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Environment
| 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 Environment to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.dataplex.v1.Environment, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an Environment message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Environment
Environment |
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 an Environment message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|