Class Blueprint (0.2.0)

public final class Blueprint extends GeneratedMessageV3 implements BlueprintOrBuilder

A Blueprint contains a collection of kubernetes resources in the form of YAML files. The file contents of a blueprint are collectively known as package. A blueprint can be a) imported from TNA's public catalog b) modified as per a user's need c) proposed and approved. On approval, a revision of blueprint is created which can be used to create a deployment on Orchestration or Workload Cluster.

Protobuf type google.cloud.telcoautomation.v1.Blueprint

Implements

BlueprintOrBuilder

Static Fields

APPROVAL_STATE_FIELD_NUMBER

public static final int APPROVAL_STATE_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DEPLOYMENT_LEVEL_FIELD_NUMBER

public static final int DEPLOYMENT_LEVEL_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

FILES_FIELD_NUMBER

public static final int FILES_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

REPOSITORY_FIELD_NUMBER

public static final int REPOSITORY_FIELD_NUMBER
Field Value
TypeDescription
int

REVISION_CREATE_TIME_FIELD_NUMBER

public static final int REVISION_CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

REVISION_ID_FIELD_NUMBER

public static final int REVISION_ID_FIELD_NUMBER
Field Value
TypeDescription
int

ROLLBACK_SUPPORT_FIELD_NUMBER

public static final int ROLLBACK_SUPPORT_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_BLUEPRINT_FIELD_NUMBER

public static final int SOURCE_BLUEPRINT_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_PROVIDER_FIELD_NUMBER

public static final int SOURCE_PROVIDER_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Blueprint getDefaultInstance()
Returns
TypeDescription
Blueprint

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Blueprint.Builder newBuilder()
Returns
TypeDescription
Blueprint.Builder

newBuilder(Blueprint prototype)

public static Blueprint.Builder newBuilder(Blueprint prototype)
Parameter
NameDescription
prototypeBlueprint
Returns
TypeDescription
Blueprint.Builder

parseDelimitedFrom(InputStream input)

public static Blueprint parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Blueprint
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Blueprint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Blueprint
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Blueprint parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Blueprint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Blueprint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Blueprint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Blueprint parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Blueprint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Blueprint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Blueprint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Blueprint parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Blueprint
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Blueprint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Blueprint
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Blueprint parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Blueprint
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Blueprint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Blueprint
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Blueprint parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Blueprint
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Blueprint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Blueprint
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Blueprint> parser()
Returns
TypeDescription
Parser<Blueprint>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels are key-value attributes that can be set on a blueprint resource by the user.

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getApprovalState()

public Blueprint.ApprovalState getApprovalState()

Output only. Approval state of the blueprint (DRAFT, PROPOSED, APPROVED)

.google.cloud.telcoautomation.v1.Blueprint.ApprovalState approval_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Blueprint.ApprovalState

The approvalState.

getApprovalStateValue()

public int getApprovalStateValue()

Output only. Approval state of the blueprint (DRAFT, PROPOSED, APPROVED)

.google.cloud.telcoautomation.v1.Blueprint.ApprovalState approval_state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for approvalState.

getCreateTime()

public Timestamp getCreateTime()

Output only. Blueprint creation time.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Blueprint creation time.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Blueprint getDefaultInstanceForType()
Returns
TypeDescription
Blueprint

getDeploymentLevel()

public DeploymentLevel getDeploymentLevel()

Output only. DeploymentLevel of a blueprint signifies where the blueprint will be applied. e.g. [HYDRATION, SINGLE_DEPLOYMENT, MULTI_DEPLOYMENT]

.google.cloud.telcoautomation.v1.DeploymentLevel deployment_level = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
DeploymentLevel

The deploymentLevel.

getDeploymentLevelValue()

public int getDeploymentLevelValue()

Output only. DeploymentLevel of a blueprint signifies where the blueprint will be applied. e.g. [HYDRATION, SINGLE_DEPLOYMENT, MULTI_DEPLOYMENT]

.google.cloud.telcoautomation.v1.DeploymentLevel deployment_level = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for deploymentLevel.

getDisplayName()

public String getDisplayName()

Optional. Human readable name of a Blueprint.

string display_name = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Human readable name of a Blueprint.

string display_name = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for displayName.

getFiles(int index)

public File getFiles(int index)

Optional. Files present in a blueprint. When invoking UpdateBlueprint API, only the modified files should be included in this. Files that are not included in the update of a blueprint will not be changed.

repeated .google.cloud.telcoautomation.v1.File files = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
File

getFilesCount()

public int getFilesCount()

Optional. Files present in a blueprint. When invoking UpdateBlueprint API, only the modified files should be included in this. Files that are not included in the update of a blueprint will not be changed.

repeated .google.cloud.telcoautomation.v1.File files = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getFilesList()

public List<File> getFilesList()

Optional. Files present in a blueprint. When invoking UpdateBlueprint API, only the modified files should be included in this. Files that are not included in the update of a blueprint will not be changed.

repeated .google.cloud.telcoautomation.v1.File files = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<File>

getFilesOrBuilder(int index)

public FileOrBuilder getFilesOrBuilder(int index)

Optional. Files present in a blueprint. When invoking UpdateBlueprint API, only the modified files should be included in this. Files that are not included in the update of a blueprint will not be changed.

repeated .google.cloud.telcoautomation.v1.File files = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
FileOrBuilder

getFilesOrBuilderList()

public List<? extends FileOrBuilder> getFilesOrBuilderList()

Optional. Files present in a blueprint. When invoking UpdateBlueprint API, only the modified files should be included in this. Files that are not included in the update of a blueprint will not be changed.

repeated .google.cloud.telcoautomation.v1.File files = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<? extends com.google.cloud.telcoautomation.v1.FileOrBuilder>

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels are key-value attributes that can be set on a blueprint resource by the user.

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels are key-value attributes that can be set on a blueprint resource by the user.

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels are key-value attributes that can be set on a blueprint resource by the user.

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels are key-value attributes that can be set on a blueprint resource by the user.

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getName()

public String getName()

The name of the blueprint. If unspecified, the name will be autogenerated from server side. Name of the blueprint must not contain @ character.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the blueprint. If unspecified, the name will be autogenerated from server side. Name of the blueprint must not contain @ character.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Blueprint> getParserForType()
Returns
TypeDescription
Parser<Blueprint>
Overrides

getRepository()

public String getRepository()

Output only. Name of the repository where the blueprint files are stored.

string repository = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The repository.

getRepositoryBytes()

public ByteString getRepositoryBytes()

Output only. Name of the repository where the blueprint files are stored.

string repository = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for repository.

getRevisionCreateTime()

public Timestamp getRevisionCreateTime()

Output only. The timestamp that the revision was created.

.google.protobuf.Timestamp revision_create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The revisionCreateTime.

getRevisionCreateTimeOrBuilder()

public TimestampOrBuilder getRevisionCreateTimeOrBuilder()

Output only. The timestamp that the revision was created.

.google.protobuf.Timestamp revision_create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getRevisionId()

public String getRevisionId()

Output only. Immutable. The revision ID of the blueprint. A new revision is committed whenever a blueprint is approved.

string revision_id = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The revisionId.

getRevisionIdBytes()

public ByteString getRevisionIdBytes()

Output only. Immutable. The revision ID of the blueprint. A new revision is committed whenever a blueprint is approved.

string revision_id = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for revisionId.

getRollbackSupport()

public boolean getRollbackSupport()

Output only. Indicates if the deployment created from this blueprint can be rolled back.

bool rollback_support = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

The rollbackSupport.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceBlueprint()

public String getSourceBlueprint()

Required. Immutable. The public blueprint ID from which this blueprint was created.

string source_blueprint = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
String

The sourceBlueprint.

getSourceBlueprintBytes()

public ByteString getSourceBlueprintBytes()

Required. Immutable. The public blueprint ID from which this blueprint was created.

string source_blueprint = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ByteString

The bytes for sourceBlueprint.

getSourceProvider()

public String getSourceProvider()

Output only. Source provider is the author of a public blueprint, from which this blueprint is created.

string source_provider = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The sourceProvider.

getSourceProviderBytes()

public ByteString getSourceProviderBytes()

Output only. Source provider is the author of a public blueprint, from which this blueprint is created.

string source_provider = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for sourceProvider.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp when the blueprint was updated.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when the blueprint was updated.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Blueprint creation time.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasRevisionCreateTime()

public boolean hasRevisionCreateTime()

Output only. The timestamp that the revision was created.

.google.protobuf.Timestamp revision_create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the revisionCreateTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp when the blueprint was updated.

.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Blueprint.Builder newBuilderForType()
Returns
TypeDescription
Blueprint.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Blueprint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Blueprint.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Blueprint.Builder toBuilder()
Returns
TypeDescription
Blueprint.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException