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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
APPROVAL_STATE_FIELD_NUMBER
public static final int APPROVAL_STATE_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
DEPLOYMENT_LEVEL_FIELD_NUMBER
public static final int DEPLOYMENT_LEVEL_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
FILES_FIELD_NUMBER
public static final int FILES_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
REPOSITORY_FIELD_NUMBER
public static final int REPOSITORY_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
REVISION_CREATE_TIME_FIELD_NUMBER
public static final int REVISION_CREATE_TIME_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
REVISION_ID_FIELD_NUMBER
public static final int REVISION_ID_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
ROLLBACK_SUPPORT_FIELD_NUMBER
public static final int ROLLBACK_SUPPORT_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
SOURCE_BLUEPRINT_FIELD_NUMBER
public static final int SOURCE_BLUEPRINT_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
SOURCE_PROVIDER_FIELD_NUMBER
public static final int SOURCE_PROVIDER_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Blueprint getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Blueprint.Builder newBuilder()
newBuilder(Blueprint prototype)
public static Blueprint.Builder newBuilder(Blueprint prototype)
public static Blueprint parseDelimitedFrom(InputStream input)
public static Blueprint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Blueprint parseFrom(byte[] data)
Parameter |
---|
Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Blueprint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Blueprint parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Blueprint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Blueprint parseFrom(CodedInputStream input)
public static Blueprint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Blueprint parseFrom(InputStream input)
public static Blueprint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Blueprint parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Blueprint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Blueprint> parser()
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 |
---|
Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
Parameter |
---|
Name | Description |
obj | Object
|
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];
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 |
---|
Type | Description |
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 |
---|
Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Blueprint creation time.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Blueprint getDefaultInstanceForType()
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];
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 |
---|
Type | Description |
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 |
---|
Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Optional. Human readable name of a Blueprint.
string display_name = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns |
---|
Type | Description |
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 |
---|
Name | Description |
index | int
|
Returns |
---|
Type | Description |
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 |
---|
Type | Description |
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];
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 |
---|
Name | Description |
index | int
|
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 |
---|
Type | Description |
List<? extends com.google.cloud.telcoautomation.v1.FileOrBuilder> | |
getLabels() (deprecated)
public Map<String,String> getLabels()
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 |
---|
Type | Description |
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];
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];
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 |
---|
Name | Description |
key | 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 |
---|
Type | Description |
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 |
---|
Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Blueprint> getParserForType()
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 |
---|
Type | Description |
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 |
---|
Type | Description |
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 |
---|
Type | Description |
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];
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 |
---|
Type | Description |
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 |
---|
Type | Description |
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 |
---|
Type | Description |
boolean | The rollbackSupport.
|
getSerializedSize()
public int getSerializedSize()
Returns |
---|
Type | Description |
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 |
---|
Type | Description |
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 |
---|
Type | Description |
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 |
---|
Type | Description |
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 |
---|
Type | Description |
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 |
---|
Type | Description |
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];
hasCreateTime()
public boolean hasCreateTime()
Output only. Blueprint creation time.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns |
---|
Type | Description |
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 |
---|
Type | Description |
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 |
---|
Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
Returns |
---|
Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter |
---|
Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Blueprint.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Blueprint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Blueprint.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides