Represents a Blueprint.
Package
@google-cloud/telcoautomationConstructors
(constructor)(properties)
constructor(properties?: google.cloud.telcoautomation.v1.IBlueprint);
Constructs a new Blueprint.
Parameter | |
---|---|
Name | Description |
properties |
IBlueprint
Properties to set |
Properties
approvalState
public approvalState: (google.cloud.telcoautomation.v1.Blueprint.ApprovalState|keyof typeof google.cloud.telcoautomation.v1.Blueprint.ApprovalState);
Blueprint approvalState.
createTime
public createTime?: (google.protobuf.ITimestamp|null);
Blueprint createTime.
deploymentLevel
public deploymentLevel: (google.cloud.telcoautomation.v1.DeploymentLevel|keyof typeof google.cloud.telcoautomation.v1.DeploymentLevel);
Blueprint deploymentLevel.
displayName
public displayName: string;
Blueprint displayName.
files
public files: google.cloud.telcoautomation.v1.IFile[];
Blueprint files.
labels
public labels: { [k: string]: string };
Blueprint labels.
name
public name: string;
Blueprint name.
repository
public repository: string;
Blueprint repository.
revisionCreateTime
public revisionCreateTime?: (google.protobuf.ITimestamp|null);
Blueprint revisionCreateTime.
revisionId
public revisionId: string;
Blueprint revisionId.
rollbackSupport
public rollbackSupport: boolean;
Blueprint rollbackSupport.
sourceBlueprint
public sourceBlueprint: string;
Blueprint sourceBlueprint.
sourceProvider
public sourceProvider: string;
Blueprint sourceProvider.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);
Blueprint updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.telcoautomation.v1.IBlueprint): google.cloud.telcoautomation.v1.Blueprint;
Creates a new Blueprint instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IBlueprint
Properties to set |
Returns | |
---|---|
Type | Description |
Blueprint | Blueprint instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.telcoautomation.v1.Blueprint;
Decodes a Blueprint 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 |
Blueprint | Blueprint |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.telcoautomation.v1.Blueprint;
Decodes a Blueprint message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
Blueprint | Blueprint |
encode(message, writer)
public static encode(message: google.cloud.telcoautomation.v1.IBlueprint, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Blueprint message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IBlueprint
Blueprint 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.telcoautomation.v1.IBlueprint, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Blueprint message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IBlueprint
Blueprint 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.telcoautomation.v1.Blueprint;
Creates a Blueprint 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 |
Blueprint | Blueprint |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for Blueprint
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 Blueprint to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.telcoautomation.v1.Blueprint, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Blueprint message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
Blueprint
Blueprint |
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 Blueprint message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|