public final class Pipeline extends GeneratedMessageV3 implements PipelineOrBuilder
A representation of the Pipeline resource.
Protobuf type google.cloud.eventarc.v1.Pipeline
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
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CRYPTO_KEY_NAME_FIELD_NUMBER
public static final int CRYPTO_KEY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESTINATIONS_FIELD_NUMBER
public static final int DESTINATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int INPUT_PAYLOAD_FORMAT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LOGGING_CONFIG_FIELD_NUMBER
public static final int LOGGING_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MEDIATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RETRY_POLICY_FIELD_NUMBER
public static final int RETRY_POLICY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UID_FIELD_NUMBER
public static final int UID_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 Pipeline getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Pipeline.Builder newBuilder()
newBuilder(Pipeline prototype)
public static Pipeline.Builder newBuilder(Pipeline prototype)
| Parameter |
| Name |
Description |
prototype |
Pipeline
|
public static Pipeline parseDelimitedFrom(InputStream input)
public static Pipeline parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Pipeline parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Pipeline parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Pipeline parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Pipeline parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Pipeline parseFrom(CodedInputStream input)
public static Pipeline parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Pipeline parseFrom(InputStream input)
public static Pipeline parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Pipeline parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Pipeline parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Pipeline> parser()
Methods
containsAnnotations(String key)
public boolean containsAnnotations(String key)
| Parameter |
| Name |
Description |
key |
String
|
containsLabels(String key)
public boolean containsLabels(String key)
Optional. User labels attached to the Pipeline that can be used to group
resources. An object containing a list of "key": value pairs. Example: {
"name": "wrench", "mass": "1.3kg", "count": "3" }.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAnnotations() (deprecated)
public Map<String,String> getAnnotations()
getAnnotationsCount()
public int getAnnotationsCount()
| Returns |
| Type |
Description |
int |
|
getAnnotationsMap()
public Map<String,String> getAnnotationsMap()
getAnnotationsOrDefault(String key, String defaultValue)
public String getAnnotationsOrDefault(String key, String defaultValue)
| Returns |
| Type |
Description |
String |
|
getAnnotationsOrThrow(String key)
public String getAnnotationsOrThrow(String key)
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getCreateTime()
public Timestamp getCreateTime()
Output only. The creation time.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up
to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and
"2014-10-02T15:01:23.045123456Z".
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The creation time.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up
to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and
"2014-10-02T15:01:23.045123456Z".
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCryptoKeyName()
public String getCryptoKeyName()
Optional. Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt the event data. If not set, an internal Google-owned key
will be used to encrypt messages. It must match the pattern
"projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}".
string crypto_key_name = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The cryptoKeyName.
|
getCryptoKeyNameBytes()
public ByteString getCryptoKeyNameBytes()
Optional. Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt the event data. If not set, an internal Google-owned key
will be used to encrypt messages. It must match the pattern
"projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}".
string crypto_key_name = 10 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for cryptoKeyName.
|
getDefaultInstanceForType()
public Pipeline getDefaultInstanceForType()
getDestinations(int index)
public Pipeline.Destination getDestinations(int index)
Required. List of destinations to which messages will be forwarded.
Currently, exactly one destination is supported per Pipeline.
repeated .google.cloud.eventarc.v1.Pipeline.Destination destinations = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
index |
int
|
getDestinationsCount()
public int getDestinationsCount()
Required. List of destinations to which messages will be forwarded.
Currently, exactly one destination is supported per Pipeline.
repeated .google.cloud.eventarc.v1.Pipeline.Destination destinations = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
int |
|
getDestinationsList()
public List<Pipeline.Destination> getDestinationsList()
Required. List of destinations to which messages will be forwarded.
Currently, exactly one destination is supported per Pipeline.
repeated .google.cloud.eventarc.v1.Pipeline.Destination destinations = 8 [(.google.api.field_behavior) = REQUIRED];
getDestinationsOrBuilder(int index)
public Pipeline.DestinationOrBuilder getDestinationsOrBuilder(int index)
Required. List of destinations to which messages will be forwarded.
Currently, exactly one destination is supported per Pipeline.
repeated .google.cloud.eventarc.v1.Pipeline.Destination destinations = 8 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
index |
int
|
getDestinationsOrBuilderList()
public List<? extends Pipeline.DestinationOrBuilder> getDestinationsOrBuilderList()
Required. List of destinations to which messages will be forwarded.
Currently, exactly one destination is supported per Pipeline.
repeated .google.cloud.eventarc.v1.Pipeline.Destination destinations = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.eventarc.v1.Pipeline.DestinationOrBuilder> |
|
getDisplayName()
public String getDisplayName()
Optional. Display name of resource.
string display_name = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Optional. Display name of resource.
string display_name = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getEtag()
Output only. This checksum is computed by the server based on the value of
other fields, and might be sent only on create requests to ensure that the
client has an up-to-date value before proceeding.
string etag = 99;
| Returns |
| Type |
Description |
String |
The etag.
|
getEtagBytes()
public ByteString getEtagBytes()
Output only. This checksum is computed by the server based on the value of
other fields, and might be sent only on create requests to ensure that the
client has an up-to-date value before proceeding.
string etag = 99;
| Returns |
| Type |
Description |
ByteString |
The bytes for etag.
|
public Pipeline.MessagePayloadFormat getInputPayloadFormat()
Optional. The payload format expected for the messages received by the
Pipeline. If input_payload_format is set then any messages not matching
this format will be treated as persistent errors. If input_payload_format
is not set, then the message data will be treated as an opaque binary and
no output format can be set on the Pipeline through the
Pipeline.Destination.output_payload_format field. Any Mediations on the
Pipeline that involve access to the data field will fail as persistent
errors.
.google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat input_payload_format = 11 [(.google.api.field_behavior) = OPTIONAL];
public Pipeline.MessagePayloadFormatOrBuilder getInputPayloadFormatOrBuilder()
Optional. The payload format expected for the messages received by the
Pipeline. If input_payload_format is set then any messages not matching
this format will be treated as persistent errors. If input_payload_format
is not set, then the message data will be treated as an opaque binary and
no output format can be set on the Pipeline through the
Pipeline.Destination.output_payload_format field. Any Mediations on the
Pipeline that involve access to the data field will fail as persistent
errors.
.google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat input_payload_format = 11 [(.google.api.field_behavior) = OPTIONAL];
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Optional. User labels attached to the Pipeline that can be used to group
resources. An object containing a list of "key": value pairs. Example: {
"name": "wrench", "mass": "1.3kg", "count": "3" }.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional. User labels attached to the Pipeline that can be used to group
resources. An object containing a list of "key": value pairs. Example: {
"name": "wrench", "mass": "1.3kg", "count": "3" }.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional. User labels attached to the Pipeline that can be used to group
resources. An object containing a list of "key": value pairs. Example: {
"name": "wrench", "mass": "1.3kg", "count": "3" }.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Optional. User labels attached to the Pipeline that can be used to group
resources. An object containing a list of "key": value pairs. Example: {
"name": "wrench", "mass": "1.3kg", "count": "3" }.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getLoggingConfig()
public LoggingConfig getLoggingConfig()
Optional. Config to control Platform Logging for Pipelines.
.google.cloud.eventarc.v1.LoggingConfig logging_config = 12 [(.google.api.field_behavior) = OPTIONAL];
getLoggingConfigOrBuilder()
public LoggingConfigOrBuilder getLoggingConfigOrBuilder()
Optional. Config to control Platform Logging for Pipelines.
.google.cloud.eventarc.v1.LoggingConfig logging_config = 12 [(.google.api.field_behavior) = OPTIONAL];
public Pipeline.Mediation getMediations(int index)
Optional. List of mediation operations to be performed on the message.
Currently, only one Transformation operation is allowed in each Pipeline.
repeated .google.cloud.eventarc.v1.Pipeline.Mediation mediations = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
public int getMediationsCount()
Optional. List of mediation operations to be performed on the message.
Currently, only one Transformation operation is allowed in each Pipeline.
repeated .google.cloud.eventarc.v1.Pipeline.Mediation mediations = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
public List<Pipeline.Mediation> getMediationsList()
Optional. List of mediation operations to be performed on the message.
Currently, only one Transformation operation is allowed in each Pipeline.
repeated .google.cloud.eventarc.v1.Pipeline.Mediation mediations = 9 [(.google.api.field_behavior) = OPTIONAL];
public Pipeline.MediationOrBuilder getMediationsOrBuilder(int index)
Optional. List of mediation operations to be performed on the message.
Currently, only one Transformation operation is allowed in each Pipeline.
repeated .google.cloud.eventarc.v1.Pipeline.Mediation mediations = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
public List<? extends Pipeline.MediationOrBuilder> getMediationsOrBuilderList()
Optional. List of mediation operations to be performed on the message.
Currently, only one Transformation operation is allowed in each Pipeline.
repeated .google.cloud.eventarc.v1.Pipeline.Mediation mediations = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.eventarc.v1.Pipeline.MediationOrBuilder> |
|
getName()
Identifier. The resource name of the Pipeline. Must be unique within the
location of the project and must be in
projects/{project}/locations/{location}/pipelines/{pipeline} format.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Identifier. The resource name of the Pipeline. Must be unique within the
location of the project and must be in
projects/{project}/locations/{location}/pipelines/{pipeline} format.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<Pipeline> getParserForType()
Overrides
getRetryPolicy()
public Pipeline.RetryPolicy getRetryPolicy()
Optional. The retry policy to use in the pipeline.
.google.cloud.eventarc.v1.Pipeline.RetryPolicy retry_policy = 13 [(.google.api.field_behavior) = OPTIONAL];
getRetryPolicyOrBuilder()
public Pipeline.RetryPolicyOrBuilder getRetryPolicyOrBuilder()
Optional. The retry policy to use in the pipeline.
.google.cloud.eventarc.v1.Pipeline.RetryPolicy retry_policy = 13 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getUid()
Output only. Server-assigned unique identifier for the Pipeline. The value
is a UUID4 string and guaranteed to remain unchanged until the resource is
deleted.
string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
| Returns |
| Type |
Description |
String |
The uid.
|
getUidBytes()
public ByteString getUidBytes()
Output only. Server-assigned unique identifier for the Pipeline. The value
is a UUID4 string and guaranteed to remain unchanged until the resource is
deleted.
string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for uid.
|
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The last-modified time.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up
to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and
"2014-10-02T15:01:23.045123456Z".
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The last-modified time.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up
to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and
"2014-10-02T15:01:23.045123456Z".
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. The creation time.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up
to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and
"2014-10-02T15:01:23.045123456Z".
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
public boolean hasInputPayloadFormat()
Optional. The payload format expected for the messages received by the
Pipeline. If input_payload_format is set then any messages not matching
this format will be treated as persistent errors. If input_payload_format
is not set, then the message data will be treated as an opaque binary and
no output format can be set on the Pipeline through the
Pipeline.Destination.output_payload_format field. Any Mediations on the
Pipeline that involve access to the data field will fail as persistent
errors.
.google.cloud.eventarc.v1.Pipeline.MessagePayloadFormat input_payload_format = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the inputPayloadFormat field is set.
|
hasLoggingConfig()
public boolean hasLoggingConfig()
Optional. Config to control Platform Logging for Pipelines.
.google.cloud.eventarc.v1.LoggingConfig logging_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the loggingConfig field is set.
|
hasRetryPolicy()
public boolean hasRetryPolicy()
Optional. The retry policy to use in the pipeline.
.google.cloud.eventarc.v1.Pipeline.RetryPolicy retry_policy = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the retryPolicy field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The last-modified time.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up
to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and
"2014-10-02T15:01:23.045123456Z".
.google.protobuf.Timestamp update_time = 3 [(.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
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()
Overrides
newBuilderForType()
public Pipeline.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Pipeline.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Pipeline.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
