Represents a Canary.
Package
@google-cloud/deployConstructors
(constructor)(properties)
constructor(properties?: google.cloud.deploy.v1.ICanary);
Constructs a new Canary.
Parameter | |
---|---|
Name | Description |
properties |
ICanary
Properties to set |
Properties
canaryDeployment
public canaryDeployment?: (google.cloud.deploy.v1.ICanaryDeployment|null);
Canary canaryDeployment.
customCanaryDeployment
public customCanaryDeployment?: (google.cloud.deploy.v1.ICustomCanaryDeployment|null);
Canary customCanaryDeployment.
mode
public mode?: ("canaryDeployment"|"customCanaryDeployment");
Canary mode.
runtimeConfig
public runtimeConfig?: (google.cloud.deploy.v1.IRuntimeConfig|null);
Canary runtimeConfig.
Methods
create(properties)
public static create(properties?: google.cloud.deploy.v1.ICanary): google.cloud.deploy.v1.Canary;
Creates a new Canary instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
ICanary
Properties to set |
Returns | |
---|---|
Type | Description |
google.cloud.deploy.v1.Canary | Canary instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.deploy.v1.Canary;
Decodes a Canary message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
google.cloud.deploy.v1.Canary | Canary |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.deploy.v1.Canary;
Decodes a Canary message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
google.cloud.deploy.v1.Canary | Canary |
encode(message, writer)
public static encode(message: google.cloud.deploy.v1.ICanary, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Canary message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ICanary
Canary 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.ICanary, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Canary message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ICanary
Canary 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.Canary;
Creates a Canary 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 |
google.cloud.deploy.v1.Canary | Canary |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Canary
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 Canary to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.deploy.v1.Canary, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Canary message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
google.cloud.deploy.v1.Canary
Canary |
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 Canary message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|