Represents a Target.
Package
@google-cloud/deployConstructors
(constructor)(properties)
constructor(properties?: google.cloud.deploy.v1.ITarget);Constructs a new Target.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITarget
Properties to set |
Properties
annotations
public annotations: { [k: string]: string };Target annotations.
anthosCluster
public anthosCluster?: (google.cloud.deploy.v1.IAnthosCluster|null);Target anthosCluster.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Target createTime.
customTarget
public customTarget?: (google.cloud.deploy.v1.ICustomTarget|null);Target customTarget.
deploymentTarget
public deploymentTarget?: ("gke"|"anthosCluster"|"run"|"multiTarget"|"customTarget");Target deploymentTarget.
deployParameters
public deployParameters: { [k: string]: string };Target deployParameters.
description
public description: string;Target description.
etag
public etag: string;Target etag.
executionConfigs
public executionConfigs: google.cloud.deploy.v1.IExecutionConfig[];Target executionConfigs.
gke
public gke?: (google.cloud.deploy.v1.IGkeCluster|null);Target gke.
labels
public labels: { [k: string]: string };Target labels.
multiTarget
public multiTarget?: (google.cloud.deploy.v1.IMultiTarget|null);Target multiTarget.
name
public name: string;Target name.
requireApproval
public requireApproval: boolean;Target requireApproval.
run
public run?: (google.cloud.deploy.v1.ICloudRunLocation|null);Target run.
targetId
public targetId: string;Target targetId.
uid
public uid: string;Target uid.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Target updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.deploy.v1.ITarget): google.cloud.deploy.v1.Target;Creates a new Target instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITarget
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Target | Target instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.deploy.v1.Target;Decodes a Target 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 |
Target | Target |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.deploy.v1.Target;Decodes a Target message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Target | Target |
encode(message, writer)
public static encode(message: google.cloud.deploy.v1.ITarget, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Target message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITarget
Target 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.deploy.v1.ITarget, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Target message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITarget
Target 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.deploy.v1.Target;Creates a Target 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 |
Target | Target |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Target
| 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 Target to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.deploy.v1.Target, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Target message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Target
Target |
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 Target message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|