Class Deployment (0.14.0)

public final class Deployment extends GeneratedMessageV3 implements DeploymentOrBuilder

Deployment contains a collection of YAML files (This collection is also known as package) that can to applied on an orchestration cluster (GKE cluster with TNA addons) or a workload cluster.

Protobuf type google.cloud.telcoautomation.v1alpha1.Deployment

Implements

DeploymentOrBuilder

Static Fields

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_REVISION_FIELD_NUMBER

public static final int SOURCE_BLUEPRINT_REVISION_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_PROVIDER_FIELD_NUMBER

public static final int SOURCE_PROVIDER_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

WORKLOAD_CLUSTER_FIELD_NUMBER

public static final int WORKLOAD_CLUSTER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Deployment getDefaultInstance()
Returns
Type Description
Deployment

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Deployment.Builder newBuilder()
Returns
Type Description
Deployment.Builder

newBuilder(Deployment prototype)

public static Deployment.Builder newBuilder(Deployment prototype)
Parameter
Name Description
prototype Deployment
Returns
Type Description
Deployment.Builder

parseDelimitedFrom(InputStream input)

public static Deployment parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Deployment
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Deployment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Deployment
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Deployment parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Deployment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Deployment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Deployment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Deployment parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Deployment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Deployment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Deployment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Deployment parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Deployment
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Deployment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Deployment
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Deployment parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Deployment
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Deployment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Deployment
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Deployment parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Deployment
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Deployment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Deployment
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Deployment> parser()
Returns
Type Description
Parser<Deployment>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

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

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

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Deployment creation time.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Deployment creation time.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Deployment getDefaultInstanceForType()
Returns
Type Description
Deployment

getDeploymentLevel()

public DeploymentLevel getDeploymentLevel()

Output only. Attributes to where the deployment can inflict changes. The value can only be [SINGLE_DEPLOYMENT, MULTI_DEPLOYMENT].

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

Returns
Type Description
DeploymentLevel

The deploymentLevel.

getDeploymentLevelValue()

public int getDeploymentLevelValue()

Output only. Attributes to where the deployment can inflict changes. The value can only be [SINGLE_DEPLOYMENT, MULTI_DEPLOYMENT].

.google.cloud.telcoautomation.v1alpha1.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 Deployment.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Human readable name of a Deployment.

string display_name = 6 [(.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 deployment. When invoking UpdateDeployment API, only the modified files should be included in this. Files that are not included in the update of a deployment will not be changed.

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

Parameter
Name Description
index int
Returns
Type Description
File

getFilesCount()

public int getFilesCount()

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

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

Returns
Type Description
int

getFilesList()

public List<File> getFilesList()

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

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

Returns
Type Description
List<File>

getFilesOrBuilder(int index)

public FileOrBuilder getFilesOrBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
FileOrBuilder

getFilesOrBuilderList()

public List<? extends FileOrBuilder> getFilesOrBuilderList()

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

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

Returns
Type Description
List<? extends com.google.cloud.telcoautomation.v1alpha1.FileOrBuilder>

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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

map<string, string> labels = 9 [(.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 deployment resource by the user.

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

Returns
Type Description
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 deployment resource by the user.

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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

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

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

The name of the deployment.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the deployment.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Deployment> getParserForType()
Returns
Type Description
Parser<Deployment>
Overrides

getRepository()

public String getRepository()

Output only. Name of the repository where the deployment package files are stored.

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

Returns
Type Description
String

The repository.

getRepositoryBytes()

public ByteString getRepositoryBytes()

Output only. Name of the repository where the deployment package files are stored.

string repository = 7 [(.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 = 4 [(.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 = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getRevisionId()

public String getRevisionId()

Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever a change in deployment is applied.

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 deployment. A new revision is committed whenever a change in deployment is applied.

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 can be rolled back, exported from public blueprint.

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

getSourceBlueprintRevision()

public String getSourceBlueprintRevision()

Required. The blueprint revision from which this deployment was created.

string source_blueprint_revision = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The sourceBlueprintRevision.

getSourceBlueprintRevisionBytes()

public ByteString getSourceBlueprintRevisionBytes()

Required. The blueprint revision from which this deployment was created.

string source_blueprint_revision = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for sourceBlueprintRevision.

getSourceProvider()

public String getSourceProvider()

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

string source_provider = 12 [(.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 deployment is created.

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

Returns
Type Description
ByteString

The bytes for sourceProvider.

getState()

public Deployment.State getState()

Output only. State of the deployment (DRAFT, APPLIED, DELETING).

.google.cloud.telcoautomation.v1alpha1.Deployment.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Deployment.State

The state.

getStateValue()

public int getStateValue()

Output only. State of the deployment (DRAFT, APPLIED, DELETING).

.google.cloud.telcoautomation.v1alpha1.Deployment.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp when the deployment was updated.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when the deployment was updated.

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

Returns
Type Description
TimestampOrBuilder

getWorkloadCluster()

public String getWorkloadCluster()

Optional. Immutable. The WorkloadCluster on which to create the Deployment. This field should only be passed when the deployment_level of the source blueprint specifies deployments on workload clusters e.g. WORKLOAD_CLUSTER_DEPLOYMENT.

string workload_cluster = 13 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The workloadCluster.

getWorkloadClusterBytes()

public ByteString getWorkloadClusterBytes()

Optional. Immutable. The WorkloadCluster on which to create the Deployment. This field should only be passed when the deployment_level of the source blueprint specifies deployments on workload clusters e.g. WORKLOAD_CLUSTER_DEPLOYMENT.

string workload_cluster = 13 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for workloadCluster.

hasCreateTime()

public boolean hasCreateTime()

Output only. Deployment creation time.

.google.protobuf.Timestamp create_time = 10 [(.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 = 4 [(.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 deployment was updated.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Deployment.Builder newBuilderForType()
Returns
Type Description
Deployment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Deployment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Deployment.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Deployment.Builder toBuilder()
Returns
Type Description
Deployment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException