Class DeliveryPipeline (1.7.0)

Stay organized with collections Save and categorize content based on your preferences.
public final class DeliveryPipeline extends GeneratedMessageV3 implements DeliveryPipelineOrBuilder

A DeliveryPipeline resource in the Google Cloud Deploy API. A DeliveryPipeline defines a pipeline through which a Skaffold configuration can progress.

Protobuf type google.cloud.deploy.v1.DeliveryPipeline

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

CONDITION_FIELD_NUMBER

public static final int CONDITION_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

ETAG_FIELD_NUMBER

public static final int ETAG_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

SERIAL_PIPELINE_FIELD_NUMBER

public static final int SERIAL_PIPELINE_FIELD_NUMBER
Field Value
TypeDescription
int

SUSPENDED_FIELD_NUMBER

public static final int SUSPENDED_FIELD_NUMBER
Field Value
TypeDescription
int

UID_FIELD_NUMBER

public static final int UID_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 DeliveryPipeline getDefaultInstance()
Returns
TypeDescription
DeliveryPipeline

getDescriptor()

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

newBuilder()

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

newBuilder(DeliveryPipeline prototype)

public static DeliveryPipeline.Builder newBuilder(DeliveryPipeline prototype)
Parameter
NameDescription
prototypeDeliveryPipeline
Returns
TypeDescription
DeliveryPipeline.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsAnnotations(String key)

public boolean containsAnnotations(String key)

User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy.

map<string, string> annotations = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsLabels(String key)

public boolean containsLabels(String key)

Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints:

  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
  • All characters must use UTF-8 encoding, and international characters are allowed.
  • Keys must start with a lowercase letter or international character.
  • Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

map<string, string> labels = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getAnnotations()

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
TypeDescription
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy.

map<string, string> annotations = 4;

Returns
TypeDescription
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy.

map<string, string> annotations = 4;

Returns
TypeDescription
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy.

map<string, string> annotations = 4;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy.

map<string, string> annotations = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getCondition()

public PipelineCondition getCondition()

Output only. Information around the state of the Delivery Pipeline.

.google.cloud.deploy.v1.PipelineCondition condition = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
PipelineCondition

The condition.

getConditionOrBuilder()

public PipelineConditionOrBuilder getConditionOrBuilder()

Output only. Information around the state of the Delivery Pipeline.

.google.cloud.deploy.v1.PipelineCondition condition = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
PipelineConditionOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Time at which the pipeline was created.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time at which the pipeline was created.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public DeliveryPipeline getDefaultInstanceForType()
Returns
TypeDescription
DeliveryPipeline

getDescription()

public String getDescription()

Description of the DeliveryPipeline. Max length is 255 characters.

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the DeliveryPipeline. Max length is 255 characters.

string description = 3;

Returns
TypeDescription
ByteString

The bytes for description.

getEtag()

public String getEtag()

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 10;

Returns
TypeDescription
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 10;

Returns
TypeDescription
ByteString

The bytes for etag.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints:

  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
  • All characters must use UTF-8 encoding, and international characters are allowed.
  • Keys must start with a lowercase letter or international character.
  • Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

map<string, string> labels = 5;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints:

  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
  • All characters must use UTF-8 encoding, and international characters are allowed.
  • Keys must start with a lowercase letter or international character.
  • Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

map<string, string> labels = 5;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints:

  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
  • All characters must use UTF-8 encoding, and international characters are allowed.
  • Keys must start with a lowercase letter or international character.
  • Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

map<string, string> labels = 5;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints:

  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes.
  • All characters must use UTF-8 encoding, and international characters are allowed.
  • Keys must start with a lowercase letter or international character.
  • Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.

map<string, string> labels = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getName()

public String getName()

Optional. Name of the DeliveryPipeline. Format is projects/{project}/ locations/{location}/deliveryPipelines/a-z{0,62}.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Optional. Name of the DeliveryPipeline. Format is projects/{project}/ locations/{location}/deliveryPipelines/a-z{0,62}.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getPipelineCase()

public DeliveryPipeline.PipelineCase getPipelineCase()
Returns
TypeDescription
DeliveryPipeline.PipelineCase

getSerialPipeline()

public SerialPipeline getSerialPipeline()

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

.google.cloud.deploy.v1.SerialPipeline serial_pipeline = 8;

Returns
TypeDescription
SerialPipeline

The serialPipeline.

getSerialPipelineOrBuilder()

public SerialPipelineOrBuilder getSerialPipelineOrBuilder()

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

.google.cloud.deploy.v1.SerialPipeline serial_pipeline = 8;

Returns
TypeDescription
SerialPipelineOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSuspended()

public boolean getSuspended()

When suspended, no new releases or rollouts can be created, but in-progress ones will complete.

bool suspended = 12;

Returns
TypeDescription
boolean

The suspended.

getUid()

public String getUid()

Output only. Unique identifier of the DeliveryPipeline.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. Unique identifier of the DeliveryPipeline.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for uid.

getUnknownFields()